blob: ae90041746808c63d68cc93637636f2e6949614c [file] [log] [blame]
Daniel Willmannca102af2014-08-08 12:14:12 +02001/* Copied from tbf.cpp
2 *
3 * Copyright (C) 2012 Ivan Klyuchnikov
4 * Copyright (C) 2012 Andreas Eversberg <jolly@eversberg.eu>
5 * Copyright (C) 2013 by Holger Hans Peter Freyther
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
Daniel Willmannca102af2014-08-08 12:14:12 +020016 */
17
18#include <bts.h>
19#include <tbf.h>
Pau Espin Pedrol9d1cdb12019-09-25 17:47:02 +020020#include <tbf_dl.h>
21#include <tbf_ul.h>
Daniel Willmannca102af2014-08-08 12:14:12 +020022#include <rlc.h>
23#include <gprs_rlcmac.h>
24#include <gprs_debug.h>
25#include <gprs_bssgp_pcu.h>
Jacob Erlbeckd4ad7312015-07-17 16:39:09 +020026#include <gprs_codel.h>
Daniel Willmannca102af2014-08-08 12:14:12 +020027#include <decoding.h>
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +010028#include <encoding.h>
Max1187a772018-01-26 13:31:42 +010029#include <gprs_ms.h>
30#include <gprs_ms_storage.h>
31#include <llc.h>
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +010032#include "pcu_utils.h"
33
Daniel Willmannca102af2014-08-08 12:14:12 +020034extern "C" {
35#include <osmocom/core/msgb.h>
36#include <osmocom/core/talloc.h>
Alexander Couzens95e37922016-05-21 22:33:27 +020037#include <osmocom/gprs/gprs_bssgp_bss.h>
Max1187a772018-01-26 13:31:42 +010038 #include <osmocom/core/bitvec.h>
39 #include <osmocom/core/linuxlist.h>
40 #include <osmocom/core/logging.h>
41 #include <osmocom/core/rate_ctr.h>
Pau Espin Pedrolb3859692020-10-23 22:37:52 +020042 #include <osmocom/core/stats.h>
Max1187a772018-01-26 13:31:42 +010043 #include <osmocom/core/timer.h>
44 #include <osmocom/core/utils.h>
45 #include <osmocom/gsm/gsm_utils.h>
46 #include <osmocom/gsm/protocol/gsm_04_08.h>
Max136ebcc2019-03-05 14:59:03 +010047 #include "coding_scheme.h"
Daniel Willmannca102af2014-08-08 12:14:12 +020048}
49
50#include <errno.h>
51#include <string.h>
52
53/* After sending these frames, we poll for ack/nack. */
54#define POLL_ACK_AFTER_FRAMES 20
55
Pau Espin Pedrolb3859692020-10-23 22:37:52 +020056extern void *tall_pcu_ctx;
57
58static const struct rate_ctr_desc tbf_dl_gprs_ctr_description[] = {
59 { "gprs:downlink:cs1", "CS1 " },
60 { "gprs:downlink:cs2", "CS2 " },
61 { "gprs:downlink:cs3", "CS3 " },
62 { "gprs:downlink:cs4", "CS4 " },
63};
64
65static const struct rate_ctr_desc tbf_dl_egprs_ctr_description[] = {
66 { "egprs:downlink:mcs1", "MCS1 " },
67 { "egprs:downlink:mcs2", "MCS2 " },
68 { "egprs:downlink:mcs3", "MCS3 " },
69 { "egprs:downlink:mcs4", "MCS4 " },
70 { "egprs:downlink:mcs5", "MCS5 " },
71 { "egprs:downlink:mcs6", "MCS6 " },
72 { "egprs:downlink:mcs7", "MCS7 " },
73 { "egprs:downlink:mcs8", "MCS8 " },
74 { "egprs:downlink:mcs9", "MCS9 " },
75};
76
77static const struct rate_ctr_group_desc tbf_dl_gprs_ctrg_desc = {
78 "tbf:gprs",
79 "Data Blocks",
80 OSMO_STATS_CLASS_SUBSCRIBER,
81 ARRAY_SIZE(tbf_dl_gprs_ctr_description),
82 tbf_dl_gprs_ctr_description,
83};
84
85static const struct rate_ctr_group_desc tbf_dl_egprs_ctrg_desc = {
86 "tbf:egprs",
87 "Data Blocks",
88 OSMO_STATS_CLASS_SUBSCRIBER,
89 ARRAY_SIZE(tbf_dl_egprs_ctr_description),
90 tbf_dl_egprs_ctr_description,
91};
92
Pau Espin Pedrol834cbab2020-10-23 22:17:01 +020093gprs_rlcmac_dl_tbf::BandWidth::BandWidth() :
94 dl_bw_octets(0),
95 dl_throughput(0),
96 dl_loss_lost(0),
97 dl_loss_received(0)
98{
99 timespecclear(&dl_bw_tv);
100 timespecclear(&dl_loss_tv);
101}
102
Pau Espin Pedrolb3859692020-10-23 22:37:52 +0200103static int dl_tbf_dtor(struct gprs_rlcmac_dl_tbf *tbf)
104{
105 tbf->~gprs_rlcmac_dl_tbf();
106 return 0;
107}
108
Pau Espin Pedrol29b9f942022-10-27 14:53:16 +0200109struct gprs_rlcmac_dl_tbf *dl_tbf_alloc(struct gprs_rlcmac_bts *bts, struct GprsMs *ms, int8_t use_trx, bool single_slot)
Pau Espin Pedrolb3859692020-10-23 22:37:52 +0200110{
111 struct gprs_rlcmac_dl_tbf *tbf;
112 int rc;
113
114 OSMO_ASSERT(ms != NULL);
115
Pau Espin Pedrol36177c62021-02-25 17:57:37 +0100116 LOGPMS(ms, DTBF, LOGL_DEBUG, "********** DL-TBF starts here **********\n");
117 LOGPMS(ms, DTBF, LOGL_INFO, "Allocating DL TBF\n");
Pau Espin Pedrolb3859692020-10-23 22:37:52 +0200118
119 tbf = talloc(tall_pcu_ctx, struct gprs_rlcmac_dl_tbf);
120
121 if (!tbf)
122 return NULL;
123
124 talloc_set_destructor(tbf, dl_tbf_dtor);
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100125 new (tbf) gprs_rlcmac_dl_tbf(bts, ms);
Pau Espin Pedrolb3859692020-10-23 22:37:52 +0200126
127 rc = tbf->setup(use_trx, single_slot);
128 /* if no resource */
129 if (rc < 0) {
130 talloc_free(tbf);
131 return NULL;
132 }
133
134 if (tbf->is_egprs_enabled()) {
135 tbf->set_window_size();
136 tbf->m_dl_egprs_ctrs = rate_ctr_group_alloc(tbf,
137 &tbf_dl_egprs_ctrg_desc,
138 tbf->m_ctrs->idx);
139 if (!tbf->m_dl_egprs_ctrs) {
140 LOGPTBF(tbf, LOGL_ERROR, "Couldn't allocate EGPRS DL counters\n");
141 talloc_free(tbf);
142 return NULL;
143 }
144 } else {
145 tbf->m_dl_gprs_ctrs = rate_ctr_group_alloc(tbf,
146 &tbf_dl_gprs_ctrg_desc,
147 tbf->m_ctrs->idx);
148 if (!tbf->m_dl_gprs_ctrs) {
149 LOGPTBF(tbf, LOGL_ERROR, "Couldn't allocate GPRS DL counters\n");
150 talloc_free(tbf);
151 return NULL;
152 }
153 }
154
Pau Espin Pedrol1a1557a2021-05-13 18:39:36 +0200155 llist_add(tbf_trx_list((struct gprs_rlcmac_tbf *)tbf), &tbf->trx->dl_tbfs);
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100156 bts_do_rate_ctr_inc(tbf->bts, CTR_TBF_DL_ALLOCATED);
Pau Espin Pedrolb3859692020-10-23 22:37:52 +0200157
Pau Espin Pedrolb3859692020-10-23 22:37:52 +0200158 osmo_clock_gettime(CLOCK_MONOTONIC, &tbf->m_bw.dl_bw_tv);
159 osmo_clock_gettime(CLOCK_MONOTONIC, &tbf->m_bw.dl_loss_tv);
160
161 return tbf;
162}
163
Pau Espin Pedrol62e06f92021-07-26 17:27:51 +0200164gprs_rlcmac_dl_tbf::~gprs_rlcmac_dl_tbf()
165{
Pau Espin Pedrol131deb02021-07-26 18:24:14 +0200166 if (is_egprs_enabled()) {
167 rate_ctr_group_free(m_dl_egprs_ctrs);
168 } else {
169 rate_ctr_group_free(m_dl_gprs_ctrs);
170 }
171 /* ~gprs_rlcmac_tbf() is called automatically upon return */
Pau Espin Pedrol62e06f92021-07-26 17:27:51 +0200172}
173
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100174gprs_rlcmac_dl_tbf::gprs_rlcmac_dl_tbf(struct gprs_rlcmac_bts *bts_, GprsMs *ms) :
Pau Espin Pedrole9f77d32020-10-23 18:41:40 +0200175 gprs_rlcmac_tbf(bts_, ms, GPRS_RLCMAC_DL_TBF),
Pau Espin Pedrolbddf1ad2019-09-26 14:41:18 +0200176 m_tx_counter(0),
Pau Espin Pedrolbddf1ad2019-09-26 14:41:18 +0200177 m_dl_ack_requested(false),
Pau Espin Pedrola89008b2021-03-02 13:07:05 +0100178 m_last_dl_poll_fn(-1),
179 m_last_dl_drained_fn(-1),
Pau Espin Pedrolbddf1ad2019-09-26 14:41:18 +0200180 m_dl_gprs_ctrs(NULL),
181 m_dl_egprs_ctrs(NULL)
182{
Pau Espin Pedrol343c0ee2022-11-17 19:55:08 +0100183 memset(&state_fsm, 0, sizeof(state_fsm));
184 state_fsm.tbf = (struct gprs_rlcmac_tbf *)this;
185 state_fi = osmo_fsm_inst_alloc(&tbf_dl_fsm, this, &state_fsm, LOGL_INFO, NULL);
186 OSMO_ASSERT(state_fi);
Daniel Willmannca102af2014-08-08 12:14:12 +0200187}
188
Daniel Willmannca102af2014-08-08 12:14:12 +0200189/**
190 * TODO: split into unit test-able parts...
191 */
Pau Espin Pedrol8a35e642021-01-18 17:14:14 +0100192int dl_tbf_handle(struct gprs_rlcmac_bts *bts,
193 const uint32_t tlli, const uint32_t tlli_old, const char *imsi,
194 uint8_t ms_class, uint8_t egprs_ms_class,
195 const uint16_t delay_csec,
196 const uint8_t *data, const uint16_t len)
Daniel Willmannca102af2014-08-08 12:14:12 +0200197{
Jacob Erlbeck409efa12015-06-12 14:06:09 +0200198 int rc;
Jacob Erlbeckac289052015-08-14 12:50:54 +0200199 GprsMs *ms, *ms_old;
Daniel Willmannca102af2014-08-08 12:14:12 +0200200
201 /* check for existing TBF */
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100202 ms = bts_ms_store(bts)->get_ms(tlli, tlli_old, imsi);
Jacob Erlbecka47aaa42016-01-07 16:47:34 +0100203
Pau Espin Pedrol5deac142021-11-12 18:01:50 +0100204 /* If we got MS by TLLI above let's see if we already have another MS
205 * object identified by IMSI and merge them */
206 if (ms && !ms_imsi_is_valid(ms) && imsi) {
Pau Espin Pedrol7f360e72022-10-21 14:30:36 +0200207 ms_old = bts_ms_store(bts)->get_ms(GSM_RESERVED_TMSI, GSM_RESERVED_TMSI, imsi);
Jacob Erlbeckac289052015-08-14 12:50:54 +0200208 if (ms_old && ms_old != ms) {
209 /* The TLLI has changed (RAU), so there are two MS
210 * objects for the same MS */
Max0524e382018-01-19 18:22:25 +0100211 LOGP(DTBF, LOGL_NOTICE,
212 "There is a new MS object for the same MS: (0x%08x, '%s') -> (0x%08x, '%s')\n",
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100213 ms_tlli(ms_old), ms_imsi(ms_old), ms_tlli(ms), ms_imsi(ms));
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100214 ms_merge_and_clear_ms(ms, ms_old);
Pau Espin Pedrol677bebb2022-10-31 13:56:33 +0100215 /* old_ms may no longer be available here */
Jacob Erlbeckac289052015-08-14 12:50:54 +0200216 }
217 }
218
Pau Espin Pedrol528820d2020-10-26 12:40:11 +0100219 if (!ms)
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100220 ms = bts_alloc_ms(bts, ms_class, egprs_ms_class);
Pau Espin Pedrol5deac142021-11-12 18:01:50 +0100221 if (imsi)
222 ms_set_imsi(ms, imsi);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100223 ms_confirm_tlli(ms, tlli);
224 if (!ms_ms_class(ms) && ms_class) {
225 ms_set_ms_class(ms, ms_class);
Pau Espin Pedrol758ace82020-10-28 19:58:17 +0100226 }
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100227 if (!ms_egprs_ms_class(ms) && egprs_ms_class) {
228 ms_set_egprs_ms_class(ms, egprs_ms_class);
Pau Espin Pedrol758ace82020-10-28 19:58:17 +0100229 }
Pau Espin Pedrol528820d2020-10-26 12:40:11 +0100230
Pau Espin Pedrol14beef62022-10-26 19:44:07 +0200231 rc = ms_append_llc_dl_data(ms, delay_csec, data, len);
232 if (rc < 0)
233 return rc;
Pau Espin Pedrol14beef62022-10-26 19:44:07 +0200234 return 0;
Daniel Willmannca102af2014-08-08 12:14:12 +0200235}
236
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100237bool gprs_rlcmac_dl_tbf::restart_bsn_cycle()
Daniel Willmannca102af2014-08-08 12:14:12 +0200238{
Jacob Erlbeck95340242015-03-19 13:22:07 +0100239 /* If V(S) == V(A) and finished state, we would have received
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100240 * acknowledgement of all transmitted block. In this case we would
241 * have transmitted the final block, and received ack from MS. But in
242 * this case we did not receive the final ack indication from MS. This
243 * should never happen if MS works correctly.
244 */
Jacob Erlbeck95340242015-03-19 13:22:07 +0100245 if (m_window.window_empty()) {
Max0524e382018-01-19 18:22:25 +0100246 LOGPTBFDL(this, LOGL_DEBUG, "MS acked all blocks\n");
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100247 return false;
Jacob Erlbeck95340242015-03-19 13:22:07 +0100248 }
249
250 /* cycle through all unacked blocks */
251 int resend = m_window.mark_for_resend();
252
253 /* At this point there should be at least one unacked block
254 * to be resent. If not, this is an software error. */
255 if (resend == 0) {
Max0524e382018-01-19 18:22:25 +0100256 LOGPTBFDL(this, LOGL_ERROR,
257 "FIXME: Software error: There are no unacknowledged blocks, but V(A) != V(S). PLEASE FIX!\n");
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100258 return false;
Jacob Erlbeck95340242015-03-19 13:22:07 +0100259 }
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100260
261 return true;
262}
263
264int gprs_rlcmac_dl_tbf::take_next_bsn(uint32_t fn,
Pau Espin Pedrol022f9e52020-11-16 18:49:39 +0100265 int previous_bsn, enum mcs_kind req_mcs_kind, bool *may_combine)
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100266{
267 int bsn;
Jacob Erlbeck64e7b832016-02-04 15:16:47 +0100268 int data_len2, force_data_len = -1;
Pau Espin Pedrolfc464932021-01-25 12:05:32 +0100269 enum CodingScheme tx_cs;
270
271 /* Scheduler may be fine with sending any kind of data, but if
272 the selected TBF is GPRS-only, then let's filter out EGPRS
273 here */
274 if (!is_egprs_enabled())
275 req_mcs_kind = GPRS;
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100276
Alexander Couzense46d8dc2019-09-10 15:34:49 +0200277 /* search for a nacked or resend marked bsn */
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100278 bsn = m_window.resend_needed();
279
280 if (previous_bsn >= 0) {
Pau Espin Pedrolfc464932021-01-25 12:05:32 +0100281 tx_cs = m_rlc.block(previous_bsn)->cs_current_trans;
282 if (!mcs_is_edge(tx_cs))
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100283 return -1;
Jacob Erlbeck64e7b832016-02-04 15:16:47 +0100284 force_data_len = m_rlc.block(previous_bsn)->len;
Pau Espin Pedrolfc464932021-01-25 12:05:32 +0100285 } else {
286 tx_cs = ms_current_cs_dl(ms(), req_mcs_kind);
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100287 }
288
289 if (bsn >= 0) {
Alexander Couzense46d8dc2019-09-10 15:34:49 +0200290 /* resend an unacked bsn or resend bsn. */
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100291 if (previous_bsn == bsn)
292 return -1;
293
294 if (previous_bsn >= 0 &&
295 m_window.mod_sns(bsn - previous_bsn) > RLC_EGPRS_MAX_BSN_DELTA)
296 return -1;
297
Aravind Sirsikarcf2152b2016-07-13 18:46:17 +0530298 if (is_egprs_enabled()) {
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530299 /* Table 8.1.1.2 and Table 8.1.1.1 of 44.060 */
Pau Espin Pedrolfc464932021-01-25 12:05:32 +0100300 m_rlc.block(bsn)->cs_current_trans = get_retx_mcs(m_rlc.block(bsn)->cs_init, tx_cs,
Pau Espin Pedrol97296b22021-01-14 13:08:02 +0100301 bts->pcu->vty.dl_arq_type == EGPRS_ARQ1);
Aravind Sirsikarcf2152b2016-07-13 18:46:17 +0530302
Max0524e382018-01-19 18:22:25 +0100303 LOGPTBFDL(this, LOGL_DEBUG,
Maxa0353542019-03-06 18:03:58 +0100304 "initial_cs_dl(%s) last_mcs(%s) demanded_mcs(%s) cs_trans(%s) arq_type(%d) bsn(%d)\n",
305 mcs_name(m_rlc.block(bsn)->cs_init),
306 mcs_name(m_rlc.block(bsn)->cs_last),
Pau Espin Pedrolfc464932021-01-25 12:05:32 +0100307 mcs_name(tx_cs),
Maxa0353542019-03-06 18:03:58 +0100308 mcs_name(m_rlc.block(bsn)->cs_current_trans),
Pau Espin Pedrol97296b22021-01-14 13:08:02 +0100309 the_pcu->vty.dl_arq_type, bsn);
Aravind Sirsikarcf2152b2016-07-13 18:46:17 +0530310
311 /* TODO: Need to remove this check when MCS-8 -> MCS-6
312 * transistion is handled.
313 * Refer commit be881c028fc4da00c4046ecd9296727975c206a3
314 */
Maxbea2edb2019-03-06 17:04:59 +0100315 if (m_rlc.block(bsn)->cs_init == MCS8)
Aravind Sirsikarcf2152b2016-07-13 18:46:17 +0530316 m_rlc.block(bsn)->cs_current_trans =
Maxbea2edb2019-03-06 17:04:59 +0100317 MCS8;
Alexander Couzense46d8dc2019-09-10 15:34:49 +0200318 } else {
319 /* gprs */
Aravind Sirsikarcf2152b2016-07-13 18:46:17 +0530320 m_rlc.block(bsn)->cs_current_trans =
321 m_rlc.block(bsn)->cs_last;
Alexander Couzense46d8dc2019-09-10 15:34:49 +0200322 }
Aravind Sirsikarcf2152b2016-07-13 18:46:17 +0530323
Jacob Erlbeck64e7b832016-02-04 15:16:47 +0100324 data_len2 = m_rlc.block(bsn)->len;
325 if (force_data_len > 0 && force_data_len != data_len2)
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100326 return -1;
Max0524e382018-01-19 18:22:25 +0100327 LOGPTBFDL(this, LOGL_DEBUG, "Resending BSN %d\n", bsn);
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100328 /* re-send block with negative aknowlegement */
329 m_window.m_v_b.mark_unacked(bsn);
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100330 bts_do_rate_ctr_inc(bts, CTR_RLC_RESENT);
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +0200331 } else if (state_is(TBF_ST_FINISHED)) {
Alexander Couzense46d8dc2019-09-10 15:34:49 +0200332 /* If the TBF is in finished, we already sent all packages at least once.
333 * If any packages could have been sent (because of unacked) it should have
334 * been catched up by the upper if(bsn >= 0) */
Max0524e382018-01-19 18:22:25 +0100335 LOGPTBFDL(this, LOGL_DEBUG,
336 "Restarting at BSN %d, because all blocks have been transmitted.\n",
337 m_window.v_a());
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100338 bts_do_rate_ctr_inc(bts, CTR_RLC_RESTARTED);
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100339 if (restart_bsn_cycle())
Pau Espin Pedrol022f9e52020-11-16 18:49:39 +0100340 return take_next_bsn(fn, previous_bsn, req_mcs_kind, may_combine);
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100341 } else if (dl_window_stalled()) {
Alexander Couzense46d8dc2019-09-10 15:34:49 +0200342 /* There are no more packages to send, but the window is stalled.
343 * Restart the bsn_cycle to resend all unacked messages */
Max0524e382018-01-19 18:22:25 +0100344 LOGPTBFDL(this, LOGL_NOTICE,
345 "Restarting at BSN %d, because the window is stalled.\n",
346 m_window.v_a());
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100347 bts_do_rate_ctr_inc(bts, CTR_RLC_STALLED);
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100348 if (restart_bsn_cycle())
Pau Espin Pedrol022f9e52020-11-16 18:49:39 +0100349 return take_next_bsn(fn, previous_bsn, req_mcs_kind, may_combine);
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100350 } else if (have_data()) {
Alexander Couzense46d8dc2019-09-10 15:34:49 +0200351 /* The window has space left, generate new bsn */
Max0524e382018-01-19 18:22:25 +0100352 LOGPTBFDL(this, LOGL_DEBUG,
Pau Espin Pedrol022f9e52020-11-16 18:49:39 +0100353 "Sending new block at BSN %d, CS=%s%s\n",
Pau Espin Pedrolfc464932021-01-25 12:05:32 +0100354 m_window.v_s(), mcs_name(tx_cs),
355 force_data_len != -1 ? " (forced)" : "");
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100356
Pau Espin Pedrolfc464932021-01-25 12:05:32 +0100357 bsn = create_new_bsn(fn, tx_cs);
Pau Espin Pedrol05f9f592021-01-14 12:56:58 +0100358 } else if (bts->pcu->vty.dl_tbf_preemptive_retransmission && !m_window.window_empty()) {
Alexander Couzense46d8dc2019-09-10 15:34:49 +0200359 /* The window contains unacked packages, but not acked.
360 * Mark unacked bsns as RESEND */
Max0524e382018-01-19 18:22:25 +0100361 LOGPTBFDL(this, LOGL_DEBUG,
362 "Restarting at BSN %d, because all blocks have been transmitted (FLOW).\n",
363 m_window.v_a());
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100364 bts_do_rate_ctr_inc(bts, CTR_RLC_RESTARTED);
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100365 if (restart_bsn_cycle())
Pau Espin Pedrol022f9e52020-11-16 18:49:39 +0100366 return take_next_bsn(fn, previous_bsn, req_mcs_kind, may_combine);
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100367 } else {
368 /* Nothing left to send, create dummy LLC commands */
Max0524e382018-01-19 18:22:25 +0100369 LOGPTBFDL(this, LOGL_DEBUG,
370 "Sending new dummy block at BSN %d, CS=%s\n",
Pau Espin Pedrolfc464932021-01-25 12:05:32 +0100371 m_window.v_s(), mcs_name(tx_cs));
372 bsn = create_new_bsn(fn, tx_cs);
Aravind Sirsikarcf2152b2016-07-13 18:46:17 +0530373 /* Don't send a second block, so don't set cs_current_trans */
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100374 }
375
376 if (bsn < 0) {
377 /* we just send final block again */
Max0524e382018-01-19 18:22:25 +0100378 LOGPTBFDL(this, LOGL_DEBUG,
379 "Nothing else to send, Re-transmit final block!\n");
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100380 bsn = m_window.v_s_mod(-1);
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100381 bts_do_rate_ctr_inc(bts, CTR_RLC_FINAL_BLOCK_RESENT);
382 bts_do_rate_ctr_inc(bts, CTR_RLC_RESENT);
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100383 }
384
Pau Espin Pedrol2ae83372020-05-18 11:35:35 +0200385 *may_combine = num_data_blocks(mcs_header_type(m_rlc.block(bsn)->cs_current_trans)) > 1;
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100386
387 return bsn;
388}
389
390/*
391 * Create DL data block
392 * The messages are fragmented and forwarded as data blocks.
393 */
Pau Espin Pedrol022f9e52020-11-16 18:49:39 +0100394struct msgb *gprs_rlcmac_dl_tbf::create_dl_acked_block(uint32_t fn, uint8_t ts, enum mcs_kind req_mcs_kind)
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100395{
396 int bsn, bsn2 = -1;
Jacob Erlbeck64e7b832016-02-04 15:16:47 +0100397 bool may_combine;
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100398
Pau Espin Pedrol022f9e52020-11-16 18:49:39 +0100399 LOGPTBFDL(this, LOGL_DEBUG, "downlink (V(A)==%d .. V(S)==%d) mcs_mode_restrict=%s\n",
400 m_window.v_a(), m_window.v_s(), mode_name(req_mcs_kind));
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100401
Pau Espin Pedrol022f9e52020-11-16 18:49:39 +0100402 bsn = take_next_bsn(fn, -1, req_mcs_kind, &may_combine);
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100403 if (bsn < 0)
404 return NULL;
405
Jacob Erlbeck64e7b832016-02-04 15:16:47 +0100406 if (may_combine)
Pau Espin Pedrol022f9e52020-11-16 18:49:39 +0100407 bsn2 = take_next_bsn(fn, bsn, req_mcs_kind, &may_combine);
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100408
409 return create_dl_acked_block(fn, ts, bsn, bsn2);
Daniel Willmannca102af2014-08-08 12:14:12 +0200410}
411
Pau Espin Pedrolee350082022-10-28 17:35:03 +0200412/* old_tbf (UL TBF or DL TBF) will send a Pkt Dl Ass on PACCH to assign tbf.
413 * Note: It is possible that "tbf == old_tbf" if the TBF is being updated. This can
414 * happen when we first assign over PCH (only single slot is possible) and we want
415 * to upgrade the DL-TBF to be multislot. See code calling tbf_update() for more
416 * information.
417 */
418void dl_tbf_trigger_ass_on_pacch(struct gprs_rlcmac_dl_tbf *tbf, struct gprs_rlcmac_tbf *old_tbf)
419{
420 OSMO_ASSERT(tbf);
421 OSMO_ASSERT(old_tbf);
422 /* stop pending timer */
423 tbf_stop_timers(tbf, "DL assignment (PACCH)");
424
425 LOGPTBFDL(tbf, LOGL_DEBUG, "Send downlink assignment on PACCH, because %s exists\n", old_tbf->name());
426 osmo_fsm_inst_dispatch(old_tbf->dl_ass_fsm.fi, TBF_DL_ASS_EV_SCHED_ASS, NULL);
427
428 /* change state */
Pau Espin Pedrolf197f152022-11-17 20:18:46 +0100429 osmo_fsm_inst_dispatch(tbf->state_fi, TBF_EV_ASSIGN_ADD_PACCH, NULL);
Pau Espin Pedrolee350082022-10-28 17:35:03 +0200430
431}
432
433void dl_tbf_trigger_ass_on_pch(struct gprs_rlcmac_dl_tbf *tbf)
Maxa10c3982017-07-07 18:25:41 +0200434{
435 /* stop pending timer */
Pau Espin Pedrolee350082022-10-28 17:35:03 +0200436 struct GprsMs *ms = tbf_ms(tbf);
Maxa10c3982017-07-07 18:25:41 +0200437
Pau Espin Pedrolee350082022-10-28 17:35:03 +0200438 tbf_stop_timers(tbf, "DL assignment (PCH)");
Maxa10c3982017-07-07 18:25:41 +0200439
Pau Espin Pedrolee350082022-10-28 17:35:03 +0200440 LOGPTBFDL(tbf, LOGL_DEBUG, "Send downlink assignment on PCH, no TBF exist (IMSI=%s)\n", ms_imsi(ms));
Maxa10c3982017-07-07 18:25:41 +0200441
Pau Espin Pedrolee350082022-10-28 17:35:03 +0200442 /* change state */
Pau Espin Pedrolf197f152022-11-17 20:18:46 +0100443 osmo_fsm_inst_dispatch(tbf->state_fi, TBF_EV_ASSIGN_ADD_CCCH, NULL);
Maxa10c3982017-07-07 18:25:41 +0200444
Pau Espin Pedrolee350082022-10-28 17:35:03 +0200445 /* send immediate assignment */
446 bts_snd_dl_ass(ms->bts, tbf);
Maxa10c3982017-07-07 18:25:41 +0200447}
448
Jacob Erlbeck409efa12015-06-12 14:06:09 +0200449void gprs_rlcmac_dl_tbf::schedule_next_frame()
450{
451 struct msgb *msg;
452
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100453 if (llc_frame_length(&m_llc) != 0)
Jacob Erlbeck409efa12015-06-12 14:06:09 +0200454 return;
455
456 /* dequeue next LLC frame, if any */
Pau Espin Pedrol6b1e9512022-04-04 13:45:56 +0200457 msg = llc_queue_dequeue(llc_queue());
Jacob Erlbeck409efa12015-06-12 14:06:09 +0200458 if (!msg)
459 return;
460
Max0fdaa9d2018-01-30 16:03:10 +0100461 LOGPTBFDL(this, LOGL_DEBUG, "Dequeue next LLC (len=%d)\n", msg->len);
Jacob Erlbeck409efa12015-06-12 14:06:09 +0200462
Pau Espin Pedrol4f8384b2022-03-31 19:36:12 +0200463 llc_put_frame(&m_llc, msg->data, msg->len);
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100464 bts_do_rate_ctr_inc(bts, CTR_LLC_FRAME_SCHED);
Jacob Erlbeck409efa12015-06-12 14:06:09 +0200465 msgb_free(msg);
466 m_last_dl_drained_fn = -1;
467}
468
Pau Espin Pedrol2ae83372020-05-18 11:35:35 +0200469int gprs_rlcmac_dl_tbf::create_new_bsn(const uint32_t fn, enum CodingScheme cs)
Daniel Willmannca102af2014-08-08 12:14:12 +0200470{
Jacob Erlbeckfec94d12016-01-12 17:02:49 +0100471 uint8_t *data;
Daniel Willmannca102af2014-08-08 12:14:12 +0200472 gprs_rlc_data *rlc_data;
Daniel Willmannca102af2014-08-08 12:14:12 +0200473 const uint16_t bsn = m_window.v_s();
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100474 gprs_rlc_data_block_info *rdbi;
Jacob Erlbeckfec94d12016-01-12 17:02:49 +0100475 int num_chunks = 0;
476 int write_offset = 0;
477 Encoding::AppendResult ar;
Daniel Willmannca102af2014-08-08 12:14:12 +0200478
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100479 if (llc_frame_length(&m_llc) == 0)
Jacob Erlbeck409efa12015-06-12 14:06:09 +0200480 schedule_next_frame();
481
Pau Espin Pedrol2ae83372020-05-18 11:35:35 +0200482 OSMO_ASSERT(mcs_is_valid(cs));
Jacob Erlbecka700dd92015-06-02 16:00:41 +0200483
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100484 /* length of usable data block (single data unit w/o header) */
Pau Espin Pedrol2ae83372020-05-18 11:35:35 +0200485 const uint8_t block_data_len = mcs_max_data_block_bytes(cs);
Daniel Willmannca102af2014-08-08 12:14:12 +0200486
487 /* now we still have untransmitted LLC data, so we fill mac block */
488 rlc_data = m_rlc.block(bsn);
Pau Espin Pedrol5bb87b82020-05-18 11:02:39 +0200489 data = prepare(rlc_data, block_data_len);
Aravind Sirsikar91495522016-07-12 14:17:12 +0530490 rlc_data->cs_last = cs;
Aravind Sirsikarcf2152b2016-07-13 18:46:17 +0530491 rlc_data->cs_current_trans = cs;
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530492
493 /* Initialise the variable related to DL SPB */
494 rlc_data->spb_status.block_status_dl = EGPRS_RESEG_DL_DEFAULT;
495 rlc_data->cs_init = cs;
496
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100497 rlc_data->len = block_data_len;
Daniel Willmannca102af2014-08-08 12:14:12 +0200498
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100499 rdbi = &(rlc_data->block_info);
500 memset(rdbi, 0, sizeof(*rdbi));
501 rdbi->data_len = block_data_len;
502
503 rdbi->cv = 15; /* Final Block Indicator, set late, if true */
504 rdbi->bsn = bsn; /* Block Sequence Number */
505 rdbi->e = 1; /* Extension bit, maybe set later (1: no extension) */
506
Jacob Erlbeckfec94d12016-01-12 17:02:49 +0100507 do {
508 bool is_final;
Alexander Couzens7fdbf892016-05-21 19:45:23 +0200509 int payload_written = 0;
Jacob Erlbeckfec94d12016-01-12 17:02:49 +0100510
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100511 if (llc_frame_length(&m_llc) == 0) {
Pau Espin Pedrol8afc6ba2021-03-02 13:19:39 +0100512 /* The data just drained, store the current fn */
513 if (m_last_dl_drained_fn < 0)
514 m_last_dl_drained_fn = fn;
515
Pau Espin Pedrol7d0f9a02020-11-27 14:51:27 +0100516 /* It is not clear, when the next real data will
517 * arrive, so request a DL ack/nack now */
518 request_dl_ack();
Alexander Couzens1a506612016-05-24 16:55:30 +0200519
Jacob Erlbeckfec94d12016-01-12 17:02:49 +0100520 int space = block_data_len - write_offset;
Pau Espin Pedrol7d0f9a02020-11-27 14:51:27 +0100521
522 if (num_chunks != 0) {
523 /* Nothing to send, and we already put some data in
524 * rlcmac data block, we are done */
525 LOGPTBFDL(this, LOGL_DEBUG,
526 "LLC queue completely drained and there's "
527 "still %d free bytes in rlcmac data block\n", space);
Pau Espin Pedrolcf6c7122021-03-02 14:15:17 +0100528
529 /* We may need to update fbi in header here
530 * since m_last_dl_drained_fn was updated above
531 * Specially important when X2031 is 0. */
532 is_final = llc_queue_size(llc_queue()) == 0 && !keep_open(fn);
533 if (is_final) {
534 rdbi->cv = 0;
Pau Espin Pedrolf197f152022-11-17 20:18:46 +0100535 osmo_fsm_inst_dispatch(this->state_fi, TBF_EV_LAST_DL_DATA_SENT, NULL);
Pau Espin Pedrolcf6c7122021-03-02 14:15:17 +0100536 }
537
Pau Espin Pedrol7d0f9a02020-11-27 14:51:27 +0100538 if (mcs_is_edge(cs)) {
539 /* in EGPRS there's no M bit, so we need
540 * to flag padding with LI=127 */
541 Encoding::rlc_data_to_dl_append_egprs_li_padding(rdbi,
542 &write_offset,
543 &num_chunks,
544 data);
545 }
546 break;
547 }
548
549 /* Nothing to send from upper layers (LLC), but still
550 * requested to send something to MS to delay the
551 * release of the TBF. See 3GPP TS 44.060 9.3.1a
552 * "Delayed release of downlink Temporary Block Flow" */
Jacob Erlbeckcbb1e702015-03-25 12:21:55 +0100553 /* A header will need to by added, so we just need
554 * space-1 octets */
Pau Espin Pedrol4f8384b2022-03-31 19:36:12 +0200555 llc_put_dummy_frame(&m_llc, space - 1);
Jacob Erlbeckcbb1e702015-03-25 12:21:55 +0100556
Max0524e382018-01-19 18:22:25 +0100557 LOGPTBFDL(this, LOGL_DEBUG,
558 "Empty chunk, added LLC dummy command of size %d, drained_since=%d\n",
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100559 llc_frame_length(&m_llc), frames_since_last_drain(fn));
Jacob Erlbeckcbb1e702015-03-25 12:21:55 +0100560 }
561
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100562 is_final = llc_queue_size(llc_queue()) == 0 && !keep_open(fn);
Jacob Erlbeckcbb1e702015-03-25 12:21:55 +0100563
Jacob Erlbeck5058bd62016-01-13 10:51:25 +0100564 ar = Encoding::rlc_data_to_dl_append(rdbi, cs,
Alexander Couzens7fdbf892016-05-21 19:45:23 +0200565 &m_llc, &write_offset, &num_chunks, data, is_final, &payload_written);
566
567 if (payload_written > 0)
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100568 bts_do_rate_ctr_add(bts, CTR_RLC_DL_PAYLOAD_BYTES, payload_written);
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100569
Jacob Erlbeckfec94d12016-01-12 17:02:49 +0100570 if (ar == Encoding::AR_NEED_MORE_BLOCKS)
571 break;
572
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100573 LOGPTBFDL(this, LOGL_DEBUG, "Complete DL frame, len=%d\n", llc_frame_length(&m_llc));
574 gprs_rlcmac_dl_bw(this, llc_frame_length(&m_llc));
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100575 bts_do_rate_ctr_add(bts, CTR_LLC_DL_BYTES, llc_frame_length(&m_llc));
Pau Espin Pedrol4f8384b2022-03-31 19:36:12 +0200576 llc_reset(&m_llc);
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100577
Jacob Erlbeckfec94d12016-01-12 17:02:49 +0100578 if (is_final) {
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100579 request_dl_ack();
Pau Espin Pedrolf197f152022-11-17 20:18:46 +0100580 osmo_fsm_inst_dispatch(this->state_fi, TBF_EV_LAST_DL_DATA_SENT, NULL);
Daniel Willmannca102af2014-08-08 12:14:12 +0200581 }
Jacob Erlbeckfec94d12016-01-12 17:02:49 +0100582
583 /* dequeue next LLC frame, if any */
584 schedule_next_frame();
585 } while (ar == Encoding::AR_COMPLETED_SPACE_LEFT);
586
Max0524e382018-01-19 18:22:25 +0100587 LOGPTBFDL(this, LOGL_DEBUG, "data block (BSN %d, %s): %s\n",
Max136ebcc2019-03-05 14:59:03 +0100588 bsn, mcs_name(rlc_data->cs_last),
Max0524e382018-01-19 18:22:25 +0100589 osmo_hexdump(rlc_data->block, block_data_len));
Daniel Willmannca102af2014-08-08 12:14:12 +0200590 /* raise send state and set ack state array */
591 m_window.m_v_b.mark_unacked(bsn);
592 m_window.increment_send();
593
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100594 return bsn;
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100595}
596
Daniel Willmannca102af2014-08-08 12:14:12 +0200597struct msgb *gprs_rlcmac_dl_tbf::create_dl_acked_block(
598 const uint32_t fn, const uint8_t ts,
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100599 int index, int index2)
Daniel Willmannca102af2014-08-08 12:14:12 +0200600{
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100601 uint8_t *msg_data;
Daniel Willmannca102af2014-08-08 12:14:12 +0200602 struct msgb *dl_msg;
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100603 unsigned msg_len;
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100604 /* TODO: support MCS-7 - MCS-9, where data_block_idx can be 1 */
Maxb3a17d62017-12-21 12:11:33 +0100605 uint8_t data_block_idx = 0;
Jacob Erlbeckf2694b72016-01-26 21:46:26 +0100606 unsigned int rrbp;
607 uint32_t new_poll_fn;
608 int rc;
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100609 bool is_final = false;
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100610 gprs_rlc_data_info rlc;
Pau Espin Pedrol2ae83372020-05-18 11:35:35 +0200611 enum CodingScheme cs;
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100612 int bsns[ARRAY_SIZE(rlc.block_info)];
613 unsigned num_bsns;
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100614 bool need_padding = false;
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530615 enum egprs_rlcmac_dl_spb spb = EGPRS_RLCMAC_DL_NO_RETX;
616 unsigned int spb_status = get_egprs_dl_spb_status(index);
Neels Hofmeyrb6091902017-02-08 16:49:20 +0100617
618 enum egprs_puncturing_values punct[2] = {
619 EGPRS_PS_INVALID, EGPRS_PS_INVALID
620 };
621 osmo_static_assert(ARRAY_SIZE(rlc.block_info) == 2,
622 rlc_block_info_size_is_two);
623
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100624 /*
625 * TODO: This is an experimental work-around to put 2 BSN into
626 * MSC-7 to MCS-9 encoded messages. It just sends the same BSN
627 * twice in the block. The cs should be derived from the TBF's
628 * current CS such that both BSNs (that must be compatible) can
629 * be put into the data area, even if the resulting CS is higher than
630 * the current limit.
631 */
Aravind Sirsikarcf2152b2016-07-13 18:46:17 +0530632 cs = m_rlc.block(index)->cs_current_trans;
Maxd4a39292019-03-13 18:44:20 +0100633 enum CodingScheme cs_init = m_rlc.block(index)->cs_init;
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100634 bsns[0] = index;
635 num_bsns = 1;
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100636
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100637 if (index2 >= 0) {
638 bsns[num_bsns] = index2;
639 num_bsns += 1;
640 }
641
Mrinal Mishraf86307e2016-11-10 18:16:30 +0530642 update_coding_scheme_counter_dl(cs);
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530643 /*
644 * if the intial mcs is 8 and retransmission mcs is either 6 or 3
645 * we have to include the padding of 6 octets in first segment
646 */
Maxd4a39292019-03-13 18:44:20 +0100647 if ((cs_init == MCS8) &&
648 (cs == MCS6 || cs == MCS3)) {
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530649 if (spb_status == EGPRS_RESEG_DL_DEFAULT ||
Maxd4a39292019-03-13 18:44:20 +0100650 spb_status == EGPRS_RESEG_SECOND_SEG_SENT)
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530651 need_padding = true;
652 } else if (num_bsns == 1) {
Jacob Erlbeckbe881c02016-02-03 20:44:46 +0100653 /* TODO: remove the conditional when MCS-6 padding isn't
654 * failing to be decoded by MEs anymore */
Aravind Sirsikarcf2152b2016-07-13 18:46:17 +0530655 /* TODO: support of MCS-8 -> MCS-6 transition should be
656 * handled
657 * Refer commit be881c028fc4da00c4046ecd9296727975c206a3
658 * dated 2016-02-07 23:45:40 (UTC)
659 */
Pau Espin Pedrol2ae83372020-05-18 11:35:35 +0200660 if (cs != MCS8)
661 mcs_dec_to_single_block(&cs, &need_padding);
Jacob Erlbeckbe881c02016-02-03 20:44:46 +0100662 }
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100663
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530664 spb = get_egprs_dl_spb(index);
665
Max0524e382018-01-19 18:22:25 +0100666 LOGPTBFDL(this, LOGL_DEBUG, "need_padding %d spb_status %d spb %d (BSN1 %d BSN2 %d)\n",
667 need_padding, spb_status, spb, index, index2);
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530668
669 gprs_rlc_data_info_init_dl(&rlc, cs, need_padding, spb);
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100670
671 rlc.usf = 7; /* will be set at scheduler */
672 rlc.pr = 0; /* FIXME: power reduction */
673 rlc.tfi = m_tfi; /* TFI */
674
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100675 /* return data block(s) as message */
Pau Espin Pedrol2ae83372020-05-18 11:35:35 +0200676 msg_len = mcs_size_dl(cs);
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100677 dl_msg = msgb_alloc(msg_len, "rlcmac_dl_data");
678 if (!dl_msg)
679 return NULL;
680
681 msg_data = msgb_put(dl_msg, msg_len);
682
Aravind Sirsikarb1191982016-08-26 18:13:10 +0530683 OSMO_ASSERT(rlc.num_data_blocks <= ARRAY_SIZE(rlc.block_info));
684 OSMO_ASSERT(rlc.num_data_blocks > 0);
685
Max0524e382018-01-19 18:22:25 +0100686 LOGPTBFDL(this, LOGL_DEBUG, "Copying %u RLC blocks, %u BSNs\n", rlc.num_data_blocks, num_bsns);
Max5759a192017-09-08 12:23:12 +0200687
Maxb3a17d62017-12-21 12:11:33 +0100688 /* Copy block(s) to RLC message: the num_data_blocks cannot be more than 2 - see assert above */
689 for (data_block_idx = 0; data_block_idx < OSMO_MIN(rlc.num_data_blocks, 2);
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100690 data_block_idx++)
691 {
692 int bsn;
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100693 uint8_t *block_data;
694 gprs_rlc_data_block_info *rdbi, *block_info;
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530695 enum egprs_rlc_dl_reseg_bsn_state reseg_status;
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100696
697 /* Check if there are more blocks than BSNs */
698 if (data_block_idx < num_bsns)
699 bsn = bsns[data_block_idx];
700 else
701 bsn = bsns[0];
702
Aravind Sirsikar79522822016-03-23 18:29:47 +0530703 /* Get current puncturing scheme from block */
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530704
705 m_rlc.block(bsn)->next_ps = gprs_get_punct_scheme(
Aravind Sirsikar79522822016-03-23 18:29:47 +0530706 m_rlc.block(bsn)->next_ps,
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530707 m_rlc.block(bsn)->cs_last, cs, spb);
Aravind Sirsikar79522822016-03-23 18:29:47 +0530708
Max8a8e0fb2019-03-25 16:32:50 +0100709 if (mcs_is_edge(cs)) {
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530710 OSMO_ASSERT(m_rlc.block(bsn)->next_ps >= EGPRS_PS_1);
711 OSMO_ASSERT(m_rlc.block(bsn)->next_ps <= EGPRS_PS_3);
Aravind Sirsikar79522822016-03-23 18:29:47 +0530712 }
Maxb3a17d62017-12-21 12:11:33 +0100713
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530714 punct[data_block_idx] = m_rlc.block(bsn)->next_ps;
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100715
716 rdbi = &rlc.block_info[data_block_idx];
717 block_info = &m_rlc.block(bsn)->block_info;
718
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530719 /*
720 * get data and header from current block
721 * function returns the reseg status
Aravind Sirsikar79522822016-03-23 18:29:47 +0530722 */
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530723 reseg_status = egprs_dl_get_data(bsn, &block_data);
724 m_rlc.block(bsn)->spb_status.block_status_dl = reseg_status;
725
726 /*
727 * If it is first segment of the split block set the state of
728 * bsn to nacked. If it is the first segment dont update the
729 * next ps value of bsn. since next segment also needs same cps
730 */
731 if (spb == EGPRS_RLCMAC_DL_FIRST_SEG)
732 m_window.m_v_b.mark_nacked(bsn);
733 else {
734 /*
735 * TODO: Need to handle 2 same bsns
736 * in header type 1
737 */
738 gprs_update_punct_scheme(&m_rlc.block(bsn)->next_ps,
739 cs);
740 }
Aravind Sirsikar79522822016-03-23 18:29:47 +0530741
Aravind Sirsikarcf2152b2016-07-13 18:46:17 +0530742 m_rlc.block(bsn)->cs_last = cs;
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100743 rdbi->e = block_info->e;
744 rdbi->cv = block_info->cv;
745 rdbi->bsn = bsn;
746 is_final = is_final || rdbi->cv == 0;
747
Max0524e382018-01-19 18:22:25 +0100748 LOGPTBFDL(this, LOGL_DEBUG, "Copying data unit %d (BSN %d)\n",
749 data_block_idx, bsn);
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100750
751 Encoding::rlc_copy_from_aligned_buffer(&rlc, data_block_idx,
752 msg_data, block_data);
753 }
754
Neels Hofmeyr49b83ec2017-02-08 15:47:19 +0100755 /* Calculate CPS only for EGPRS case */
Max8a8e0fb2019-03-25 16:32:50 +0100756 if (mcs_is_edge(cs))
Neels Hofmeyr49b83ec2017-02-08 15:47:19 +0100757 rlc.cps = gprs_rlc_mcs_cps(cs, punct[0], punct[1], need_padding);
Daniel Willmannca102af2014-08-08 12:14:12 +0200758
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +0100759 /* If the TBF has just started, relate frames_since_last_poll to the
760 * current fn */
761 if (m_last_dl_poll_fn < 0)
762 m_last_dl_poll_fn = fn;
763
Pau Espin Pedrol405d2d12021-07-29 18:14:07 +0200764 /* poll after POLL_ACK_AFTER_FRAMES frames, or when final block is tx or
765 * when last polled DL ACK/NACK was lost. */
766 if (need_poll_for_dl_ack_nack()) {
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100767 if (m_dl_ack_requested) {
Max0524e382018-01-19 18:22:25 +0100768 LOGPTBFDL(this, LOGL_DEBUG,
Pau Espin Pedrol30f66172019-12-04 18:07:49 +0100769 "Scheduling Ack/Nack polling, because it was requested explicitly "
Max0524e382018-01-19 18:22:25 +0100770 "(e.g. first final block sent).\n");
Pau Espin Pedrol405d2d12021-07-29 18:14:07 +0200771 } else if (state_fsm.state_flags & (1 << GPRS_RLCMAC_FLAG_TO_DL_ACK)) {
Max0524e382018-01-19 18:22:25 +0100772 LOGPTBFDL(this, LOGL_DEBUG,
773 "Scheduling Ack/Nack polling, because polling timed out.\n");
Daniel Willmannca102af2014-08-08 12:14:12 +0200774 } else {
Max0524e382018-01-19 18:22:25 +0100775 LOGPTBFDL(this, LOGL_DEBUG,
776 "Scheduling Ack/Nack polling, because %d blocks sent.\n",
Pau Espin Pedrol405d2d12021-07-29 18:14:07 +0200777 POLL_ACK_AFTER_FRAMES);
Daniel Willmannca102af2014-08-08 12:14:12 +0200778 }
Jacob Erlbeckf2694b72016-01-26 21:46:26 +0100779
780 rc = check_polling(fn, ts, &new_poll_fn, &rrbp);
781 if (rc >= 0) {
Pau Espin Pedrol86580e12021-03-29 18:15:30 +0200782 set_polling(new_poll_fn, ts, PDCH_ULC_POLL_DL_ACK);
Pau Espin Pedrola161bf42021-07-30 13:42:06 +0200783 LOGPTBFDL(this, LOGL_DEBUG,
784 "Scheduled DL Acknowledgement polling on PACCH (FN=%d, TS=%d)\n",
785 new_poll_fn, ts);
Jacob Erlbeckf2694b72016-01-26 21:46:26 +0100786
Daniel Willmannca102af2014-08-08 12:14:12 +0200787 m_tx_counter = 0;
788 /* start timer whenever we send the final block */
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100789 if (is_final)
Pau Espin Pedrol28f160e2019-09-05 14:48:35 +0200790 T_START(this, T3191, 3191, "final block (DL-TBF)", true);
Daniel Willmannca102af2014-08-08 12:14:12 +0200791
Pau Espin Pedrol33e80072021-07-22 19:20:50 +0200792 state_fsm.state_flags &= ~(1 << GPRS_RLCMAC_FLAG_TO_DL_ACK); /* clear poll timeout flag */
Daniel Willmannefd5dbb2014-08-25 16:20:23 +0200793
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100794 /* Clear request flag */
795 m_dl_ack_requested = false;
796
Daniel Willmannca102af2014-08-08 12:14:12 +0200797 /* set polling in header */
Jacob Erlbeckf2694b72016-01-26 21:46:26 +0100798 rlc.rrbp = rrbp;
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100799 rlc.es_p = 1; /* Polling */
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +0100800
Pau Espin Pedrol58046e42021-03-29 19:01:13 +0200801 m_last_dl_poll_fn = new_poll_fn;
Jacob Erlbeck16d29c72015-08-24 13:30:39 +0200802
Max0524e382018-01-19 18:22:25 +0100803 LOGPTBFDL(this, LOGL_INFO,
804 "Scheduled Ack/Nack polling on FN=%d, TS=%d\n",
Pau Espin Pedrol16e16782021-03-29 19:10:19 +0200805 new_poll_fn, ts);
Daniel Willmannca102af2014-08-08 12:14:12 +0200806 }
807 }
808
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100809 Encoding::rlc_write_dl_data_header(&rlc, msg_data);
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100810
Max0524e382018-01-19 18:22:25 +0100811 LOGPTBFDL(this, LOGL_DEBUG, "msg block (BSN %d, %s%s): %s\n",
Max136ebcc2019-03-05 14:59:03 +0100812 index, mcs_name(cs),
Max0524e382018-01-19 18:22:25 +0100813 need_padding ? ", padded" : "",
814 msgb_hexdump(dl_msg));
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100815
Daniel Willmannca102af2014-08-08 12:14:12 +0200816 /* Increment TX-counter */
817 m_tx_counter++;
818
Daniel Willmannca102af2014-08-08 12:14:12 +0200819 return dl_msg;
820}
821
Jacob Erlbeck93c55d02015-12-23 16:29:07 +0100822static uint16_t bitnum_to_bsn(int bitnum, uint16_t ssn)
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200823{
Jacob Erlbeck93c55d02015-12-23 16:29:07 +0100824 return ssn - 1 - bitnum;
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200825}
826
Jacob Erlbeck2db0f082015-09-07 18:49:00 +0200827int gprs_rlcmac_dl_tbf::analyse_errors(char *show_rbb, uint8_t ssn,
828 ana_result *res)
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200829{
830 gprs_rlc_data *rlc_data;
831 uint16_t lost = 0, received = 0, skipped = 0;
Jacob Erlbeckb41262f2016-02-05 17:13:24 +0100832 char info[RLC_MAX_WS + 1];
833 memset(info, '.', m_window.ws());
834 info[m_window.ws()] = 0;
Jacob Erlbecka17fccb2015-06-04 16:52:23 +0200835 uint16_t bsn = 0;
Jacob Erlbeck2db0f082015-09-07 18:49:00 +0200836 unsigned received_bytes = 0, lost_bytes = 0;
837 unsigned received_packets = 0, lost_packets = 0;
Jacob Erlbeckb41262f2016-02-05 17:13:24 +0100838 unsigned num_blocks = strlen(show_rbb);
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200839
aravind sirsikarfb41afa2016-11-02 15:48:00 +0530840 unsigned distance = m_window.distance();
841
842 num_blocks = num_blocks > distance
843 ? distance : num_blocks;
844
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200845 /* SSN - 1 is in range V(A)..V(S)-1 */
Jacob Erlbeckb41262f2016-02-05 17:13:24 +0100846 for (unsigned int bitpos = 0; bitpos < num_blocks; bitpos++) {
847 bool is_received;
848 int index = num_blocks - 1 - bitpos;
849
850 is_received = (index >= 0 && show_rbb[index] == 'R');
Jacob Erlbeck2db0f082015-09-07 18:49:00 +0200851
Jacob Erlbeck93c55d02015-12-23 16:29:07 +0100852 bsn = m_window.mod_sns(bitnum_to_bsn(bitpos, ssn));
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200853
Jacob Erlbeck93c55d02015-12-23 16:29:07 +0100854 if (bsn == m_window.mod_sns(m_window.v_a() - 1)) {
Jacob Erlbecka17fccb2015-06-04 16:52:23 +0200855 info[bitpos] = '$';
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200856 break;
Jacob Erlbecka17fccb2015-06-04 16:52:23 +0200857 }
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200858
859 rlc_data = m_rlc.block(bsn);
Jacob Erlbecka17fccb2015-06-04 16:52:23 +0200860 if (!rlc_data) {
861 info[bitpos] = '0';
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200862 continue;
Jacob Erlbecka17fccb2015-06-04 16:52:23 +0200863 }
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200864
Jacob Erlbeck2db0f082015-09-07 18:49:00 +0200865 /* Get general statistics */
866 if (is_received && !m_window.m_v_b.is_acked(bsn)) {
867 received_packets += 1;
868 received_bytes += rlc_data->len;
869 } else if (!is_received && !m_window.m_v_b.is_nacked(bsn)) {
870 lost_packets += 1;
871 lost_bytes += rlc_data->len;
872 }
873
874 /* Get statistics for current CS */
875
Aravind Sirsikar91495522016-07-12 14:17:12 +0530876 if (rlc_data->cs_last != current_cs()) {
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200877 /* This block has already been encoded with a different
878 * CS, so it doesn't help us to decide, whether the
879 * current CS is ok. Ignore it. */
Jacob Erlbecka17fccb2015-06-04 16:52:23 +0200880 info[bitpos] = 'x';
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200881 skipped += 1;
882 continue;
883 }
884
Jacob Erlbeck2db0f082015-09-07 18:49:00 +0200885 if (is_received) {
Jacob Erlbecka17fccb2015-06-04 16:52:23 +0200886 if (!m_window.m_v_b.is_acked(bsn)) {
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200887 received += 1;
Jacob Erlbecka17fccb2015-06-04 16:52:23 +0200888 info[bitpos] = 'R';
889 } else {
890 info[bitpos] = 'r';
891 }
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200892 } else {
Jacob Erlbecka17fccb2015-06-04 16:52:23 +0200893 info[bitpos] = 'L';
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200894 lost += 1;
895 }
896 }
897
Max0524e382018-01-19 18:22:25 +0100898 LOGPTBFDL(this, LOGL_DEBUG,
899 "DL analysis, range=%d:%d, lost=%d, recv=%d, skipped=%d, bsn=%d, info='%s'\n",
900 m_window.v_a(), m_window.v_s(), lost, received, skipped, bsn, info);
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200901
Jacob Erlbeck2db0f082015-09-07 18:49:00 +0200902 res->received_packets = received_packets;
903 res->lost_packets = lost_packets;
904 res->received_bytes = received_bytes;
905 res->lost_bytes = lost_bytes;
906
Jacob Erlbeck144a1d02015-06-04 16:51:44 +0200907 if (lost + received <= 1)
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200908 return -1;
909
910 return lost * 100 / (lost + received);
911}
912
Pau Espin Pedrolb3f23972020-10-23 21:00:23 +0200913gprs_rlc_window *gprs_rlcmac_dl_tbf::window()
Maxea98b7d2018-01-04 15:13:27 +0100914{
915 return &m_window;
916}
917
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100918int gprs_rlcmac_dl_tbf::update_window(unsigned first_bsn,
919 const struct bitvec *rbb)
920{
aravind sirsikarfb41afa2016-11-02 15:48:00 +0530921 unsigned dist;
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100922 uint16_t lost = 0, received = 0;
923 char show_v_b[RLC_MAX_SNS + 1];
924 char show_rbb[RLC_MAX_SNS + 1];
925 int error_rate;
926 struct ana_result ana_res;
aravind sirsikarfb41afa2016-11-02 15:48:00 +0530927 dist = m_window.distance();
928 unsigned num_blocks = rbb->cur_bit > dist
929 ? dist : rbb->cur_bit;
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100930 unsigned behind_last_bsn = m_window.mod_sns(first_bsn + num_blocks);
931
932 Decoding::extract_rbb(rbb, show_rbb);
933 /* show received array in debug */
Max0524e382018-01-19 18:22:25 +0100934 LOGPTBFDL(this, LOGL_DEBUG,
935 "ack: (BSN=%d)\"%s\"(BSN=%d) R=ACK I=NACK\n",
936 first_bsn, show_rbb, m_window.mod_sns(behind_last_bsn - 1));
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100937
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100938 error_rate = analyse_errors(show_rbb, behind_last_bsn, &ana_res);
939
Pau Espin Pedrole8dcf642021-01-14 13:17:01 +0100940 if (the_pcu->vty.cs_adj_enabled && ms())
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100941 ms_update_error_rate(ms(), this, error_rate);
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100942
943 m_window.update(bts, rbb, first_bsn, &lost, &received);
Pau Espin Pedrol9c1db172021-06-04 17:05:51 +0200944 rate_ctr_add(rate_ctr_group_get_ctr(m_ctrs, TBF_CTR_RLC_NACKED), lost);
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100945
946 /* report lost and received packets */
947 gprs_rlcmac_received_lost(this, received, lost);
948
949 /* Used to measure the leak rate */
950 gprs_bssgp_update_bytes_received(ana_res.received_bytes,
951 ana_res.received_packets + ana_res.lost_packets);
952
953 /* raise V(A), if possible */
954 m_window.raise(m_window.move_window());
955
956 /* show receive state array in debug (V(A)..V(S)-1) */
957 m_window.show_state(show_v_b);
Max0524e382018-01-19 18:22:25 +0100958 LOGPTBFDL(this, LOGL_DEBUG,
959 "V(B): (V(A)=%d)\"%s\"(V(S)-1=%d) A=Acked N=Nacked U=Unacked X=Resend-Unacked I=Invalid\n",
960 m_window.v_a(), show_v_b, m_window.v_s_mod(-1));
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100961 return 0;
962}
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200963
Pau Espin Pedrolefcb0462021-07-26 12:33:39 +0200964int gprs_rlcmac_dl_tbf::rcvd_dl_final_ack()
Daniel Willmannca102af2014-08-08 12:14:12 +0200965{
Pau Espin Pedrolf48de622021-07-30 14:48:06 +0200966 uint16_t received;
Pau Espin Pedrol091642a2022-10-28 18:01:31 +0200967 int rc = 0;
Pau Espin Pedrolf48de622021-07-30 14:48:06 +0200968
Pau Espin Pedrolf197f152022-11-17 20:18:46 +0100969 osmo_fsm_inst_dispatch(this->state_fi, TBF_EV_FINAL_ACK_RECVD, NULL);
Pau Espin Pedrolf48de622021-07-30 14:48:06 +0200970
971 /* range V(A)..V(S)-1 */
972 received = m_window.count_unacked();
973 /* report all outstanding packets as received */
974 gprs_rlcmac_received_lost(this, received, 0);
975 m_tx_counter = 0;
976 m_window.reset();
Jacob Erlbeck91ff7d12015-09-01 11:20:29 +0200977
978 /* check for LLC PDU in the LLC Queue */
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100979 if (llc_queue_size(llc_queue()) > 0)
Jacob Erlbeck91ff7d12015-09-01 11:20:29 +0200980 /* we have more data so we will re-use this tbf */
Pau Espin Pedrol091642a2022-10-28 18:01:31 +0200981 rc = ms_new_dl_tbf_assigned_on_pacch(ms(), dl_tbf_as_tbf(this));
Jacob Erlbeck91ff7d12015-09-01 11:20:29 +0200982
Pau Espin Pedrol091642a2022-10-28 18:01:31 +0200983 return rc;
Jacob Erlbeck91ff7d12015-09-01 11:20:29 +0200984}
985
Max7df82d42017-12-15 11:14:30 +0100986int gprs_rlcmac_dl_tbf::rcvd_dl_ack(bool final_ack, unsigned first_bsn,
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100987 struct bitvec *rbb)
988{
Jacob Erlbeckb4beb542016-01-15 13:38:31 +0100989 int rc;
Maxc21f0072017-12-15 17:36:45 +0100990 LOGPTBFDL(this, LOGL_DEBUG, "downlink acknowledge\n");
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100991
Pau Espin Pedrolfbc1baa2021-07-28 21:59:00 +0200992 state_fsm.state_flags |= (1 << GPRS_RLCMAC_FLAG_DL_ACK);
993 state_fsm.state_flags &= ~(1 << GPRS_RLCMAC_FLAG_TO_DL_ACK);
994
995 /* reset N3105 */
996 n_reset(N3105);
997 t_stop(T3191, "ACK/NACK received");
998
Jacob Erlbeckb4beb542016-01-15 13:38:31 +0100999 rc = update_window(first_bsn, rbb);
Jacob Erlbeckeb08f862016-02-05 17:07:12 +01001000
Jacob Erlbeckb4beb542016-01-15 13:38:31 +01001001 if (final_ack) {
Max0524e382018-01-19 18:22:25 +01001002 LOGPTBFDL(this, LOGL_DEBUG, "Final ACK received.\n");
Pau Espin Pedrolefcb0462021-07-26 12:33:39 +02001003 rc = rcvd_dl_final_ack();
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +02001004 } else if (state_is(TBF_ST_FINISHED) && m_window.window_empty()) {
Max0524e382018-01-19 18:22:25 +01001005 LOGPTBFDL(this, LOGL_NOTICE,
1006 "Received acknowledge of all blocks, but without final ack indication (don't worry)\n");
Jacob Erlbeckb4beb542016-01-15 13:38:31 +01001007 }
1008
1009 return rc;
Jacob Erlbeckeb08f862016-02-05 17:07:12 +01001010}
1011
Daniel Willmannca102af2014-08-08 12:14:12 +02001012bool gprs_rlcmac_dl_tbf::dl_window_stalled() const
1013{
1014 return m_window.window_stalled();
1015}
1016
Jacob Erlbeckeceb9102015-03-20 14:41:50 +01001017void gprs_rlcmac_dl_tbf::request_dl_ack()
1018{
1019 m_dl_ack_requested = true;
1020}
1021
Pau Espin Pedrol8fa3e062022-10-28 17:38:52 +02001022void dl_tbf_request_dl_ack(struct gprs_rlcmac_dl_tbf *dl_tbf) {
Pau Espin Pedrol14beef62022-10-26 19:44:07 +02001023 dl_tbf->request_dl_ack();
1024}
1025
Pau Espin Pedrol405d2d12021-07-29 18:14:07 +02001026/* Does this DL TBF require to poll the MS for DL ACK/NACK? */
1027bool gprs_rlcmac_dl_tbf::need_poll_for_dl_ack_nack() const
Jacob Erlbeckeceb9102015-03-20 14:41:50 +01001028{
Pau Espin Pedrol405d2d12021-07-29 18:14:07 +02001029 /* poll after POLL_ACK_AFTER_FRAMES frames, or when final block is tx or
1030 * when last polled DL ACK/NACK was lost. */
Pau Espin Pedrol33e80072021-07-22 19:20:50 +02001031 return state_fsm.state_flags & (1 << GPRS_RLCMAC_FLAG_TO_DL_ACK) ||
Jacob Erlbeckeceb9102015-03-20 14:41:50 +01001032 m_tx_counter >= POLL_ACK_AFTER_FRAMES ||
1033 m_dl_ack_requested;
1034}
1035
1036bool gprs_rlcmac_dl_tbf::have_data() const
1037{
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +01001038 return llc_chunk_size(&m_llc) > 0 ||
1039 (llc_queue_size(llc_queue()) > 0);
Jacob Erlbeckeceb9102015-03-20 14:41:50 +01001040}
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +01001041
Max9dabfa22017-05-16 16:10:45 +02001042static inline int frames_since_last(int32_t last, unsigned fn)
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +01001043{
Max9dabfa22017-05-16 16:10:45 +02001044 unsigned wrapped = (fn + GSM_MAX_FN - last) % GSM_MAX_FN;
1045
1046 if (last < 0)
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +01001047 return -1;
1048
Max9dabfa22017-05-16 16:10:45 +02001049 if (wrapped < GSM_MAX_FN/2)
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +01001050 return wrapped;
Max9dabfa22017-05-16 16:10:45 +02001051
1052 return wrapped - GSM_MAX_FN;
1053}
1054
1055int gprs_rlcmac_dl_tbf::frames_since_last_poll(unsigned fn) const
1056{
1057 return frames_since_last(m_last_dl_poll_fn, fn);
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +01001058}
1059
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +01001060int gprs_rlcmac_dl_tbf::frames_since_last_drain(unsigned fn) const
1061{
Max9dabfa22017-05-16 16:10:45 +02001062 return frames_since_last(m_last_dl_drained_fn, fn);
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +01001063}
1064
1065bool gprs_rlcmac_dl_tbf::keep_open(unsigned fn) const
1066{
1067 int keep_time_frames;
Pau Espin Pedrol2b5c6292019-09-09 13:41:00 +02001068 unsigned long dl_tbf_idle_msec;
Pau Espin Pedrol5b9d0bb2021-03-02 12:53:58 +01001069 int since_last_drain;
1070 bool keep;
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +01001071
Pau Espin Pedrol924aaad2021-01-14 12:01:42 +01001072 dl_tbf_idle_msec = osmo_tdef_get(the_pcu->T_defs, -2031, OSMO_TDEF_MS, -1);
Pau Espin Pedrol2b5c6292019-09-09 13:41:00 +02001073 if (dl_tbf_idle_msec == 0)
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +01001074 return false;
1075
Pau Espin Pedrol2b5c6292019-09-09 13:41:00 +02001076 keep_time_frames = msecs_to_frames(dl_tbf_idle_msec);
Pau Espin Pedrol5b9d0bb2021-03-02 12:53:58 +01001077 since_last_drain = frames_since_last_drain(fn);
1078 keep = since_last_drain <= keep_time_frames;
1079
1080 if (since_last_drain >= 0)
1081 LOGPTBFDL(this, LOGL_DEBUG, "Keep idle TBF open: %d/%d -> %s\n",
1082 since_last_drain, keep_time_frames, keep ? "yes" : "no");
1083 return keep;
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +01001084}
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301085
1086/*
1087 * This function returns the pointer to data which needs
1088 * to be copied. Also updates the status of the block related to
1089 * Split block handling in the RLC/MAC block.
1090 */
1091enum egprs_rlc_dl_reseg_bsn_state
1092 gprs_rlcmac_dl_tbf::egprs_dl_get_data(int bsn, uint8_t **block_data)
1093{
1094 gprs_rlc_data *rlc_data = m_rlc.block(bsn);
1095 egprs_rlc_dl_reseg_bsn_state *block_status_dl =
1096 &rlc_data->spb_status.block_status_dl;
1097
Pau Espin Pedrol2ae83372020-05-18 11:35:35 +02001098 enum CodingScheme cs_init = rlc_data->cs_init;
1099 enum CodingScheme cs_current_trans = rlc_data->cs_current_trans;
Maxd4a39292019-03-13 18:44:20 +01001100
Pau Espin Pedrol2ae83372020-05-18 11:35:35 +02001101 enum HeaderType ht_cs_init = mcs_header_type(rlc_data->cs_init);
1102 enum HeaderType ht_cs_current_trans = mcs_header_type(rlc_data->cs_current_trans);
Maxd4a39292019-03-13 18:44:20 +01001103
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301104 *block_data = &rlc_data->block[0];
1105
1106 /*
1107 * Table 10.3a.0.1 of 44.060
1108 * MCS6,9: second segment starts at 74/2 = 37
1109 * MCS5,7: second segment starts at 56/2 = 28
1110 * MCS8: second segment starts at 31
1111 * MCS4: second segment starts at 44/2 = 22
1112 */
Maxd4a39292019-03-13 18:44:20 +01001113 if (ht_cs_current_trans == HEADER_EGPRS_DATA_TYPE_3) {
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301114 if (*block_status_dl == EGPRS_RESEG_FIRST_SEG_SENT) {
Maxd4a39292019-03-13 18:44:20 +01001115 switch (cs_init) {
Maxbea2edb2019-03-06 17:04:59 +01001116 case MCS6 :
1117 case MCS9 :
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301118 *block_data = &rlc_data->block[37];
1119 break;
Maxbea2edb2019-03-06 17:04:59 +01001120 case MCS7 :
1121 case MCS5 :
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301122 *block_data = &rlc_data->block[28];
1123 break;
Maxbea2edb2019-03-06 17:04:59 +01001124 case MCS8 :
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301125 *block_data = &rlc_data->block[31];
1126 break;
Maxbea2edb2019-03-06 17:04:59 +01001127 case MCS4 :
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301128 *block_data = &rlc_data->block[22];
1129 break;
1130 default:
Max0524e382018-01-19 18:22:25 +01001131 LOGPTBFDL(this, LOGL_ERROR,
1132 "FIXME: Software error: hit invalid condition. "
1133 "headerType(%d) blockstatus(%d) cs(%s) PLEASE FIX!\n",
Maxd4a39292019-03-13 18:44:20 +01001134 ht_cs_current_trans,
Max136ebcc2019-03-05 14:59:03 +01001135 *block_status_dl, mcs_name(cs_init));
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301136 break;
1137
1138 }
1139 return EGPRS_RESEG_SECOND_SEG_SENT;
Maxd4a39292019-03-13 18:44:20 +01001140 } else if ((ht_cs_init == HEADER_EGPRS_DATA_TYPE_1) ||
1141 (ht_cs_init == HEADER_EGPRS_DATA_TYPE_2)) {
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301142 return EGPRS_RESEG_FIRST_SEG_SENT;
Maxd4a39292019-03-13 18:44:20 +01001143 } else if ((cs_init == MCS4) &&
1144 (cs_current_trans == MCS1)) {
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301145 return EGPRS_RESEG_FIRST_SEG_SENT;
1146 }
1147 }
1148 return EGPRS_RESEG_DL_DEFAULT;
1149}
1150
1151/*
1152 * This function returns the status of split block
1153 * for RLC/MAC block.
1154 */
1155unsigned int gprs_rlcmac_dl_tbf::get_egprs_dl_spb_status(const int bsn)
1156{
1157 const gprs_rlc_data *rlc_data = m_rlc.block(bsn);
1158
1159 return rlc_data->spb_status.block_status_dl;
1160}
1161
1162/*
1163 * This function returns the spb value to be sent OTA
1164 * for RLC/MAC block.
1165 */
1166enum egprs_rlcmac_dl_spb gprs_rlcmac_dl_tbf::get_egprs_dl_spb(const int bsn)
1167{
1168 struct gprs_rlc_data *rlc_data = m_rlc.block(bsn);
Maxd4a39292019-03-13 18:44:20 +01001169 egprs_rlc_dl_reseg_bsn_state block_status_dl = rlc_data->spb_status.block_status_dl;
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301170
Pau Espin Pedrol2ae83372020-05-18 11:35:35 +02001171 enum CodingScheme cs_init = rlc_data->cs_init;
1172 enum CodingScheme cs_current_trans = rlc_data->cs_current_trans;
Maxd4a39292019-03-13 18:44:20 +01001173
Pau Espin Pedrol2ae83372020-05-18 11:35:35 +02001174 enum HeaderType ht_cs_init = mcs_header_type(rlc_data->cs_init);
1175 enum HeaderType ht_cs_current_trans = mcs_header_type(rlc_data->cs_current_trans);
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301176
1177 /* Table 10.4.8b.1 of 44.060 */
Maxd4a39292019-03-13 18:44:20 +01001178 if (ht_cs_current_trans == HEADER_EGPRS_DATA_TYPE_3) {
1179 /*
1180 * if we are sending the second segment the spb should be 3
1181 * otherwise it should be 2
1182 */
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301183 if (block_status_dl == EGPRS_RESEG_FIRST_SEG_SENT) {
sivasankarida7250a2016-12-16 12:57:18 +05301184 /* statistics */
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001185 bts_do_rate_ctr_inc(bts, CTR_SPB_DL_SECOND_SEGMENT);
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301186 return EGPRS_RLCMAC_DL_SEC_SEG;
Maxd4a39292019-03-13 18:44:20 +01001187 } else if ((ht_cs_init == HEADER_EGPRS_DATA_TYPE_1) ||
1188 (ht_cs_init == HEADER_EGPRS_DATA_TYPE_2)) {
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001189 bts_do_rate_ctr_inc(bts, CTR_SPB_DL_FIRST_SEGMENT);
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301190 return EGPRS_RLCMAC_DL_FIRST_SEG;
Maxd4a39292019-03-13 18:44:20 +01001191 } else if ((cs_init == MCS4) &&
1192 (cs_current_trans == MCS1)) {
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001193 bts_do_rate_ctr_inc(bts, CTR_SPB_DL_FIRST_SEGMENT);
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301194 return EGPRS_RLCMAC_DL_FIRST_SEG;
1195 }
1196 }
1197 /* Non SPB cases 0 is reurned */
1198 return EGPRS_RLCMAC_DL_NO_RETX;
1199}
Aravind Sirsikar8e70bb52016-09-15 17:51:16 +05301200
Max9d7357e2017-12-14 15:02:33 +01001201void gprs_rlcmac_dl_tbf::set_window_size()
Aravind Sirsikar8e70bb52016-09-15 17:51:16 +05301202{
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001203 const struct gprs_rlcmac_bts *b = bts;
Max34513fe2018-12-11 16:47:30 +01001204 uint16_t ws = egprs_window_size(b, dl_slots());
1205
Max0524e382018-01-19 18:22:25 +01001206 LOGPTBFDL(this, LOGL_INFO, "setting EGPRS DL window size to %u, base(%u) slots(%u) ws_pdch(%u)\n",
Pau Espin Pedrol519d0712021-01-14 14:30:03 +01001207 ws, bts->pcu->vty.ws_base, pcu_bitcount(dl_slots()), bts->pcu->vty.ws_pdch);
Aravind Sirsikar8e70bb52016-09-15 17:51:16 +05301208 m_window.set_ws(ws);
1209}
Mrinal Mishraf86307e2016-11-10 18:16:30 +05301210
Maxfb59a932019-03-13 18:40:19 +01001211void gprs_rlcmac_dl_tbf::update_coding_scheme_counter_dl(enum CodingScheme cs)
Mrinal Mishraf86307e2016-11-10 18:16:30 +05301212{
Maxfb59a932019-03-13 18:40:19 +01001213 switch (cs) {
1214 case CS1:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001215 bts_do_rate_ctr_inc(bts, CTR_GPRS_DL_CS1);
Pau Espin Pedrol9c1db172021-06-04 17:05:51 +02001216 rate_ctr_inc(rate_ctr_group_get_ctr(m_dl_gprs_ctrs, TBF_CTR_GPRS_DL_CS1));
Maxfb59a932019-03-13 18:40:19 +01001217 break;
1218 case CS2:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001219 bts_do_rate_ctr_inc(bts, CTR_GPRS_DL_CS2);
Pau Espin Pedrol9c1db172021-06-04 17:05:51 +02001220 rate_ctr_inc(rate_ctr_group_get_ctr(m_dl_gprs_ctrs, TBF_CTR_GPRS_DL_CS2));
Maxfb59a932019-03-13 18:40:19 +01001221 break;
1222 case CS3:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001223 bts_do_rate_ctr_inc(bts, CTR_GPRS_DL_CS3);
Pau Espin Pedrol9c1db172021-06-04 17:05:51 +02001224 rate_ctr_inc(rate_ctr_group_get_ctr(m_dl_gprs_ctrs, TBF_CTR_GPRS_DL_CS3));
Maxfb59a932019-03-13 18:40:19 +01001225 break;
1226 case CS4:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001227 bts_do_rate_ctr_inc(bts, CTR_GPRS_DL_CS4);
Pau Espin Pedrol9c1db172021-06-04 17:05:51 +02001228 rate_ctr_inc(rate_ctr_group_get_ctr(m_dl_gprs_ctrs, TBF_CTR_GPRS_DL_CS4));
Maxfb59a932019-03-13 18:40:19 +01001229 break;
1230 case MCS1:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001231 bts_do_rate_ctr_inc(bts, CTR_EGPRS_DL_MCS1);
Pau Espin Pedrol9c1db172021-06-04 17:05:51 +02001232 rate_ctr_inc(rate_ctr_group_get_ctr(m_dl_egprs_ctrs, TBF_CTR_EGPRS_DL_MCS1));
Maxfb59a932019-03-13 18:40:19 +01001233 break;
1234 case MCS2:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001235 bts_do_rate_ctr_inc(bts, CTR_EGPRS_DL_MCS2);
Pau Espin Pedrol9c1db172021-06-04 17:05:51 +02001236 rate_ctr_inc(rate_ctr_group_get_ctr(m_dl_egprs_ctrs, TBF_CTR_EGPRS_DL_MCS2));
Maxfb59a932019-03-13 18:40:19 +01001237 break;
1238 case MCS3:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001239 bts_do_rate_ctr_inc(bts, CTR_EGPRS_DL_MCS3);
Pau Espin Pedrol9c1db172021-06-04 17:05:51 +02001240 rate_ctr_inc(rate_ctr_group_get_ctr(m_dl_egprs_ctrs, TBF_CTR_EGPRS_DL_MCS3));
Maxfb59a932019-03-13 18:40:19 +01001241 break;
1242 case MCS4:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001243 bts_do_rate_ctr_inc(bts, CTR_EGPRS_DL_MCS4);
Pau Espin Pedrol9c1db172021-06-04 17:05:51 +02001244 rate_ctr_inc(rate_ctr_group_get_ctr(m_dl_egprs_ctrs, TBF_CTR_EGPRS_DL_MCS4));
Maxfb59a932019-03-13 18:40:19 +01001245 break;
1246 case MCS5:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001247 bts_do_rate_ctr_inc(bts, CTR_EGPRS_DL_MCS5);
Pau Espin Pedrol9c1db172021-06-04 17:05:51 +02001248 rate_ctr_inc(rate_ctr_group_get_ctr(m_dl_egprs_ctrs, TBF_CTR_EGPRS_DL_MCS5));
Maxfb59a932019-03-13 18:40:19 +01001249 break;
1250 case MCS6:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001251 bts_do_rate_ctr_inc(bts, CTR_EGPRS_DL_MCS6);
Pau Espin Pedrol9c1db172021-06-04 17:05:51 +02001252 rate_ctr_inc(rate_ctr_group_get_ctr(m_dl_egprs_ctrs, TBF_CTR_EGPRS_DL_MCS6));
Maxfb59a932019-03-13 18:40:19 +01001253 break;
1254 case MCS7:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001255 bts_do_rate_ctr_inc(bts, CTR_EGPRS_DL_MCS7);
Pau Espin Pedrol9c1db172021-06-04 17:05:51 +02001256 rate_ctr_inc(rate_ctr_group_get_ctr(m_dl_egprs_ctrs, TBF_CTR_EGPRS_DL_MCS7));
Maxfb59a932019-03-13 18:40:19 +01001257 break;
1258 case MCS8:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001259 bts_do_rate_ctr_inc(bts, CTR_EGPRS_DL_MCS8);
Pau Espin Pedrol9c1db172021-06-04 17:05:51 +02001260 rate_ctr_inc(rate_ctr_group_get_ctr(m_dl_egprs_ctrs, TBF_CTR_EGPRS_DL_MCS8));
Maxfb59a932019-03-13 18:40:19 +01001261 break;
1262 case MCS9:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001263 bts_do_rate_ctr_inc(bts, CTR_EGPRS_DL_MCS9);
Pau Espin Pedrol9c1db172021-06-04 17:05:51 +02001264 rate_ctr_inc(rate_ctr_group_get_ctr(m_dl_egprs_ctrs, TBF_CTR_EGPRS_DL_MCS9));
Maxfb59a932019-03-13 18:40:19 +01001265 break;
1266 default:
1267 LOGPTBFDL(this, LOGL_ERROR, "attempting to update rate counters for unsupported (M)CS %s\n",
1268 mcs_name(cs));
Mrinal Mishraf86307e2016-11-10 18:16:30 +05301269 }
1270}
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +01001271
Pau Espin Pedrolcc30b052022-10-27 15:25:55 +02001272struct gprs_rlcmac_dl_tbf *tbf_as_dl_tbf(struct gprs_rlcmac_tbf *tbf)
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +01001273{
1274 if (tbf && tbf->direction == GPRS_RLCMAC_DL_TBF)
1275 return static_cast<gprs_rlcmac_dl_tbf *>(tbf);
1276 else
1277 return NULL;
1278}
Pau Espin Pedrol1e1275f2022-11-17 20:57:34 +01001279
1280const struct gprs_rlcmac_dl_tbf *tbf_as_dl_tbf_const(const struct gprs_rlcmac_tbf *tbf)
1281{
1282 if (tbf && tbf->direction == GPRS_RLCMAC_DL_TBF)
1283 return static_cast<const gprs_rlcmac_dl_tbf *>(tbf);
1284 else
1285 return NULL;
1286}