blob: 0936e1c86470e385b9e0f8bf65daaf14c90586dd [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{
Daniel Willmannca102af2014-08-08 12:14:12 +0200183}
184
Daniel Willmannca102af2014-08-08 12:14:12 +0200185/**
186 * TODO: split into unit test-able parts...
187 */
Pau Espin Pedrol8a35e642021-01-18 17:14:14 +0100188int dl_tbf_handle(struct gprs_rlcmac_bts *bts,
189 const uint32_t tlli, const uint32_t tlli_old, const char *imsi,
190 uint8_t ms_class, uint8_t egprs_ms_class,
191 const uint16_t delay_csec,
192 const uint8_t *data, const uint16_t len)
Daniel Willmannca102af2014-08-08 12:14:12 +0200193{
Jacob Erlbeckac289052015-08-14 12:50:54 +0200194 struct gprs_rlcmac_dl_tbf *dl_tbf = NULL;
Jacob Erlbeck409efa12015-06-12 14:06:09 +0200195 int rc;
Jacob Erlbeckac289052015-08-14 12:50:54 +0200196 GprsMs *ms, *ms_old;
Daniel Willmannca102af2014-08-08 12:14:12 +0200197
198 /* check for existing TBF */
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100199 ms = bts_ms_store(bts)->get_ms(tlli, tlli_old, imsi);
Jacob Erlbecka47aaa42016-01-07 16:47:34 +0100200
Pau Espin Pedrol5deac142021-11-12 18:01:50 +0100201 /* If we got MS by TLLI above let's see if we already have another MS
202 * object identified by IMSI and merge them */
203 if (ms && !ms_imsi_is_valid(ms) && imsi) {
Pau Espin Pedrol7f360e72022-10-21 14:30:36 +0200204 ms_old = bts_ms_store(bts)->get_ms(GSM_RESERVED_TMSI, GSM_RESERVED_TMSI, imsi);
Jacob Erlbeckac289052015-08-14 12:50:54 +0200205 if (ms_old && ms_old != ms) {
206 /* The TLLI has changed (RAU), so there are two MS
207 * objects for the same MS */
Max0524e382018-01-19 18:22:25 +0100208 LOGP(DTBF, LOGL_NOTICE,
209 "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 +0100210 ms_tlli(ms_old), ms_imsi(ms_old), ms_tlli(ms), ms_imsi(ms));
Jacob Erlbeckac289052015-08-14 12:50:54 +0200211
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100212 ms_ref(ms_old);
Jacob Erlbeckac289052015-08-14 12:50:54 +0200213
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100214 if (!ms_dl_tbf(ms) && ms_dl_tbf(ms_old)) {
Max0524e382018-01-19 18:22:25 +0100215 LOGP(DTBF, LOGL_NOTICE,
216 "IMSI %s, old TBF %s: moving DL TBF to new MS object\n",
Pau Espin Pedrol5deac142021-11-12 18:01:50 +0100217 imsi ? : "unknown", ms_dl_tbf(ms_old)->name());
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100218 dl_tbf = ms_dl_tbf(ms_old);
Jacob Erlbeckac289052015-08-14 12:50:54 +0200219 /* Move the DL TBF to the new MS */
220 dl_tbf->set_ms(ms);
221 }
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100222 ms_merge_and_clear_ms(ms, ms_old);
223
224 ms_unref(ms_old);
Jacob Erlbeckac289052015-08-14 12:50:54 +0200225 }
226 }
227
Pau Espin Pedrol528820d2020-10-26 12:40:11 +0100228 if (!ms)
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100229 ms = bts_alloc_ms(bts, ms_class, egprs_ms_class);
Pau Espin Pedrol5deac142021-11-12 18:01:50 +0100230 if (imsi)
231 ms_set_imsi(ms, imsi);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100232 ms_confirm_tlli(ms, tlli);
233 if (!ms_ms_class(ms) && ms_class) {
234 ms_set_ms_class(ms, ms_class);
Pau Espin Pedrol758ace82020-10-28 19:58:17 +0100235 }
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100236 if (!ms_egprs_ms_class(ms) && egprs_ms_class) {
237 ms_set_egprs_ms_class(ms, egprs_ms_class);
Pau Espin Pedrol758ace82020-10-28 19:58:17 +0100238 }
Pau Espin Pedrol528820d2020-10-26 12:40:11 +0100239
Pau Espin Pedrol14beef62022-10-26 19:44:07 +0200240 rc = ms_append_llc_dl_data(ms, delay_csec, data, len);
241 if (rc < 0)
242 return rc;
Pau Espin Pedrol14beef62022-10-26 19:44:07 +0200243 return 0;
Daniel Willmannca102af2014-08-08 12:14:12 +0200244}
245
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100246bool gprs_rlcmac_dl_tbf::restart_bsn_cycle()
Daniel Willmannca102af2014-08-08 12:14:12 +0200247{
Jacob Erlbeck95340242015-03-19 13:22:07 +0100248 /* If V(S) == V(A) and finished state, we would have received
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100249 * acknowledgement of all transmitted block. In this case we would
250 * have transmitted the final block, and received ack from MS. But in
251 * this case we did not receive the final ack indication from MS. This
252 * should never happen if MS works correctly.
253 */
Jacob Erlbeck95340242015-03-19 13:22:07 +0100254 if (m_window.window_empty()) {
Max0524e382018-01-19 18:22:25 +0100255 LOGPTBFDL(this, LOGL_DEBUG, "MS acked all blocks\n");
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100256 return false;
Jacob Erlbeck95340242015-03-19 13:22:07 +0100257 }
258
259 /* cycle through all unacked blocks */
260 int resend = m_window.mark_for_resend();
261
262 /* At this point there should be at least one unacked block
263 * to be resent. If not, this is an software error. */
264 if (resend == 0) {
Max0524e382018-01-19 18:22:25 +0100265 LOGPTBFDL(this, LOGL_ERROR,
266 "FIXME: Software error: There are no unacknowledged blocks, but V(A) != V(S). PLEASE FIX!\n");
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100267 return false;
Jacob Erlbeck95340242015-03-19 13:22:07 +0100268 }
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100269
270 return true;
271}
272
273int gprs_rlcmac_dl_tbf::take_next_bsn(uint32_t fn,
Pau Espin Pedrol022f9e52020-11-16 18:49:39 +0100274 int previous_bsn, enum mcs_kind req_mcs_kind, bool *may_combine)
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100275{
276 int bsn;
Jacob Erlbeck64e7b832016-02-04 15:16:47 +0100277 int data_len2, force_data_len = -1;
Pau Espin Pedrolfc464932021-01-25 12:05:32 +0100278 enum CodingScheme tx_cs;
279
280 /* Scheduler may be fine with sending any kind of data, but if
281 the selected TBF is GPRS-only, then let's filter out EGPRS
282 here */
283 if (!is_egprs_enabled())
284 req_mcs_kind = GPRS;
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100285
Alexander Couzense46d8dc2019-09-10 15:34:49 +0200286 /* search for a nacked or resend marked bsn */
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100287 bsn = m_window.resend_needed();
288
289 if (previous_bsn >= 0) {
Pau Espin Pedrolfc464932021-01-25 12:05:32 +0100290 tx_cs = m_rlc.block(previous_bsn)->cs_current_trans;
291 if (!mcs_is_edge(tx_cs))
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100292 return -1;
Jacob Erlbeck64e7b832016-02-04 15:16:47 +0100293 force_data_len = m_rlc.block(previous_bsn)->len;
Pau Espin Pedrolfc464932021-01-25 12:05:32 +0100294 } else {
295 tx_cs = ms_current_cs_dl(ms(), req_mcs_kind);
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100296 }
297
298 if (bsn >= 0) {
Alexander Couzense46d8dc2019-09-10 15:34:49 +0200299 /* resend an unacked bsn or resend bsn. */
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100300 if (previous_bsn == bsn)
301 return -1;
302
303 if (previous_bsn >= 0 &&
304 m_window.mod_sns(bsn - previous_bsn) > RLC_EGPRS_MAX_BSN_DELTA)
305 return -1;
306
Aravind Sirsikarcf2152b2016-07-13 18:46:17 +0530307 if (is_egprs_enabled()) {
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530308 /* Table 8.1.1.2 and Table 8.1.1.1 of 44.060 */
Pau Espin Pedrolfc464932021-01-25 12:05:32 +0100309 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 +0100310 bts->pcu->vty.dl_arq_type == EGPRS_ARQ1);
Aravind Sirsikarcf2152b2016-07-13 18:46:17 +0530311
Max0524e382018-01-19 18:22:25 +0100312 LOGPTBFDL(this, LOGL_DEBUG,
Maxa0353542019-03-06 18:03:58 +0100313 "initial_cs_dl(%s) last_mcs(%s) demanded_mcs(%s) cs_trans(%s) arq_type(%d) bsn(%d)\n",
314 mcs_name(m_rlc.block(bsn)->cs_init),
315 mcs_name(m_rlc.block(bsn)->cs_last),
Pau Espin Pedrolfc464932021-01-25 12:05:32 +0100316 mcs_name(tx_cs),
Maxa0353542019-03-06 18:03:58 +0100317 mcs_name(m_rlc.block(bsn)->cs_current_trans),
Pau Espin Pedrol97296b22021-01-14 13:08:02 +0100318 the_pcu->vty.dl_arq_type, bsn);
Aravind Sirsikarcf2152b2016-07-13 18:46:17 +0530319
320 /* TODO: Need to remove this check when MCS-8 -> MCS-6
321 * transistion is handled.
322 * Refer commit be881c028fc4da00c4046ecd9296727975c206a3
323 */
Maxbea2edb2019-03-06 17:04:59 +0100324 if (m_rlc.block(bsn)->cs_init == MCS8)
Aravind Sirsikarcf2152b2016-07-13 18:46:17 +0530325 m_rlc.block(bsn)->cs_current_trans =
Maxbea2edb2019-03-06 17:04:59 +0100326 MCS8;
Alexander Couzense46d8dc2019-09-10 15:34:49 +0200327 } else {
328 /* gprs */
Aravind Sirsikarcf2152b2016-07-13 18:46:17 +0530329 m_rlc.block(bsn)->cs_current_trans =
330 m_rlc.block(bsn)->cs_last;
Alexander Couzense46d8dc2019-09-10 15:34:49 +0200331 }
Aravind Sirsikarcf2152b2016-07-13 18:46:17 +0530332
Jacob Erlbeck64e7b832016-02-04 15:16:47 +0100333 data_len2 = m_rlc.block(bsn)->len;
334 if (force_data_len > 0 && force_data_len != data_len2)
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100335 return -1;
Max0524e382018-01-19 18:22:25 +0100336 LOGPTBFDL(this, LOGL_DEBUG, "Resending BSN %d\n", bsn);
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100337 /* re-send block with negative aknowlegement */
338 m_window.m_v_b.mark_unacked(bsn);
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100339 bts_do_rate_ctr_inc(bts, CTR_RLC_RESENT);
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +0200340 } else if (state_is(TBF_ST_FINISHED)) {
Alexander Couzense46d8dc2019-09-10 15:34:49 +0200341 /* If the TBF is in finished, we already sent all packages at least once.
342 * If any packages could have been sent (because of unacked) it should have
343 * been catched up by the upper if(bsn >= 0) */
Max0524e382018-01-19 18:22:25 +0100344 LOGPTBFDL(this, LOGL_DEBUG,
345 "Restarting at BSN %d, because all blocks have been transmitted.\n",
346 m_window.v_a());
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100347 bts_do_rate_ctr_inc(bts, CTR_RLC_RESTARTED);
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 (dl_window_stalled()) {
Alexander Couzense46d8dc2019-09-10 15:34:49 +0200351 /* There are no more packages to send, but the window is stalled.
352 * Restart the bsn_cycle to resend all unacked messages */
Max0524e382018-01-19 18:22:25 +0100353 LOGPTBFDL(this, LOGL_NOTICE,
354 "Restarting at BSN %d, because the window is stalled.\n",
355 m_window.v_a());
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100356 bts_do_rate_ctr_inc(bts, CTR_RLC_STALLED);
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100357 if (restart_bsn_cycle())
Pau Espin Pedrol022f9e52020-11-16 18:49:39 +0100358 return take_next_bsn(fn, previous_bsn, req_mcs_kind, may_combine);
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100359 } else if (have_data()) {
Alexander Couzense46d8dc2019-09-10 15:34:49 +0200360 /* The window has space left, generate new bsn */
Max0524e382018-01-19 18:22:25 +0100361 LOGPTBFDL(this, LOGL_DEBUG,
Pau Espin Pedrol022f9e52020-11-16 18:49:39 +0100362 "Sending new block at BSN %d, CS=%s%s\n",
Pau Espin Pedrolfc464932021-01-25 12:05:32 +0100363 m_window.v_s(), mcs_name(tx_cs),
364 force_data_len != -1 ? " (forced)" : "");
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100365
Pau Espin Pedrolfc464932021-01-25 12:05:32 +0100366 bsn = create_new_bsn(fn, tx_cs);
Pau Espin Pedrol05f9f592021-01-14 12:56:58 +0100367 } else if (bts->pcu->vty.dl_tbf_preemptive_retransmission && !m_window.window_empty()) {
Alexander Couzense46d8dc2019-09-10 15:34:49 +0200368 /* The window contains unacked packages, but not acked.
369 * Mark unacked bsns as RESEND */
Max0524e382018-01-19 18:22:25 +0100370 LOGPTBFDL(this, LOGL_DEBUG,
371 "Restarting at BSN %d, because all blocks have been transmitted (FLOW).\n",
372 m_window.v_a());
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100373 bts_do_rate_ctr_inc(bts, CTR_RLC_RESTARTED);
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100374 if (restart_bsn_cycle())
Pau Espin Pedrol022f9e52020-11-16 18:49:39 +0100375 return take_next_bsn(fn, previous_bsn, req_mcs_kind, may_combine);
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100376 } else {
377 /* Nothing left to send, create dummy LLC commands */
Max0524e382018-01-19 18:22:25 +0100378 LOGPTBFDL(this, LOGL_DEBUG,
379 "Sending new dummy block at BSN %d, CS=%s\n",
Pau Espin Pedrolfc464932021-01-25 12:05:32 +0100380 m_window.v_s(), mcs_name(tx_cs));
381 bsn = create_new_bsn(fn, tx_cs);
Aravind Sirsikarcf2152b2016-07-13 18:46:17 +0530382 /* Don't send a second block, so don't set cs_current_trans */
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100383 }
384
385 if (bsn < 0) {
386 /* we just send final block again */
Max0524e382018-01-19 18:22:25 +0100387 LOGPTBFDL(this, LOGL_DEBUG,
388 "Nothing else to send, Re-transmit final block!\n");
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100389 bsn = m_window.v_s_mod(-1);
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100390 bts_do_rate_ctr_inc(bts, CTR_RLC_FINAL_BLOCK_RESENT);
391 bts_do_rate_ctr_inc(bts, CTR_RLC_RESENT);
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100392 }
393
Pau Espin Pedrol2ae83372020-05-18 11:35:35 +0200394 *may_combine = num_data_blocks(mcs_header_type(m_rlc.block(bsn)->cs_current_trans)) > 1;
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100395
396 return bsn;
397}
398
399/*
400 * Create DL data block
401 * The messages are fragmented and forwarded as data blocks.
402 */
Pau Espin Pedrol022f9e52020-11-16 18:49:39 +0100403struct 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 +0100404{
405 int bsn, bsn2 = -1;
Jacob Erlbeck64e7b832016-02-04 15:16:47 +0100406 bool may_combine;
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100407
Pau Espin Pedrol022f9e52020-11-16 18:49:39 +0100408 LOGPTBFDL(this, LOGL_DEBUG, "downlink (V(A)==%d .. V(S)==%d) mcs_mode_restrict=%s\n",
409 m_window.v_a(), m_window.v_s(), mode_name(req_mcs_kind));
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100410
Pau Espin Pedrol022f9e52020-11-16 18:49:39 +0100411 bsn = take_next_bsn(fn, -1, req_mcs_kind, &may_combine);
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100412 if (bsn < 0)
413 return NULL;
414
Jacob Erlbeck64e7b832016-02-04 15:16:47 +0100415 if (may_combine)
Pau Espin Pedrol022f9e52020-11-16 18:49:39 +0100416 bsn2 = take_next_bsn(fn, bsn, req_mcs_kind, &may_combine);
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100417
418 return create_dl_acked_block(fn, ts, bsn, bsn2);
Daniel Willmannca102af2014-08-08 12:14:12 +0200419}
420
Maxa10c3982017-07-07 18:25:41 +0200421/* depending on the current TBF, we assign on PACCH or AGCH */
422void gprs_rlcmac_dl_tbf::trigger_ass(struct gprs_rlcmac_tbf *old_tbf)
423{
424 /* stop pending timer */
Maxee5be3a2017-12-20 17:31:13 +0100425 stop_timers("assignment (DL-TBF)");
Maxa10c3982017-07-07 18:25:41 +0200426
427 /* check for downlink tbf: */
428 if (old_tbf) {
Pau Espin Pedrold06ec272021-07-30 15:03:21 +0200429 LOGPTBFDL(this, LOGL_DEBUG, "Send downlink assignment on PACCH, because %s exists\n", old_tbf->name());
Pau Espin Pedrol49a2f402021-07-27 17:33:07 +0200430 osmo_fsm_inst_dispatch(old_tbf->dl_ass_fsm.fi, TBF_DL_ASS_EV_SCHED_ASS, NULL);
Maxa10c3982017-07-07 18:25:41 +0200431
432 /* change state */
Pau Espin Pedrol33e80072021-07-22 19:20:50 +0200433 osmo_fsm_inst_dispatch(this->state_fsm.fi, TBF_EV_ASSIGN_ADD_PACCH, NULL);
Maxa10c3982017-07-07 18:25:41 +0200434 } else {
Pau Espin Pedrold06ec272021-07-30 15:03:21 +0200435 LOGPTBFDL(this, LOGL_DEBUG, "Send downlink assignment on PCH, no TBF exist (IMSI=%s)\n",
Maxc21f0072017-12-15 17:36:45 +0100436 imsi());
Maxa10c3982017-07-07 18:25:41 +0200437
438 /* change state */
Pau Espin Pedrol33e80072021-07-22 19:20:50 +0200439 osmo_fsm_inst_dispatch(this->state_fsm.fi, TBF_EV_ASSIGN_ADD_CCCH, NULL);
Maxa10c3982017-07-07 18:25:41 +0200440
441 /* send immediate assignment */
Pau Espin Pedrol5deac142021-11-12 18:01:50 +0100442 bts_snd_dl_ass(bts, this);
Maxa10c3982017-07-07 18:25:41 +0200443 }
444}
445
Jacob Erlbeck409efa12015-06-12 14:06:09 +0200446void gprs_rlcmac_dl_tbf::schedule_next_frame()
447{
448 struct msgb *msg;
449
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100450 if (llc_frame_length(&m_llc) != 0)
Jacob Erlbeck409efa12015-06-12 14:06:09 +0200451 return;
452
453 /* dequeue next LLC frame, if any */
Pau Espin Pedrol6b1e9512022-04-04 13:45:56 +0200454 msg = llc_queue_dequeue(llc_queue());
Jacob Erlbeck409efa12015-06-12 14:06:09 +0200455 if (!msg)
456 return;
457
Max0fdaa9d2018-01-30 16:03:10 +0100458 LOGPTBFDL(this, LOGL_DEBUG, "Dequeue next LLC (len=%d)\n", msg->len);
Jacob Erlbeck409efa12015-06-12 14:06:09 +0200459
Pau Espin Pedrol4f8384b2022-03-31 19:36:12 +0200460 llc_put_frame(&m_llc, msg->data, msg->len);
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100461 bts_do_rate_ctr_inc(bts, CTR_LLC_FRAME_SCHED);
Jacob Erlbeck409efa12015-06-12 14:06:09 +0200462 msgb_free(msg);
463 m_last_dl_drained_fn = -1;
464}
465
Pau Espin Pedrol2ae83372020-05-18 11:35:35 +0200466int gprs_rlcmac_dl_tbf::create_new_bsn(const uint32_t fn, enum CodingScheme cs)
Daniel Willmannca102af2014-08-08 12:14:12 +0200467{
Jacob Erlbeckfec94d12016-01-12 17:02:49 +0100468 uint8_t *data;
Daniel Willmannca102af2014-08-08 12:14:12 +0200469 gprs_rlc_data *rlc_data;
Daniel Willmannca102af2014-08-08 12:14:12 +0200470 const uint16_t bsn = m_window.v_s();
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100471 gprs_rlc_data_block_info *rdbi;
Jacob Erlbeckfec94d12016-01-12 17:02:49 +0100472 int num_chunks = 0;
473 int write_offset = 0;
474 Encoding::AppendResult ar;
Daniel Willmannca102af2014-08-08 12:14:12 +0200475
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100476 if (llc_frame_length(&m_llc) == 0)
Jacob Erlbeck409efa12015-06-12 14:06:09 +0200477 schedule_next_frame();
478
Pau Espin Pedrol2ae83372020-05-18 11:35:35 +0200479 OSMO_ASSERT(mcs_is_valid(cs));
Jacob Erlbecka700dd92015-06-02 16:00:41 +0200480
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100481 /* length of usable data block (single data unit w/o header) */
Pau Espin Pedrol2ae83372020-05-18 11:35:35 +0200482 const uint8_t block_data_len = mcs_max_data_block_bytes(cs);
Daniel Willmannca102af2014-08-08 12:14:12 +0200483
484 /* now we still have untransmitted LLC data, so we fill mac block */
485 rlc_data = m_rlc.block(bsn);
Pau Espin Pedrol5bb87b82020-05-18 11:02:39 +0200486 data = prepare(rlc_data, block_data_len);
Aravind Sirsikar91495522016-07-12 14:17:12 +0530487 rlc_data->cs_last = cs;
Aravind Sirsikarcf2152b2016-07-13 18:46:17 +0530488 rlc_data->cs_current_trans = cs;
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530489
490 /* Initialise the variable related to DL SPB */
491 rlc_data->spb_status.block_status_dl = EGPRS_RESEG_DL_DEFAULT;
492 rlc_data->cs_init = cs;
493
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100494 rlc_data->len = block_data_len;
Daniel Willmannca102af2014-08-08 12:14:12 +0200495
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100496 rdbi = &(rlc_data->block_info);
497 memset(rdbi, 0, sizeof(*rdbi));
498 rdbi->data_len = block_data_len;
499
500 rdbi->cv = 15; /* Final Block Indicator, set late, if true */
501 rdbi->bsn = bsn; /* Block Sequence Number */
502 rdbi->e = 1; /* Extension bit, maybe set later (1: no extension) */
503
Jacob Erlbeckfec94d12016-01-12 17:02:49 +0100504 do {
505 bool is_final;
Alexander Couzens7fdbf892016-05-21 19:45:23 +0200506 int payload_written = 0;
Jacob Erlbeckfec94d12016-01-12 17:02:49 +0100507
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100508 if (llc_frame_length(&m_llc) == 0) {
Pau Espin Pedrol8afc6ba2021-03-02 13:19:39 +0100509 /* The data just drained, store the current fn */
510 if (m_last_dl_drained_fn < 0)
511 m_last_dl_drained_fn = fn;
512
Pau Espin Pedrol7d0f9a02020-11-27 14:51:27 +0100513 /* It is not clear, when the next real data will
514 * arrive, so request a DL ack/nack now */
515 request_dl_ack();
Alexander Couzens1a506612016-05-24 16:55:30 +0200516
Jacob Erlbeckfec94d12016-01-12 17:02:49 +0100517 int space = block_data_len - write_offset;
Pau Espin Pedrol7d0f9a02020-11-27 14:51:27 +0100518
519 if (num_chunks != 0) {
520 /* Nothing to send, and we already put some data in
521 * rlcmac data block, we are done */
522 LOGPTBFDL(this, LOGL_DEBUG,
523 "LLC queue completely drained and there's "
524 "still %d free bytes in rlcmac data block\n", space);
Pau Espin Pedrolcf6c7122021-03-02 14:15:17 +0100525
526 /* We may need to update fbi in header here
527 * since m_last_dl_drained_fn was updated above
528 * Specially important when X2031 is 0. */
529 is_final = llc_queue_size(llc_queue()) == 0 && !keep_open(fn);
530 if (is_final) {
531 rdbi->cv = 0;
Pau Espin Pedrolc32c4a32021-07-23 18:27:57 +0200532 osmo_fsm_inst_dispatch(this->state_fsm.fi, TBF_EV_LAST_DL_DATA_SENT, NULL);
Pau Espin Pedrolcf6c7122021-03-02 14:15:17 +0100533 }
534
Pau Espin Pedrol7d0f9a02020-11-27 14:51:27 +0100535 if (mcs_is_edge(cs)) {
536 /* in EGPRS there's no M bit, so we need
537 * to flag padding with LI=127 */
538 Encoding::rlc_data_to_dl_append_egprs_li_padding(rdbi,
539 &write_offset,
540 &num_chunks,
541 data);
542 }
543 break;
544 }
545
546 /* Nothing to send from upper layers (LLC), but still
547 * requested to send something to MS to delay the
548 * release of the TBF. See 3GPP TS 44.060 9.3.1a
549 * "Delayed release of downlink Temporary Block Flow" */
Jacob Erlbeckcbb1e702015-03-25 12:21:55 +0100550 /* A header will need to by added, so we just need
551 * space-1 octets */
Pau Espin Pedrol4f8384b2022-03-31 19:36:12 +0200552 llc_put_dummy_frame(&m_llc, space - 1);
Jacob Erlbeckcbb1e702015-03-25 12:21:55 +0100553
Max0524e382018-01-19 18:22:25 +0100554 LOGPTBFDL(this, LOGL_DEBUG,
555 "Empty chunk, added LLC dummy command of size %d, drained_since=%d\n",
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100556 llc_frame_length(&m_llc), frames_since_last_drain(fn));
Jacob Erlbeckcbb1e702015-03-25 12:21:55 +0100557 }
558
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100559 is_final = llc_queue_size(llc_queue()) == 0 && !keep_open(fn);
Jacob Erlbeckcbb1e702015-03-25 12:21:55 +0100560
Jacob Erlbeck5058bd62016-01-13 10:51:25 +0100561 ar = Encoding::rlc_data_to_dl_append(rdbi, cs,
Alexander Couzens7fdbf892016-05-21 19:45:23 +0200562 &m_llc, &write_offset, &num_chunks, data, is_final, &payload_written);
563
564 if (payload_written > 0)
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100565 bts_do_rate_ctr_add(bts, CTR_RLC_DL_PAYLOAD_BYTES, payload_written);
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100566
Jacob Erlbeckfec94d12016-01-12 17:02:49 +0100567 if (ar == Encoding::AR_NEED_MORE_BLOCKS)
568 break;
569
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100570 LOGPTBFDL(this, LOGL_DEBUG, "Complete DL frame, len=%d\n", llc_frame_length(&m_llc));
571 gprs_rlcmac_dl_bw(this, llc_frame_length(&m_llc));
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100572 bts_do_rate_ctr_add(bts, CTR_LLC_DL_BYTES, llc_frame_length(&m_llc));
Pau Espin Pedrol4f8384b2022-03-31 19:36:12 +0200573 llc_reset(&m_llc);
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100574
Jacob Erlbeckfec94d12016-01-12 17:02:49 +0100575 if (is_final) {
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100576 request_dl_ack();
Pau Espin Pedrolc32c4a32021-07-23 18:27:57 +0200577 osmo_fsm_inst_dispatch(this->state_fsm.fi, TBF_EV_LAST_DL_DATA_SENT, NULL);
Daniel Willmannca102af2014-08-08 12:14:12 +0200578 }
Jacob Erlbeckfec94d12016-01-12 17:02:49 +0100579
580 /* dequeue next LLC frame, if any */
581 schedule_next_frame();
582 } while (ar == Encoding::AR_COMPLETED_SPACE_LEFT);
583
Max0524e382018-01-19 18:22:25 +0100584 LOGPTBFDL(this, LOGL_DEBUG, "data block (BSN %d, %s): %s\n",
Max136ebcc2019-03-05 14:59:03 +0100585 bsn, mcs_name(rlc_data->cs_last),
Max0524e382018-01-19 18:22:25 +0100586 osmo_hexdump(rlc_data->block, block_data_len));
Daniel Willmannca102af2014-08-08 12:14:12 +0200587 /* raise send state and set ack state array */
588 m_window.m_v_b.mark_unacked(bsn);
589 m_window.increment_send();
590
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100591 return bsn;
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100592}
593
Daniel Willmannca102af2014-08-08 12:14:12 +0200594struct msgb *gprs_rlcmac_dl_tbf::create_dl_acked_block(
595 const uint32_t fn, const uint8_t ts,
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100596 int index, int index2)
Daniel Willmannca102af2014-08-08 12:14:12 +0200597{
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100598 uint8_t *msg_data;
Daniel Willmannca102af2014-08-08 12:14:12 +0200599 struct msgb *dl_msg;
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100600 unsigned msg_len;
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100601 /* TODO: support MCS-7 - MCS-9, where data_block_idx can be 1 */
Maxb3a17d62017-12-21 12:11:33 +0100602 uint8_t data_block_idx = 0;
Jacob Erlbeckf2694b72016-01-26 21:46:26 +0100603 unsigned int rrbp;
604 uint32_t new_poll_fn;
605 int rc;
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100606 bool is_final = false;
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100607 gprs_rlc_data_info rlc;
Pau Espin Pedrol2ae83372020-05-18 11:35:35 +0200608 enum CodingScheme cs;
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100609 int bsns[ARRAY_SIZE(rlc.block_info)];
610 unsigned num_bsns;
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100611 bool need_padding = false;
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530612 enum egprs_rlcmac_dl_spb spb = EGPRS_RLCMAC_DL_NO_RETX;
613 unsigned int spb_status = get_egprs_dl_spb_status(index);
Neels Hofmeyrb6091902017-02-08 16:49:20 +0100614
615 enum egprs_puncturing_values punct[2] = {
616 EGPRS_PS_INVALID, EGPRS_PS_INVALID
617 };
618 osmo_static_assert(ARRAY_SIZE(rlc.block_info) == 2,
619 rlc_block_info_size_is_two);
620
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100621 /*
622 * TODO: This is an experimental work-around to put 2 BSN into
623 * MSC-7 to MCS-9 encoded messages. It just sends the same BSN
624 * twice in the block. The cs should be derived from the TBF's
625 * current CS such that both BSNs (that must be compatible) can
626 * be put into the data area, even if the resulting CS is higher than
627 * the current limit.
628 */
Aravind Sirsikarcf2152b2016-07-13 18:46:17 +0530629 cs = m_rlc.block(index)->cs_current_trans;
Maxd4a39292019-03-13 18:44:20 +0100630 enum CodingScheme cs_init = m_rlc.block(index)->cs_init;
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100631 bsns[0] = index;
632 num_bsns = 1;
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100633
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100634 if (index2 >= 0) {
635 bsns[num_bsns] = index2;
636 num_bsns += 1;
637 }
638
Mrinal Mishraf86307e2016-11-10 18:16:30 +0530639 update_coding_scheme_counter_dl(cs);
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530640 /*
641 * if the intial mcs is 8 and retransmission mcs is either 6 or 3
642 * we have to include the padding of 6 octets in first segment
643 */
Maxd4a39292019-03-13 18:44:20 +0100644 if ((cs_init == MCS8) &&
645 (cs == MCS6 || cs == MCS3)) {
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530646 if (spb_status == EGPRS_RESEG_DL_DEFAULT ||
Maxd4a39292019-03-13 18:44:20 +0100647 spb_status == EGPRS_RESEG_SECOND_SEG_SENT)
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530648 need_padding = true;
649 } else if (num_bsns == 1) {
Jacob Erlbeckbe881c02016-02-03 20:44:46 +0100650 /* TODO: remove the conditional when MCS-6 padding isn't
651 * failing to be decoded by MEs anymore */
Aravind Sirsikarcf2152b2016-07-13 18:46:17 +0530652 /* TODO: support of MCS-8 -> MCS-6 transition should be
653 * handled
654 * Refer commit be881c028fc4da00c4046ecd9296727975c206a3
655 * dated 2016-02-07 23:45:40 (UTC)
656 */
Pau Espin Pedrol2ae83372020-05-18 11:35:35 +0200657 if (cs != MCS8)
658 mcs_dec_to_single_block(&cs, &need_padding);
Jacob Erlbeckbe881c02016-02-03 20:44:46 +0100659 }
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100660
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530661 spb = get_egprs_dl_spb(index);
662
Max0524e382018-01-19 18:22:25 +0100663 LOGPTBFDL(this, LOGL_DEBUG, "need_padding %d spb_status %d spb %d (BSN1 %d BSN2 %d)\n",
664 need_padding, spb_status, spb, index, index2);
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530665
666 gprs_rlc_data_info_init_dl(&rlc, cs, need_padding, spb);
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100667
668 rlc.usf = 7; /* will be set at scheduler */
669 rlc.pr = 0; /* FIXME: power reduction */
670 rlc.tfi = m_tfi; /* TFI */
671
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100672 /* return data block(s) as message */
Pau Espin Pedrol2ae83372020-05-18 11:35:35 +0200673 msg_len = mcs_size_dl(cs);
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100674 dl_msg = msgb_alloc(msg_len, "rlcmac_dl_data");
675 if (!dl_msg)
676 return NULL;
677
678 msg_data = msgb_put(dl_msg, msg_len);
679
Aravind Sirsikarb1191982016-08-26 18:13:10 +0530680 OSMO_ASSERT(rlc.num_data_blocks <= ARRAY_SIZE(rlc.block_info));
681 OSMO_ASSERT(rlc.num_data_blocks > 0);
682
Max0524e382018-01-19 18:22:25 +0100683 LOGPTBFDL(this, LOGL_DEBUG, "Copying %u RLC blocks, %u BSNs\n", rlc.num_data_blocks, num_bsns);
Max5759a192017-09-08 12:23:12 +0200684
Maxb3a17d62017-12-21 12:11:33 +0100685 /* Copy block(s) to RLC message: the num_data_blocks cannot be more than 2 - see assert above */
686 for (data_block_idx = 0; data_block_idx < OSMO_MIN(rlc.num_data_blocks, 2);
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100687 data_block_idx++)
688 {
689 int bsn;
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100690 uint8_t *block_data;
691 gprs_rlc_data_block_info *rdbi, *block_info;
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530692 enum egprs_rlc_dl_reseg_bsn_state reseg_status;
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100693
694 /* Check if there are more blocks than BSNs */
695 if (data_block_idx < num_bsns)
696 bsn = bsns[data_block_idx];
697 else
698 bsn = bsns[0];
699
Aravind Sirsikar79522822016-03-23 18:29:47 +0530700 /* Get current puncturing scheme from block */
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530701
702 m_rlc.block(bsn)->next_ps = gprs_get_punct_scheme(
Aravind Sirsikar79522822016-03-23 18:29:47 +0530703 m_rlc.block(bsn)->next_ps,
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530704 m_rlc.block(bsn)->cs_last, cs, spb);
Aravind Sirsikar79522822016-03-23 18:29:47 +0530705
Max8a8e0fb2019-03-25 16:32:50 +0100706 if (mcs_is_edge(cs)) {
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530707 OSMO_ASSERT(m_rlc.block(bsn)->next_ps >= EGPRS_PS_1);
708 OSMO_ASSERT(m_rlc.block(bsn)->next_ps <= EGPRS_PS_3);
Aravind Sirsikar79522822016-03-23 18:29:47 +0530709 }
Maxb3a17d62017-12-21 12:11:33 +0100710
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530711 punct[data_block_idx] = m_rlc.block(bsn)->next_ps;
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100712
713 rdbi = &rlc.block_info[data_block_idx];
714 block_info = &m_rlc.block(bsn)->block_info;
715
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530716 /*
717 * get data and header from current block
718 * function returns the reseg status
Aravind Sirsikar79522822016-03-23 18:29:47 +0530719 */
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530720 reseg_status = egprs_dl_get_data(bsn, &block_data);
721 m_rlc.block(bsn)->spb_status.block_status_dl = reseg_status;
722
723 /*
724 * If it is first segment of the split block set the state of
725 * bsn to nacked. If it is the first segment dont update the
726 * next ps value of bsn. since next segment also needs same cps
727 */
728 if (spb == EGPRS_RLCMAC_DL_FIRST_SEG)
729 m_window.m_v_b.mark_nacked(bsn);
730 else {
731 /*
732 * TODO: Need to handle 2 same bsns
733 * in header type 1
734 */
735 gprs_update_punct_scheme(&m_rlc.block(bsn)->next_ps,
736 cs);
737 }
Aravind Sirsikar79522822016-03-23 18:29:47 +0530738
Aravind Sirsikarcf2152b2016-07-13 18:46:17 +0530739 m_rlc.block(bsn)->cs_last = cs;
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100740 rdbi->e = block_info->e;
741 rdbi->cv = block_info->cv;
742 rdbi->bsn = bsn;
743 is_final = is_final || rdbi->cv == 0;
744
Max0524e382018-01-19 18:22:25 +0100745 LOGPTBFDL(this, LOGL_DEBUG, "Copying data unit %d (BSN %d)\n",
746 data_block_idx, bsn);
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100747
748 Encoding::rlc_copy_from_aligned_buffer(&rlc, data_block_idx,
749 msg_data, block_data);
750 }
751
Neels Hofmeyr49b83ec2017-02-08 15:47:19 +0100752 /* Calculate CPS only for EGPRS case */
Max8a8e0fb2019-03-25 16:32:50 +0100753 if (mcs_is_edge(cs))
Neels Hofmeyr49b83ec2017-02-08 15:47:19 +0100754 rlc.cps = gprs_rlc_mcs_cps(cs, punct[0], punct[1], need_padding);
Daniel Willmannca102af2014-08-08 12:14:12 +0200755
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +0100756 /* If the TBF has just started, relate frames_since_last_poll to the
757 * current fn */
758 if (m_last_dl_poll_fn < 0)
759 m_last_dl_poll_fn = fn;
760
Pau Espin Pedrol405d2d12021-07-29 18:14:07 +0200761 /* poll after POLL_ACK_AFTER_FRAMES frames, or when final block is tx or
762 * when last polled DL ACK/NACK was lost. */
763 if (need_poll_for_dl_ack_nack()) {
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100764 if (m_dl_ack_requested) {
Max0524e382018-01-19 18:22:25 +0100765 LOGPTBFDL(this, LOGL_DEBUG,
Pau Espin Pedrol30f66172019-12-04 18:07:49 +0100766 "Scheduling Ack/Nack polling, because it was requested explicitly "
Max0524e382018-01-19 18:22:25 +0100767 "(e.g. first final block sent).\n");
Pau Espin Pedrol405d2d12021-07-29 18:14:07 +0200768 } else if (state_fsm.state_flags & (1 << GPRS_RLCMAC_FLAG_TO_DL_ACK)) {
Max0524e382018-01-19 18:22:25 +0100769 LOGPTBFDL(this, LOGL_DEBUG,
770 "Scheduling Ack/Nack polling, because polling timed out.\n");
Daniel Willmannca102af2014-08-08 12:14:12 +0200771 } else {
Max0524e382018-01-19 18:22:25 +0100772 LOGPTBFDL(this, LOGL_DEBUG,
773 "Scheduling Ack/Nack polling, because %d blocks sent.\n",
Pau Espin Pedrol405d2d12021-07-29 18:14:07 +0200774 POLL_ACK_AFTER_FRAMES);
Daniel Willmannca102af2014-08-08 12:14:12 +0200775 }
Jacob Erlbeckf2694b72016-01-26 21:46:26 +0100776
777 rc = check_polling(fn, ts, &new_poll_fn, &rrbp);
778 if (rc >= 0) {
Pau Espin Pedrol86580e12021-03-29 18:15:30 +0200779 set_polling(new_poll_fn, ts, PDCH_ULC_POLL_DL_ACK);
Pau Espin Pedrola161bf42021-07-30 13:42:06 +0200780 LOGPTBFDL(this, LOGL_DEBUG,
781 "Scheduled DL Acknowledgement polling on PACCH (FN=%d, TS=%d)\n",
782 new_poll_fn, ts);
Jacob Erlbeckf2694b72016-01-26 21:46:26 +0100783
Daniel Willmannca102af2014-08-08 12:14:12 +0200784 m_tx_counter = 0;
785 /* start timer whenever we send the final block */
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100786 if (is_final)
Pau Espin Pedrol28f160e2019-09-05 14:48:35 +0200787 T_START(this, T3191, 3191, "final block (DL-TBF)", true);
Daniel Willmannca102af2014-08-08 12:14:12 +0200788
Pau Espin Pedrol33e80072021-07-22 19:20:50 +0200789 state_fsm.state_flags &= ~(1 << GPRS_RLCMAC_FLAG_TO_DL_ACK); /* clear poll timeout flag */
Daniel Willmannefd5dbb2014-08-25 16:20:23 +0200790
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100791 /* Clear request flag */
792 m_dl_ack_requested = false;
793
Daniel Willmannca102af2014-08-08 12:14:12 +0200794 /* set polling in header */
Jacob Erlbeckf2694b72016-01-26 21:46:26 +0100795 rlc.rrbp = rrbp;
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100796 rlc.es_p = 1; /* Polling */
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +0100797
Pau Espin Pedrol58046e42021-03-29 19:01:13 +0200798 m_last_dl_poll_fn = new_poll_fn;
Jacob Erlbeck16d29c72015-08-24 13:30:39 +0200799
Max0524e382018-01-19 18:22:25 +0100800 LOGPTBFDL(this, LOGL_INFO,
801 "Scheduled Ack/Nack polling on FN=%d, TS=%d\n",
Pau Espin Pedrol16e16782021-03-29 19:10:19 +0200802 new_poll_fn, ts);
Daniel Willmannca102af2014-08-08 12:14:12 +0200803 }
804 }
805
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100806 Encoding::rlc_write_dl_data_header(&rlc, msg_data);
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100807
Max0524e382018-01-19 18:22:25 +0100808 LOGPTBFDL(this, LOGL_DEBUG, "msg block (BSN %d, %s%s): %s\n",
Max136ebcc2019-03-05 14:59:03 +0100809 index, mcs_name(cs),
Max0524e382018-01-19 18:22:25 +0100810 need_padding ? ", padded" : "",
811 msgb_hexdump(dl_msg));
Jacob Erlbeck3a3b6a72016-01-11 16:15:45 +0100812
Daniel Willmannca102af2014-08-08 12:14:12 +0200813 /* Increment TX-counter */
814 m_tx_counter++;
815
Daniel Willmannca102af2014-08-08 12:14:12 +0200816 return dl_msg;
817}
818
Jacob Erlbeck93c55d02015-12-23 16:29:07 +0100819static uint16_t bitnum_to_bsn(int bitnum, uint16_t ssn)
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200820{
Jacob Erlbeck93c55d02015-12-23 16:29:07 +0100821 return ssn - 1 - bitnum;
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200822}
823
Jacob Erlbeck2db0f082015-09-07 18:49:00 +0200824int gprs_rlcmac_dl_tbf::analyse_errors(char *show_rbb, uint8_t ssn,
825 ana_result *res)
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200826{
827 gprs_rlc_data *rlc_data;
828 uint16_t lost = 0, received = 0, skipped = 0;
Jacob Erlbeckb41262f2016-02-05 17:13:24 +0100829 char info[RLC_MAX_WS + 1];
830 memset(info, '.', m_window.ws());
831 info[m_window.ws()] = 0;
Jacob Erlbecka17fccb2015-06-04 16:52:23 +0200832 uint16_t bsn = 0;
Jacob Erlbeck2db0f082015-09-07 18:49:00 +0200833 unsigned received_bytes = 0, lost_bytes = 0;
834 unsigned received_packets = 0, lost_packets = 0;
Jacob Erlbeckb41262f2016-02-05 17:13:24 +0100835 unsigned num_blocks = strlen(show_rbb);
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200836
aravind sirsikarfb41afa2016-11-02 15:48:00 +0530837 unsigned distance = m_window.distance();
838
839 num_blocks = num_blocks > distance
840 ? distance : num_blocks;
841
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200842 /* SSN - 1 is in range V(A)..V(S)-1 */
Jacob Erlbeckb41262f2016-02-05 17:13:24 +0100843 for (unsigned int bitpos = 0; bitpos < num_blocks; bitpos++) {
844 bool is_received;
845 int index = num_blocks - 1 - bitpos;
846
847 is_received = (index >= 0 && show_rbb[index] == 'R');
Jacob Erlbeck2db0f082015-09-07 18:49:00 +0200848
Jacob Erlbeck93c55d02015-12-23 16:29:07 +0100849 bsn = m_window.mod_sns(bitnum_to_bsn(bitpos, ssn));
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200850
Jacob Erlbeck93c55d02015-12-23 16:29:07 +0100851 if (bsn == m_window.mod_sns(m_window.v_a() - 1)) {
Jacob Erlbecka17fccb2015-06-04 16:52:23 +0200852 info[bitpos] = '$';
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200853 break;
Jacob Erlbecka17fccb2015-06-04 16:52:23 +0200854 }
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200855
856 rlc_data = m_rlc.block(bsn);
Jacob Erlbecka17fccb2015-06-04 16:52:23 +0200857 if (!rlc_data) {
858 info[bitpos] = '0';
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200859 continue;
Jacob Erlbecka17fccb2015-06-04 16:52:23 +0200860 }
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200861
Jacob Erlbeck2db0f082015-09-07 18:49:00 +0200862 /* Get general statistics */
863 if (is_received && !m_window.m_v_b.is_acked(bsn)) {
864 received_packets += 1;
865 received_bytes += rlc_data->len;
866 } else if (!is_received && !m_window.m_v_b.is_nacked(bsn)) {
867 lost_packets += 1;
868 lost_bytes += rlc_data->len;
869 }
870
871 /* Get statistics for current CS */
872
Aravind Sirsikar91495522016-07-12 14:17:12 +0530873 if (rlc_data->cs_last != current_cs()) {
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200874 /* This block has already been encoded with a different
875 * CS, so it doesn't help us to decide, whether the
876 * current CS is ok. Ignore it. */
Jacob Erlbecka17fccb2015-06-04 16:52:23 +0200877 info[bitpos] = 'x';
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200878 skipped += 1;
879 continue;
880 }
881
Jacob Erlbeck2db0f082015-09-07 18:49:00 +0200882 if (is_received) {
Jacob Erlbecka17fccb2015-06-04 16:52:23 +0200883 if (!m_window.m_v_b.is_acked(bsn)) {
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200884 received += 1;
Jacob Erlbecka17fccb2015-06-04 16:52:23 +0200885 info[bitpos] = 'R';
886 } else {
887 info[bitpos] = 'r';
888 }
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200889 } else {
Jacob Erlbecka17fccb2015-06-04 16:52:23 +0200890 info[bitpos] = 'L';
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200891 lost += 1;
892 }
893 }
894
Max0524e382018-01-19 18:22:25 +0100895 LOGPTBFDL(this, LOGL_DEBUG,
896 "DL analysis, range=%d:%d, lost=%d, recv=%d, skipped=%d, bsn=%d, info='%s'\n",
897 m_window.v_a(), m_window.v_s(), lost, received, skipped, bsn, info);
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200898
Jacob Erlbeck2db0f082015-09-07 18:49:00 +0200899 res->received_packets = received_packets;
900 res->lost_packets = lost_packets;
901 res->received_bytes = received_bytes;
902 res->lost_bytes = lost_bytes;
903
Jacob Erlbeck144a1d02015-06-04 16:51:44 +0200904 if (lost + received <= 1)
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200905 return -1;
906
907 return lost * 100 / (lost + received);
908}
909
Pau Espin Pedrolb3f23972020-10-23 21:00:23 +0200910gprs_rlc_window *gprs_rlcmac_dl_tbf::window()
Maxea98b7d2018-01-04 15:13:27 +0100911{
912 return &m_window;
913}
914
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100915int gprs_rlcmac_dl_tbf::update_window(unsigned first_bsn,
916 const struct bitvec *rbb)
917{
aravind sirsikarfb41afa2016-11-02 15:48:00 +0530918 unsigned dist;
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100919 uint16_t lost = 0, received = 0;
920 char show_v_b[RLC_MAX_SNS + 1];
921 char show_rbb[RLC_MAX_SNS + 1];
922 int error_rate;
923 struct ana_result ana_res;
aravind sirsikarfb41afa2016-11-02 15:48:00 +0530924 dist = m_window.distance();
925 unsigned num_blocks = rbb->cur_bit > dist
926 ? dist : rbb->cur_bit;
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100927 unsigned behind_last_bsn = m_window.mod_sns(first_bsn + num_blocks);
928
929 Decoding::extract_rbb(rbb, show_rbb);
930 /* show received array in debug */
Max0524e382018-01-19 18:22:25 +0100931 LOGPTBFDL(this, LOGL_DEBUG,
932 "ack: (BSN=%d)\"%s\"(BSN=%d) R=ACK I=NACK\n",
933 first_bsn, show_rbb, m_window.mod_sns(behind_last_bsn - 1));
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100934
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100935 error_rate = analyse_errors(show_rbb, behind_last_bsn, &ana_res);
936
Pau Espin Pedrole8dcf642021-01-14 13:17:01 +0100937 if (the_pcu->vty.cs_adj_enabled && ms())
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100938 ms_update_error_rate(ms(), this, error_rate);
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100939
940 m_window.update(bts, rbb, first_bsn, &lost, &received);
Pau Espin Pedrol9c1db172021-06-04 17:05:51 +0200941 rate_ctr_add(rate_ctr_group_get_ctr(m_ctrs, TBF_CTR_RLC_NACKED), lost);
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100942
943 /* report lost and received packets */
944 gprs_rlcmac_received_lost(this, received, lost);
945
946 /* Used to measure the leak rate */
947 gprs_bssgp_update_bytes_received(ana_res.received_bytes,
948 ana_res.received_packets + ana_res.lost_packets);
949
950 /* raise V(A), if possible */
951 m_window.raise(m_window.move_window());
952
953 /* show receive state array in debug (V(A)..V(S)-1) */
954 m_window.show_state(show_v_b);
Max0524e382018-01-19 18:22:25 +0100955 LOGPTBFDL(this, LOGL_DEBUG,
956 "V(B): (V(A)=%d)\"%s\"(V(S)-1=%d) A=Acked N=Nacked U=Unacked X=Resend-Unacked I=Invalid\n",
957 m_window.v_a(), show_v_b, m_window.v_s_mod(-1));
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100958 return 0;
959}
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200960
Pau Espin Pedrolefcb0462021-07-26 12:33:39 +0200961int gprs_rlcmac_dl_tbf::rcvd_dl_final_ack()
Daniel Willmannca102af2014-08-08 12:14:12 +0200962{
Pau Espin Pedrolf48de622021-07-30 14:48:06 +0200963 uint16_t received;
964
Pau Espin Pedrolefcb0462021-07-26 12:33:39 +0200965 osmo_fsm_inst_dispatch(this->state_fsm.fi, TBF_EV_FINAL_ACK_RECVD, NULL);
Pau Espin Pedrolf48de622021-07-30 14:48:06 +0200966
967 /* range V(A)..V(S)-1 */
968 received = m_window.count_unacked();
969 /* report all outstanding packets as received */
970 gprs_rlcmac_received_lost(this, received, 0);
971 m_tx_counter = 0;
972 m_window.reset();
Jacob Erlbeck91ff7d12015-09-01 11:20:29 +0200973
974 /* check for LLC PDU in the LLC Queue */
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100975 if (llc_queue_size(llc_queue()) > 0)
Jacob Erlbeck91ff7d12015-09-01 11:20:29 +0200976 /* we have more data so we will re-use this tbf */
977 establish_dl_tbf_on_pacch();
978
979 return 0;
980}
981
Max7df82d42017-12-15 11:14:30 +0100982int gprs_rlcmac_dl_tbf::rcvd_dl_ack(bool final_ack, unsigned first_bsn,
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100983 struct bitvec *rbb)
984{
Jacob Erlbeckb4beb542016-01-15 13:38:31 +0100985 int rc;
Maxc21f0072017-12-15 17:36:45 +0100986 LOGPTBFDL(this, LOGL_DEBUG, "downlink acknowledge\n");
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100987
Pau Espin Pedrolfbc1baa2021-07-28 21:59:00 +0200988 state_fsm.state_flags |= (1 << GPRS_RLCMAC_FLAG_DL_ACK);
989 state_fsm.state_flags &= ~(1 << GPRS_RLCMAC_FLAG_TO_DL_ACK);
990
991 /* reset N3105 */
992 n_reset(N3105);
993 t_stop(T3191, "ACK/NACK received");
994
Jacob Erlbeckb4beb542016-01-15 13:38:31 +0100995 rc = update_window(first_bsn, rbb);
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100996
Jacob Erlbeckb4beb542016-01-15 13:38:31 +0100997 if (final_ack) {
Max0524e382018-01-19 18:22:25 +0100998 LOGPTBFDL(this, LOGL_DEBUG, "Final ACK received.\n");
Pau Espin Pedrolefcb0462021-07-26 12:33:39 +0200999 rc = rcvd_dl_final_ack();
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +02001000 } else if (state_is(TBF_ST_FINISHED) && m_window.window_empty()) {
Max0524e382018-01-19 18:22:25 +01001001 LOGPTBFDL(this, LOGL_NOTICE,
1002 "Received acknowledge of all blocks, but without final ack indication (don't worry)\n");
Jacob Erlbeckb4beb542016-01-15 13:38:31 +01001003 }
1004
1005 return rc;
Jacob Erlbeckeb08f862016-02-05 17:07:12 +01001006}
1007
Daniel Willmannca102af2014-08-08 12:14:12 +02001008bool gprs_rlcmac_dl_tbf::dl_window_stalled() const
1009{
1010 return m_window.window_stalled();
1011}
1012
Jacob Erlbeckeceb9102015-03-20 14:41:50 +01001013void gprs_rlcmac_dl_tbf::request_dl_ack()
1014{
1015 m_dl_ack_requested = true;
1016}
1017
Pau Espin Pedrol14beef62022-10-26 19:44:07 +02001018void tbf_dl_request_dl_ack(struct gprs_rlcmac_dl_tbf *dl_tbf) {
1019 dl_tbf->request_dl_ack();
1020}
1021
Pau Espin Pedrol405d2d12021-07-29 18:14:07 +02001022/* Does this DL TBF require to poll the MS for DL ACK/NACK? */
1023bool gprs_rlcmac_dl_tbf::need_poll_for_dl_ack_nack() const
Jacob Erlbeckeceb9102015-03-20 14:41:50 +01001024{
Pau Espin Pedrol405d2d12021-07-29 18:14:07 +02001025 /* poll after POLL_ACK_AFTER_FRAMES frames, or when final block is tx or
1026 * when last polled DL ACK/NACK was lost. */
Pau Espin Pedrol33e80072021-07-22 19:20:50 +02001027 return state_fsm.state_flags & (1 << GPRS_RLCMAC_FLAG_TO_DL_ACK) ||
Jacob Erlbeckeceb9102015-03-20 14:41:50 +01001028 m_tx_counter >= POLL_ACK_AFTER_FRAMES ||
1029 m_dl_ack_requested;
1030}
1031
1032bool gprs_rlcmac_dl_tbf::have_data() const
1033{
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +01001034 return llc_chunk_size(&m_llc) > 0 ||
1035 (llc_queue_size(llc_queue()) > 0);
Jacob Erlbeckeceb9102015-03-20 14:41:50 +01001036}
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +01001037
Max9dabfa22017-05-16 16:10:45 +02001038static inline int frames_since_last(int32_t last, unsigned fn)
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +01001039{
Max9dabfa22017-05-16 16:10:45 +02001040 unsigned wrapped = (fn + GSM_MAX_FN - last) % GSM_MAX_FN;
1041
1042 if (last < 0)
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +01001043 return -1;
1044
Max9dabfa22017-05-16 16:10:45 +02001045 if (wrapped < GSM_MAX_FN/2)
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +01001046 return wrapped;
Max9dabfa22017-05-16 16:10:45 +02001047
1048 return wrapped - GSM_MAX_FN;
1049}
1050
1051int gprs_rlcmac_dl_tbf::frames_since_last_poll(unsigned fn) const
1052{
1053 return frames_since_last(m_last_dl_poll_fn, fn);
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +01001054}
1055
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +01001056int gprs_rlcmac_dl_tbf::frames_since_last_drain(unsigned fn) const
1057{
Max9dabfa22017-05-16 16:10:45 +02001058 return frames_since_last(m_last_dl_drained_fn, fn);
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +01001059}
1060
1061bool gprs_rlcmac_dl_tbf::keep_open(unsigned fn) const
1062{
1063 int keep_time_frames;
Pau Espin Pedrol2b5c6292019-09-09 13:41:00 +02001064 unsigned long dl_tbf_idle_msec;
Pau Espin Pedrol5b9d0bb2021-03-02 12:53:58 +01001065 int since_last_drain;
1066 bool keep;
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +01001067
Pau Espin Pedrol924aaad2021-01-14 12:01:42 +01001068 dl_tbf_idle_msec = osmo_tdef_get(the_pcu->T_defs, -2031, OSMO_TDEF_MS, -1);
Pau Espin Pedrol2b5c6292019-09-09 13:41:00 +02001069 if (dl_tbf_idle_msec == 0)
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +01001070 return false;
1071
Pau Espin Pedrol2b5c6292019-09-09 13:41:00 +02001072 keep_time_frames = msecs_to_frames(dl_tbf_idle_msec);
Pau Espin Pedrol5b9d0bb2021-03-02 12:53:58 +01001073 since_last_drain = frames_since_last_drain(fn);
1074 keep = since_last_drain <= keep_time_frames;
1075
1076 if (since_last_drain >= 0)
1077 LOGPTBFDL(this, LOGL_DEBUG, "Keep idle TBF open: %d/%d -> %s\n",
1078 since_last_drain, keep_time_frames, keep ? "yes" : "no");
1079 return keep;
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +01001080}
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301081
1082/*
1083 * This function returns the pointer to data which needs
1084 * to be copied. Also updates the status of the block related to
1085 * Split block handling in the RLC/MAC block.
1086 */
1087enum egprs_rlc_dl_reseg_bsn_state
1088 gprs_rlcmac_dl_tbf::egprs_dl_get_data(int bsn, uint8_t **block_data)
1089{
1090 gprs_rlc_data *rlc_data = m_rlc.block(bsn);
1091 egprs_rlc_dl_reseg_bsn_state *block_status_dl =
1092 &rlc_data->spb_status.block_status_dl;
1093
Pau Espin Pedrol2ae83372020-05-18 11:35:35 +02001094 enum CodingScheme cs_init = rlc_data->cs_init;
1095 enum CodingScheme cs_current_trans = rlc_data->cs_current_trans;
Maxd4a39292019-03-13 18:44:20 +01001096
Pau Espin Pedrol2ae83372020-05-18 11:35:35 +02001097 enum HeaderType ht_cs_init = mcs_header_type(rlc_data->cs_init);
1098 enum HeaderType ht_cs_current_trans = mcs_header_type(rlc_data->cs_current_trans);
Maxd4a39292019-03-13 18:44:20 +01001099
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301100 *block_data = &rlc_data->block[0];
1101
1102 /*
1103 * Table 10.3a.0.1 of 44.060
1104 * MCS6,9: second segment starts at 74/2 = 37
1105 * MCS5,7: second segment starts at 56/2 = 28
1106 * MCS8: second segment starts at 31
1107 * MCS4: second segment starts at 44/2 = 22
1108 */
Maxd4a39292019-03-13 18:44:20 +01001109 if (ht_cs_current_trans == HEADER_EGPRS_DATA_TYPE_3) {
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301110 if (*block_status_dl == EGPRS_RESEG_FIRST_SEG_SENT) {
Maxd4a39292019-03-13 18:44:20 +01001111 switch (cs_init) {
Maxbea2edb2019-03-06 17:04:59 +01001112 case MCS6 :
1113 case MCS9 :
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301114 *block_data = &rlc_data->block[37];
1115 break;
Maxbea2edb2019-03-06 17:04:59 +01001116 case MCS7 :
1117 case MCS5 :
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301118 *block_data = &rlc_data->block[28];
1119 break;
Maxbea2edb2019-03-06 17:04:59 +01001120 case MCS8 :
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301121 *block_data = &rlc_data->block[31];
1122 break;
Maxbea2edb2019-03-06 17:04:59 +01001123 case MCS4 :
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301124 *block_data = &rlc_data->block[22];
1125 break;
1126 default:
Max0524e382018-01-19 18:22:25 +01001127 LOGPTBFDL(this, LOGL_ERROR,
1128 "FIXME: Software error: hit invalid condition. "
1129 "headerType(%d) blockstatus(%d) cs(%s) PLEASE FIX!\n",
Maxd4a39292019-03-13 18:44:20 +01001130 ht_cs_current_trans,
Max136ebcc2019-03-05 14:59:03 +01001131 *block_status_dl, mcs_name(cs_init));
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301132 break;
1133
1134 }
1135 return EGPRS_RESEG_SECOND_SEG_SENT;
Maxd4a39292019-03-13 18:44:20 +01001136 } else if ((ht_cs_init == HEADER_EGPRS_DATA_TYPE_1) ||
1137 (ht_cs_init == HEADER_EGPRS_DATA_TYPE_2)) {
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301138 return EGPRS_RESEG_FIRST_SEG_SENT;
Maxd4a39292019-03-13 18:44:20 +01001139 } else if ((cs_init == MCS4) &&
1140 (cs_current_trans == MCS1)) {
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301141 return EGPRS_RESEG_FIRST_SEG_SENT;
1142 }
1143 }
1144 return EGPRS_RESEG_DL_DEFAULT;
1145}
1146
1147/*
1148 * This function returns the status of split block
1149 * for RLC/MAC block.
1150 */
1151unsigned int gprs_rlcmac_dl_tbf::get_egprs_dl_spb_status(const int bsn)
1152{
1153 const gprs_rlc_data *rlc_data = m_rlc.block(bsn);
1154
1155 return rlc_data->spb_status.block_status_dl;
1156}
1157
1158/*
1159 * This function returns the spb value to be sent OTA
1160 * for RLC/MAC block.
1161 */
1162enum egprs_rlcmac_dl_spb gprs_rlcmac_dl_tbf::get_egprs_dl_spb(const int bsn)
1163{
1164 struct gprs_rlc_data *rlc_data = m_rlc.block(bsn);
Maxd4a39292019-03-13 18:44:20 +01001165 egprs_rlc_dl_reseg_bsn_state block_status_dl = rlc_data->spb_status.block_status_dl;
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301166
Pau Espin Pedrol2ae83372020-05-18 11:35:35 +02001167 enum CodingScheme cs_init = rlc_data->cs_init;
1168 enum CodingScheme cs_current_trans = rlc_data->cs_current_trans;
Maxd4a39292019-03-13 18:44:20 +01001169
Pau Espin Pedrol2ae83372020-05-18 11:35:35 +02001170 enum HeaderType ht_cs_init = mcs_header_type(rlc_data->cs_init);
1171 enum HeaderType ht_cs_current_trans = mcs_header_type(rlc_data->cs_current_trans);
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301172
1173 /* Table 10.4.8b.1 of 44.060 */
Maxd4a39292019-03-13 18:44:20 +01001174 if (ht_cs_current_trans == HEADER_EGPRS_DATA_TYPE_3) {
1175 /*
1176 * if we are sending the second segment the spb should be 3
1177 * otherwise it should be 2
1178 */
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301179 if (block_status_dl == EGPRS_RESEG_FIRST_SEG_SENT) {
sivasankarida7250a2016-12-16 12:57:18 +05301180 /* statistics */
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001181 bts_do_rate_ctr_inc(bts, CTR_SPB_DL_SECOND_SEGMENT);
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301182 return EGPRS_RLCMAC_DL_SEC_SEG;
Maxd4a39292019-03-13 18:44:20 +01001183 } else if ((ht_cs_init == HEADER_EGPRS_DATA_TYPE_1) ||
1184 (ht_cs_init == HEADER_EGPRS_DATA_TYPE_2)) {
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001185 bts_do_rate_ctr_inc(bts, CTR_SPB_DL_FIRST_SEGMENT);
Aravind Sirsikar50b09702016-08-22 17:21:10 +05301186 return EGPRS_RLCMAC_DL_FIRST_SEG;
Maxd4a39292019-03-13 18:44:20 +01001187 } else if ((cs_init == MCS4) &&
1188 (cs_current_trans == MCS1)) {
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;
1191 }
1192 }
1193 /* Non SPB cases 0 is reurned */
1194 return EGPRS_RLCMAC_DL_NO_RETX;
1195}
Aravind Sirsikar8e70bb52016-09-15 17:51:16 +05301196
Max9d7357e2017-12-14 15:02:33 +01001197void gprs_rlcmac_dl_tbf::set_window_size()
Aravind Sirsikar8e70bb52016-09-15 17:51:16 +05301198{
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001199 const struct gprs_rlcmac_bts *b = bts;
Max34513fe2018-12-11 16:47:30 +01001200 uint16_t ws = egprs_window_size(b, dl_slots());
1201
Max0524e382018-01-19 18:22:25 +01001202 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 +01001203 ws, bts->pcu->vty.ws_base, pcu_bitcount(dl_slots()), bts->pcu->vty.ws_pdch);
Aravind Sirsikar8e70bb52016-09-15 17:51:16 +05301204 m_window.set_ws(ws);
1205}
Mrinal Mishraf86307e2016-11-10 18:16:30 +05301206
Maxfb59a932019-03-13 18:40:19 +01001207void gprs_rlcmac_dl_tbf::update_coding_scheme_counter_dl(enum CodingScheme cs)
Mrinal Mishraf86307e2016-11-10 18:16:30 +05301208{
Maxfb59a932019-03-13 18:40:19 +01001209 switch (cs) {
1210 case CS1:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001211 bts_do_rate_ctr_inc(bts, CTR_GPRS_DL_CS1);
Pau Espin Pedrol9c1db172021-06-04 17:05:51 +02001212 rate_ctr_inc(rate_ctr_group_get_ctr(m_dl_gprs_ctrs, TBF_CTR_GPRS_DL_CS1));
Maxfb59a932019-03-13 18:40:19 +01001213 break;
1214 case CS2:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001215 bts_do_rate_ctr_inc(bts, CTR_GPRS_DL_CS2);
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_CS2));
Maxfb59a932019-03-13 18:40:19 +01001217 break;
1218 case CS3:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001219 bts_do_rate_ctr_inc(bts, CTR_GPRS_DL_CS3);
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_CS3));
Maxfb59a932019-03-13 18:40:19 +01001221 break;
1222 case CS4:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001223 bts_do_rate_ctr_inc(bts, CTR_GPRS_DL_CS4);
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_CS4));
Maxfb59a932019-03-13 18:40:19 +01001225 break;
1226 case MCS1:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001227 bts_do_rate_ctr_inc(bts, CTR_EGPRS_DL_MCS1);
Pau Espin Pedrol9c1db172021-06-04 17:05:51 +02001228 rate_ctr_inc(rate_ctr_group_get_ctr(m_dl_egprs_ctrs, TBF_CTR_EGPRS_DL_MCS1));
Maxfb59a932019-03-13 18:40:19 +01001229 break;
1230 case MCS2:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001231 bts_do_rate_ctr_inc(bts, CTR_EGPRS_DL_MCS2);
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_MCS2));
Maxfb59a932019-03-13 18:40:19 +01001233 break;
1234 case MCS3:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001235 bts_do_rate_ctr_inc(bts, CTR_EGPRS_DL_MCS3);
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_MCS3));
Maxfb59a932019-03-13 18:40:19 +01001237 break;
1238 case MCS4:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001239 bts_do_rate_ctr_inc(bts, CTR_EGPRS_DL_MCS4);
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_MCS4));
Maxfb59a932019-03-13 18:40:19 +01001241 break;
1242 case MCS5:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001243 bts_do_rate_ctr_inc(bts, CTR_EGPRS_DL_MCS5);
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_MCS5));
Maxfb59a932019-03-13 18:40:19 +01001245 break;
1246 case MCS6:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001247 bts_do_rate_ctr_inc(bts, CTR_EGPRS_DL_MCS6);
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_MCS6));
Maxfb59a932019-03-13 18:40:19 +01001249 break;
1250 case MCS7:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001251 bts_do_rate_ctr_inc(bts, CTR_EGPRS_DL_MCS7);
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_MCS7));
Maxfb59a932019-03-13 18:40:19 +01001253 break;
1254 case MCS8:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001255 bts_do_rate_ctr_inc(bts, CTR_EGPRS_DL_MCS8);
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_MCS8));
Maxfb59a932019-03-13 18:40:19 +01001257 break;
1258 case MCS9:
Pau Espin Pedrol2182e622021-01-14 16:48:38 +01001259 bts_do_rate_ctr_inc(bts, CTR_EGPRS_DL_MCS9);
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_MCS9));
Maxfb59a932019-03-13 18:40:19 +01001261 break;
1262 default:
1263 LOGPTBFDL(this, LOGL_ERROR, "attempting to update rate counters for unsupported (M)CS %s\n",
1264 mcs_name(cs));
Mrinal Mishraf86307e2016-11-10 18:16:30 +05301265 }
1266}
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +01001267
Pau Espin Pedrolcc30b052022-10-27 15:25:55 +02001268struct gprs_rlcmac_dl_tbf *tbf_as_dl_tbf(struct gprs_rlcmac_tbf *tbf)
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +01001269{
1270 if (tbf && tbf->direction == GPRS_RLCMAC_DL_TBF)
1271 return static_cast<gprs_rlcmac_dl_tbf *>(tbf);
1272 else
1273 return NULL;
1274}
Pau Espin Pedrol32252902021-07-29 16:44:11 +02001275
1276void tbf_dl_trigger_ass(struct gprs_rlcmac_dl_tbf *tbf, struct gprs_rlcmac_tbf *old_tbf)
1277{
1278 return tbf->trigger_ass(old_tbf);
1279}