blob: edaf298711dbb9ca3f14c660415ab0eb47994ecf [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.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 */
21
22#include <bts.h>
23#include <tbf.h>
24#include <rlc.h>
25#include <gprs_rlcmac.h>
26#include <gprs_debug.h>
27#include <gprs_bssgp_pcu.h>
28#include <decoding.h>
29
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +010030#include "pcu_utils.h"
31
Daniel Willmannca102af2014-08-08 12:14:12 +020032extern "C" {
33#include <osmocom/core/msgb.h>
34#include <osmocom/core/talloc.h>
35}
36
37#include <errno.h>
38#include <string.h>
39
40/* After sending these frames, we poll for ack/nack. */
41#define POLL_ACK_AFTER_FRAMES 20
42
43
44static const struct gprs_rlcmac_cs gprs_rlcmac_cs[] = {
45/* frame length data block max payload */
46 { 0, 0, 0 },
47 { 23, 23, 20 }, /* CS-1 */
48 { 34, 33, 30 }, /* CS-2 */
49 { 40, 39, 36 }, /* CS-3 */
50 { 54, 53, 50 }, /* CS-4 */
51};
52
53extern "C" {
54int bssgp_tx_llc_discarded(struct bssgp_bvc_ctx *bctx, uint32_t tlli,
55 uint8_t num_frames, uint32_t num_octets);
56}
57
58static inline void tbf_update_ms_class(struct gprs_rlcmac_tbf *tbf,
59 const uint8_t ms_class)
60{
61 if (!tbf->ms_class && ms_class)
62 tbf->ms_class = ms_class;
63}
64
Jacob Erlbeckd0261b72015-04-02 13:58:09 +020065static void llc_timer_cb(void *_tbf)
66{
67 struct gprs_rlcmac_dl_tbf *tbf = (struct gprs_rlcmac_dl_tbf *)_tbf;
68
69 if (tbf->state_is_not(GPRS_RLCMAC_FLOW))
70 return;
71
72 LOGP(DRLCMAC, LOGL_DEBUG,
73 "%s LLC receive timeout, requesting DL ACK\n", tbf_name(tbf));
74
75 tbf->request_dl_ack();
76}
77
78void gprs_rlcmac_dl_tbf::cleanup()
79{
80 osmo_timer_del(&m_llc_timer);
81}
82
83void gprs_rlcmac_dl_tbf::start_llc_timer()
84{
85 if (bts_data()->llc_idle_ack_csec > 0) {
86 struct timeval tv;
87
88 /* TODO: this ought to be within a constructor */
89 m_llc_timer.data = this;
90 m_llc_timer.cb = &llc_timer_cb;
91
92 csecs_to_timeval(bts_data()->llc_idle_ack_csec, &tv);
93 osmo_timer_schedule(&m_llc_timer, tv.tv_sec, tv.tv_usec);
94 }
95}
96
Daniel Willmannca102af2014-08-08 12:14:12 +020097int gprs_rlcmac_dl_tbf::append_data(const uint8_t ms_class,
98 const uint16_t pdu_delay_csec,
99 const uint8_t *data, const uint16_t len)
100{
101 LOGP(DRLCMAC, LOGL_INFO, "%s append\n", tbf_name(this));
102 if (state_is(GPRS_RLCMAC_WAIT_RELEASE)) {
103 LOGP(DRLCMAC, LOGL_DEBUG,
104 "%s in WAIT RELEASE state "
105 "(T3193), so reuse TBF\n", tbf_name(this));
106 tbf_update_ms_class(this, ms_class);
107 reuse_tbf(data, len);
Jacob Erlbeckc4952092015-03-24 11:04:19 +0100108 } else if (!have_data()) {
109 m_llc.put_frame(data, len);
110 bts->llc_frame_sched();
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100111 /* it is no longer drained */
112 m_last_dl_drained_fn = -1;
Jacob Erlbeckc4952092015-03-24 11:04:19 +0100113 tbf_update_ms_class(this, ms_class);
Jacob Erlbeckd0261b72015-04-02 13:58:09 +0200114 start_llc_timer();
Daniel Willmannca102af2014-08-08 12:14:12 +0200115 } else {
Jacob Erlbeckd0261b72015-04-02 13:58:09 +0200116 /* TODO: put this path into an llc_enqueue method */
Daniel Willmannca102af2014-08-08 12:14:12 +0200117 /* the TBF exists, so we must write it in the queue
118 * we prepend lifetime in front of PDU */
119 struct timeval *tv;
120 struct msgb *llc_msg = msgb_alloc(len + sizeof(*tv) * 2,
121 "llc_pdu_queue");
122 if (!llc_msg)
123 return -ENOMEM;
124 tv = (struct timeval *)msgb_put(llc_msg, sizeof(*tv));
125 gprs_llc::calc_pdu_lifetime(bts, pdu_delay_csec, tv);
126 tv = (struct timeval *)msgb_put(llc_msg, sizeof(*tv));
127 gettimeofday(tv, NULL);
128 memcpy(msgb_put(llc_msg, len), data, len);
129 m_llc.enqueue(llc_msg);
130 tbf_update_ms_class(this, ms_class);
Jacob Erlbeckd0261b72015-04-02 13:58:09 +0200131 start_llc_timer();
Daniel Willmannca102af2014-08-08 12:14:12 +0200132 }
133
134 return 0;
135}
136
137static struct gprs_rlcmac_dl_tbf *tbf_lookup_dl(BTS *bts,
Jacob Erlbeck93990462015-05-15 15:50:43 +0200138 const uint32_t tlli, const uint32_t tlli_old,
139 const char *imsi)
Daniel Willmannca102af2014-08-08 12:14:12 +0200140{
Jacob Erlbeck93990462015-05-15 15:50:43 +0200141 GprsMs *ms = bts->ms_store().get_ms(tlli, tlli_old, imsi);
Jacob Erlbecke43460b2015-05-13 13:33:12 +0200142 if (!ms)
143 return NULL;
144
145 return ms->dl_tbf();
Daniel Willmannca102af2014-08-08 12:14:12 +0200146}
147
148static int tbf_new_dl_assignment(struct gprs_rlcmac_bts *bts,
149 const char *imsi,
Jacob Erlbeck93990462015-05-15 15:50:43 +0200150 const uint32_t tlli, const uint32_t tlli_old,
151 const uint8_t ms_class,
Daniel Willmannca102af2014-08-08 12:14:12 +0200152 const uint8_t *data, const uint16_t len)
153{
154 uint8_t trx, ta, ss;
155 int8_t use_trx;
Jacob Erlbecke43460b2015-05-13 13:33:12 +0200156 struct gprs_rlcmac_ul_tbf *ul_tbf = NULL, *old_ul_tbf;
Jacob Erlbeck90de3a72015-04-09 19:18:59 +0200157 struct gprs_rlcmac_dl_tbf *dl_tbf = NULL;
Daniel Willmannca102af2014-08-08 12:14:12 +0200158 int8_t tfi; /* must be signed */
159 int rc;
Jacob Erlbecke43460b2015-05-13 13:33:12 +0200160 GprsMs *ms;
Daniel Willmannca102af2014-08-08 12:14:12 +0200161
162 /* check for uplink data, so we copy our informations */
163#warning "Do the same look up for IMSI, TLLI and OLD_TLLI"
164#warning "Refactor the below lines... into a new method"
Jacob Erlbeck93990462015-05-15 15:50:43 +0200165 ms = bts->bts->ms_store().get_ms(tlli, tlli_old, imsi);
Jacob Erlbecke43460b2015-05-13 13:33:12 +0200166 if (ms)
167 ul_tbf = ms->ul_tbf();
168
Daniel Willmannca102af2014-08-08 12:14:12 +0200169 if (ul_tbf && ul_tbf->m_contention_resolution_done
170 && !ul_tbf->m_final_ack_sent) {
171 use_trx = ul_tbf->trx->trx_no;
172 ta = ul_tbf->ta;
173 ss = 0;
174 old_ul_tbf = ul_tbf;
175 } else {
176 use_trx = -1;
177 /* we already have an uplink TBF, so we use that TA */
178 if (ul_tbf)
179 ta = ul_tbf->ta;
180 else {
181 /* recall TA */
182 rc = bts->bts->timing_advance()->recall(tlli);
183 if (rc < 0) {
184 LOGP(DRLCMAC, LOGL_NOTICE, "TA unknown"
185 ", assuming 0\n");
186 ta = 0;
187 } else
188 ta = rc;
189 }
190 ss = 1; /* PCH assignment only allows one timeslot */
191 old_ul_tbf = NULL;
192 }
193
194 // Create new TBF (any TRX)
195#warning "Copy and paste with alloc_ul_tbf"
196 tfi = bts->bts->tfi_find_free(GPRS_RLCMAC_DL_TBF, &trx, use_trx);
Jacob Erlbeck90de3a72015-04-09 19:18:59 +0200197 if (tfi >= 0)
198 /* set number of downlink slots according to multislot class */
199 dl_tbf = tbf_alloc_dl_tbf(bts, ul_tbf, tfi, trx, ms_class, ss);
200
Daniel Willmannca102af2014-08-08 12:14:12 +0200201 if (!dl_tbf) {
202 LOGP(DRLCMAC, LOGL_NOTICE, "No PDCH resource\n");
Jacob Erlbeck90de3a72015-04-09 19:18:59 +0200203 bssgp_tx_llc_discarded(gprs_bssgp_pcu_current_bctx(), tlli,
204 1, len);
Jacob Erlbeck29d91e92015-04-29 14:46:52 +0200205 bts->bts->llc_dropped_frame();
Daniel Willmannca102af2014-08-08 12:14:12 +0200206 return -EBUSY;
207 }
Daniel Willmannca102af2014-08-08 12:14:12 +0200208 dl_tbf->ta = ta;
Jacob Erlbeckbe0cbc12015-05-18 14:35:11 +0200209 dl_tbf->update_ms(tlli, GPRS_RLCMAC_DL_TBF);
Daniel Willmannca102af2014-08-08 12:14:12 +0200210
211 LOGP(DRLCMAC, LOGL_DEBUG, "%s [DOWNLINK] START\n", tbf_name(dl_tbf));
212
213 /* new TBF, so put first frame */
214 dl_tbf->m_llc.put_frame(data, len);
215 dl_tbf->bts->llc_frame_sched();
216
217 /* Store IMSI for later look-up and PCH retransmission */
218 dl_tbf->assign_imsi(imsi);
219
220 /* trigger downlink assignment and set state to ASSIGN.
221 * we don't use old_downlink, so the possible uplink is used
222 * to trigger downlink assignment. if there is no uplink,
223 * AGCH is used. */
Jacob Erlbeck71e55112015-05-21 11:10:15 +0200224 dl_tbf->bts->trigger_dl_ass(dl_tbf, old_ul_tbf);
Daniel Willmannca102af2014-08-08 12:14:12 +0200225 return 0;
226}
227
228/**
229 * TODO: split into unit test-able parts...
230 */
231int gprs_rlcmac_dl_tbf::handle(struct gprs_rlcmac_bts *bts,
Jacob Erlbeck93990462015-05-15 15:50:43 +0200232 const uint32_t tlli, const uint32_t tlli_old, const char *imsi,
Daniel Willmannca102af2014-08-08 12:14:12 +0200233 const uint8_t ms_class, const uint16_t delay_csec,
234 const uint8_t *data, const uint16_t len)
235{
236 struct gprs_rlcmac_dl_tbf *dl_tbf;
237
238 /* check for existing TBF */
Jacob Erlbeck93990462015-05-15 15:50:43 +0200239 dl_tbf = tbf_lookup_dl(bts->bts, tlli, tlli_old, imsi);
Daniel Willmannca102af2014-08-08 12:14:12 +0200240 if (dl_tbf) {
241 int rc = dl_tbf->append_data(ms_class, delay_csec, data, len);
242 if (rc >= 0)
243 dl_tbf->assign_imsi(imsi);
Jacob Erlbeck93990462015-05-15 15:50:43 +0200244
245 if (dl_tbf->ms())
246 dl_tbf->ms()->confirm_tlli(tlli);
Daniel Willmannca102af2014-08-08 12:14:12 +0200247 return rc;
248 }
249
Jacob Erlbeck93990462015-05-15 15:50:43 +0200250 return tbf_new_dl_assignment(bts, imsi, tlli, tlli_old, ms_class, data, len);
Daniel Willmannca102af2014-08-08 12:14:12 +0200251}
252
253struct msgb *gprs_rlcmac_dl_tbf::llc_dequeue(bssgp_bvc_ctx *bctx)
254{
255 struct msgb *msg;
Jacob Erlbeck6e4ccec2015-05-06 14:24:36 +0200256 struct timeval *tv_recv, *tv_disc;
257 struct timeval tv_now, tv_now2;
Daniel Willmannca102af2014-08-08 12:14:12 +0200258 uint32_t octets = 0, frames = 0;
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100259 struct timeval hyst_delta = {0, 0};
260 const unsigned keep_small_thresh = 60;
261
262 if (bts_data()->llc_discard_csec)
263 csecs_to_timeval(bts_data()->llc_discard_csec, &hyst_delta);
Daniel Willmannca102af2014-08-08 12:14:12 +0200264
265 gettimeofday(&tv_now, NULL);
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100266 timeradd(&tv_now, &hyst_delta, &tv_now2);
Daniel Willmannca102af2014-08-08 12:14:12 +0200267
268 while ((msg = m_llc.dequeue())) {
Jacob Erlbeck6e4ccec2015-05-06 14:24:36 +0200269 tv_disc = (struct timeval *)msg->data;
270 msgb_pull(msg, sizeof(*tv_disc));
271 tv_recv = (struct timeval *)msg->data;
272 msgb_pull(msg, sizeof(*tv_recv));
273
274 gprs_bssgp_update_queue_delay(tv_recv, &tv_now);
Daniel Willmannca102af2014-08-08 12:14:12 +0200275
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100276 /* Is the age below the low water mark? */
Jacob Erlbeck6e4ccec2015-05-06 14:24:36 +0200277 if (!gprs_llc::is_frame_expired(&tv_now2, tv_disc))
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100278 break;
279
280 /* Is the age below the high water mark */
Jacob Erlbeck6e4ccec2015-05-06 14:24:36 +0200281 if (!gprs_llc::is_frame_expired(&tv_now, tv_disc)) {
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100282 /* Has the previous message not been dropped? */
283 if (frames == 0)
284 break;
285
286 /* Hysteresis mode, try to discard LLC messages until
287 * the low water mark has been reached */
288
289 /* Check whether to abort the hysteresis mode */
290
291 /* Is the frame small, perhaps only a TCP ACK? */
292 if (msg->len <= keep_small_thresh)
293 break;
294
295 /* Is it a GMM message? */
296 if (!gprs_llc::is_user_data_frame(msg->data, msg->len))
297 break;
Daniel Willmannca102af2014-08-08 12:14:12 +0200298 }
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100299
300 bts->llc_timedout_frame();
301 frames++;
302 octets += msg->len;
303 msgb_free(msg);
Jacob Erlbeck29d91e92015-04-29 14:46:52 +0200304 bts->llc_dropped_frame();
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100305 continue;
Daniel Willmannca102af2014-08-08 12:14:12 +0200306 }
307
308 if (frames) {
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100309 LOGP(DRLCMACDL, LOGL_NOTICE, "%s Discarding LLC PDU "
310 "because lifetime limit reached, "
311 "count=%u new_queue_size=%zu\n",
312 tbf_name(this), frames, m_llc.m_queue_size);
Daniel Willmannca102af2014-08-08 12:14:12 +0200313 if (frames > 0xff)
314 frames = 0xff;
315 if (octets > 0xffffff)
316 octets = 0xffffff;
Jacob Erlbeck767193e2015-05-20 12:06:46 +0200317 bssgp_tx_llc_discarded(bctx, tlli(), frames, octets);
Daniel Willmannca102af2014-08-08 12:14:12 +0200318 }
319
320 return msg;
321}
322
323/*
324 * Create DL data block
325 * The messages are fragmented and forwarded as data blocks.
326 */
327struct msgb *gprs_rlcmac_dl_tbf::create_dl_acked_block(uint32_t fn, uint8_t ts)
328{
329 LOGP(DRLCMACDL, LOGL_DEBUG, "%s downlink (V(A)==%d .. "
330 "V(S)==%d)\n", tbf_name(this),
331 m_window.v_a(), m_window.v_s());
332
333do_resend:
334 /* check if there is a block with negative acknowledgement */
335 int resend_bsn = m_window.resend_needed();
336 if (resend_bsn >= 0) {
337 LOGP(DRLCMACDL, LOGL_DEBUG, "- Resending BSN %d\n", resend_bsn);
338 /* re-send block with negative aknowlegement */
339 m_window.m_v_b.mark_unacked(resend_bsn);
340 bts->rlc_resent();
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100341 return create_dl_acked_block(fn, ts, resend_bsn);
Daniel Willmannca102af2014-08-08 12:14:12 +0200342 }
343
344 /* if the window has stalled, or transfer is complete,
345 * send an unacknowledged block */
Jacob Erlbeck95340242015-03-19 13:22:07 +0100346 if (state_is(GPRS_RLCMAC_FINISHED)) {
347 LOGP(DRLCMACDL, LOGL_DEBUG, "- Restarting at BSN %d, "
348 "because all blocks have been transmitted.\n",
349 m_window.v_a());
350 bts->rlc_restarted();
351 } else if (dl_window_stalled()) {
352 LOGP(DRLCMACDL, LOGL_NOTICE, "- Restarting at BSN %d, "
353 "because all window is stalled.\n",
354 m_window.v_a());
355 bts->rlc_stalled();
Jacob Erlbecke25b5b92015-03-19 14:21:33 +0100356 } else if (have_data()) {
357 /* New blocks may be send */
358 return create_new_bsn(fn, ts);
359 } else if (!m_window.window_empty()) {
360 LOGP(DRLCMACDL, LOGL_DEBUG, "- Restarting at BSN %d, "
361 "because all blocks have been transmitted (FLOW).\n",
362 m_window.v_a());
363 bts->rlc_restarted();
Jacob Erlbeck95340242015-03-19 13:22:07 +0100364 } else {
Jacob Erlbecke25b5b92015-03-19 14:21:33 +0100365 /* Nothing left to send, create dummy LLC commands */
Jacob Erlbeck95340242015-03-19 13:22:07 +0100366 return create_new_bsn(fn, ts);
Daniel Willmannca102af2014-08-08 12:14:12 +0200367 }
368
Jacob Erlbeck95340242015-03-19 13:22:07 +0100369 /* If V(S) == V(A) and finished state, we would have received
370 * acknowledgement of all transmitted block. In this case we
371 * would have transmitted the final block, and received ack
372 * from MS. But in this case we did not receive the final ack
373 * indication from MS. This should never happen if MS works
374 * correctly. */
375 if (m_window.window_empty()) {
376 LOGP(DRLCMACDL, LOGL_DEBUG, "- MS acked all blocks, "
377 "so we re-transmit final block!\n");
378 /* we just send final block again */
379 int16_t index = m_window.v_s_mod(-1);
380 bts->rlc_resent();
381 return create_dl_acked_block(fn, ts, index);
382 }
383
384 /* cycle through all unacked blocks */
385 int resend = m_window.mark_for_resend();
386
387 /* At this point there should be at least one unacked block
388 * to be resent. If not, this is an software error. */
389 if (resend == 0) {
390 LOGP(DRLCMACDL, LOGL_ERROR, "Software error: "
391 "There are no unacknowledged blocks, but V(A) "
392 " != V(S). PLEASE FIX!\n");
393 /* we just send final block again */
394 int16_t index = m_window.v_s_mod(-1);
395 return create_dl_acked_block(fn, ts, index);
396 }
397 goto do_resend;
Daniel Willmannca102af2014-08-08 12:14:12 +0200398}
399
400struct msgb *gprs_rlcmac_dl_tbf::create_new_bsn(const uint32_t fn, const uint8_t ts)
401{
402 struct rlc_dl_header *rh;
403 struct rlc_li_field *li;
404 struct msgb *msg;
405 uint8_t *delimiter, *data, *e_pointer;
406 uint16_t space, chunk;
407 gprs_rlc_data *rlc_data;
Daniel Willmannca102af2014-08-08 12:14:12 +0200408 const uint16_t bsn = m_window.v_s();
409
410 LOGP(DRLCMACDL, LOGL_DEBUG, "- Sending new block at BSN %d\n",
411 m_window.v_s());
412
413#warning "Selection of the CS doesn't belong here"
414 if (cs == 0) {
415 cs = bts_data()->initial_cs_dl;
416 if (cs < 1 || cs > 4)
417 cs = 1;
418 }
419 /* total length of block, including spare bits */
420 const uint8_t block_length = gprs_rlcmac_cs[cs].block_length;
421 /* length of usable data of block, w/o spare bits, inc. MAC */
422 const uint8_t block_data_len = gprs_rlcmac_cs[cs].block_data;
423
424 /* now we still have untransmitted LLC data, so we fill mac block */
425 rlc_data = m_rlc.block(bsn);
426 data = rlc_data->prepare(block_data_len);
427
428 rh = (struct rlc_dl_header *)data;
429 rh->pt = 0; /* Data Block */
430 rh->rrbp = rh->s_p = 0; /* Polling, set later, if required */
431 rh->usf = 7; /* will be set at scheduler */
432 rh->pr = 0; /* FIXME: power reduction */
433 rh->tfi = m_tfi; /* TFI */
434 rh->fbi = 0; /* Final Block Indicator, set late, if true */
435 rh->bsn = bsn; /* Block Sequence Number */
436 rh->e = 0; /* Extension bit, maybe set later */
437 e_pointer = data + 2; /* points to E of current chunk */
438 data += sizeof(*rh);
439 delimiter = data; /* where next length header would be stored */
440 space = block_data_len - sizeof(*rh);
441 while (1) {
Jacob Erlbeckcbb1e702015-03-25 12:21:55 +0100442 if (m_llc.frame_length() == 0) {
443 /* A header will need to by added, so we just need
444 * space-1 octets */
445 m_llc.put_dummy_frame(space - 1);
446
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100447 /* The data just drained, store the current fn */
448 if (m_last_dl_drained_fn < 0)
449 m_last_dl_drained_fn = fn;
450
Jacob Erlbeckcbb1e702015-03-25 12:21:55 +0100451 /* It is not clear, when the next real data will
452 * arrive, so request a DL ack/nack now */
453 request_dl_ack();
454
455 LOGP(DRLCMACDL, LOGL_DEBUG,
456 "-- Empty chunk, "
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100457 "added LLC dummy command of size %d, "
458 "drained_since=%d\n",
459 m_llc.frame_length(), frames_since_last_drain(fn));
Jacob Erlbeckcbb1e702015-03-25 12:21:55 +0100460 }
461
Daniel Willmannca102af2014-08-08 12:14:12 +0200462 chunk = m_llc.chunk_size();
Jacob Erlbeckcbb1e702015-03-25 12:21:55 +0100463
Daniel Willmannca102af2014-08-08 12:14:12 +0200464 /* if chunk will exceed block limit */
465 if (chunk > space) {
466 LOGP(DRLCMACDL, LOGL_DEBUG, "-- Chunk with length %d "
467 "larger than space (%d) left in block: copy "
468 "only remaining space, and we are done\n",
469 chunk, space);
470 /* block is filled, so there is no extension */
471 *e_pointer |= 0x01;
472 /* fill only space */
473 m_llc.consume(data, space);
474 /* return data block as message */
475 break;
476 }
477 /* if FINAL chunk would fit precisely in space left */
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100478 if (chunk == space && llist_empty(&m_llc.queue) && !keep_open(fn))
479 {
Daniel Willmannca102af2014-08-08 12:14:12 +0200480 LOGP(DRLCMACDL, LOGL_DEBUG, "-- Chunk with length %d "
481 "would exactly fit into space (%d): because "
482 "this is a final block, we don't add length "
483 "header, and we are done\n", chunk, space);
484 LOGP(DRLCMACDL, LOGL_INFO, "Complete DL frame for "
485 "%s that fits precisely in last block: "
486 "len=%d\n", tbf_name(this), m_llc.frame_length());
487 gprs_rlcmac_dl_bw(this, m_llc.frame_length());
488 /* block is filled, so there is no extension */
489 *e_pointer |= 0x01;
490 /* fill space */
491 m_llc.consume(data, space);
492 m_llc.reset();
493 /* final block */
494 rh->fbi = 1; /* we indicate final block */
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100495 request_dl_ack();
Daniel Willmannca102af2014-08-08 12:14:12 +0200496 set_state(GPRS_RLCMAC_FINISHED);
497 /* return data block as message */
498 break;
499 }
500 /* if chunk would fit exactly in space left */
501 if (chunk == space) {
502 LOGP(DRLCMACDL, LOGL_DEBUG, "-- Chunk with length %d "
503 "would exactly fit into space (%d): add length "
504 "header with LI=0, to make frame extend to "
505 "next block, and we are done\n", chunk, space);
506 /* make space for delimiter */
507 if (delimiter != data)
508 memmove(delimiter + 1, delimiter,
509 data - delimiter);
510 data++;
511 space--;
512 /* add LI with 0 length */
513 li = (struct rlc_li_field *)delimiter;
514 li->e = 1; /* not more extension */
515 li->m = 0; /* shall be set to 0, in case of li = 0 */
516 li->li = 0; /* chunk fills the complete space */
517 // no need to set e_pointer nor increase delimiter
518 /* fill only space, which is 1 octet less than chunk */
519 m_llc.consume(data, space);
520 /* return data block as message */
521 break;
522 }
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100523
Daniel Willmannca102af2014-08-08 12:14:12 +0200524 LOGP(DRLCMACDL, LOGL_DEBUG, "-- Chunk with length %d is less "
525 "than remaining space (%d): add length header to "
526 "to delimit LLC frame\n", chunk, space);
527 /* the LLC frame chunk ends in this block */
528 /* make space for delimiter */
529 if (delimiter != data)
530 memmove(delimiter + 1, delimiter, data - delimiter);
531 data++;
532 space--;
533 /* add LI to delimit frame */
534 li = (struct rlc_li_field *)delimiter;
535 li->e = 0; /* Extension bit, maybe set later */
536 li->m = 0; /* will be set later, if there is more LLC data */
537 li->li = chunk; /* length of chunk */
538 e_pointer = delimiter; /* points to E of current delimiter */
539 delimiter++;
540 /* copy (rest of) LLC frame to space and reset later */
541 m_llc.consume(data, chunk);
542 data += chunk;
543 space -= chunk;
544 LOGP(DRLCMACDL, LOGL_INFO, "Complete DL frame for %s"
545 "len=%d\n", tbf_name(this), m_llc.frame_length());
546 gprs_rlcmac_dl_bw(this, m_llc.frame_length());
547 m_llc.reset();
548 /* dequeue next LLC frame, if any */
549 msg = llc_dequeue(gprs_bssgp_pcu_current_bctx());
550 if (msg) {
551 LOGP(DRLCMACDL, LOGL_INFO, "- Dequeue next LLC for "
552 "%s (len=%d)\n", tbf_name(this), msg->len);
553 m_llc.put_frame(msg->data, msg->len);
554 bts->llc_frame_sched();
555 msgb_free(msg);
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100556 m_last_dl_drained_fn = -1;
Daniel Willmannca102af2014-08-08 12:14:12 +0200557 }
558 /* if we have more data and we have space left */
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100559 if (space > 0 && (m_llc.frame_length() || keep_open(fn))) {
Daniel Willmannca102af2014-08-08 12:14:12 +0200560 li->m = 1; /* we indicate more frames to follow */
561 continue;
562 }
563 /* if we don't have more LLC frames */
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100564 if (!m_llc.frame_length() && !keep_open(fn)) {
Daniel Willmannca102af2014-08-08 12:14:12 +0200565 LOGP(DRLCMACDL, LOGL_DEBUG, "-- Final block, so we "
566 "done.\n");
567 li->e = 1; /* we cannot extend */
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100568
Daniel Willmannca102af2014-08-08 12:14:12 +0200569 rh->fbi = 1; /* we indicate final block */
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100570 request_dl_ack();
Daniel Willmannca102af2014-08-08 12:14:12 +0200571 set_state(GPRS_RLCMAC_FINISHED);
572 break;
573 }
574 /* we have no space left */
575 LOGP(DRLCMACDL, LOGL_DEBUG, "-- No space left, so we are "
576 "done.\n");
577 li->e = 1; /* we cannot extend */
578 break;
579 }
580 LOGP(DRLCMACDL, LOGL_DEBUG, "data block: %s\n",
581 osmo_hexdump(rlc_data->block, block_length));
582#warning "move this up?"
583 rlc_data->len = block_length;
584 /* raise send state and set ack state array */
585 m_window.m_v_b.mark_unacked(bsn);
586 m_window.increment_send();
587
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100588 return create_dl_acked_block(fn, ts, bsn);
589}
590
Daniel Willmannca102af2014-08-08 12:14:12 +0200591struct msgb *gprs_rlcmac_dl_tbf::create_dl_acked_block(
592 const uint32_t fn, const uint8_t ts,
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100593 const int index)
Daniel Willmannca102af2014-08-08 12:14:12 +0200594{
595 uint8_t *data;
596 struct rlc_dl_header *rh;
597 struct msgb *dl_msg;
598 uint8_t len;
Daniel Willmannefd5dbb2014-08-25 16:20:23 +0200599 bool need_poll;
Daniel Willmannca102af2014-08-08 12:14:12 +0200600
601 /* get data and header from current block */
602 data = m_rlc.block(index)->block;
603 len = m_rlc.block(index)->len;
604 rh = (struct rlc_dl_header *)data;
605
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +0100606 /* If the TBF has just started, relate frames_since_last_poll to the
607 * current fn */
608 if (m_last_dl_poll_fn < 0)
609 m_last_dl_poll_fn = fn;
610
Daniel Willmannefd5dbb2014-08-25 16:20:23 +0200611 need_poll = state_flags & (1 << GPRS_RLCMAC_FLAG_TO_DL_ACK);
Daniel Willmannca102af2014-08-08 12:14:12 +0200612 /* Clear Polling, if still set in history buffer */
613 rh->s_p = 0;
614
615 /* poll after POLL_ACK_AFTER_FRAMES frames, or when final block is tx.
616 */
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100617 if (m_tx_counter >= POLL_ACK_AFTER_FRAMES || m_dl_ack_requested ||
Daniel Willmannefd5dbb2014-08-25 16:20:23 +0200618 need_poll) {
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100619 if (m_dl_ack_requested) {
Daniel Willmannca102af2014-08-08 12:14:12 +0200620 LOGP(DRLCMACDL, LOGL_DEBUG, "- Scheduling Ack/Nack "
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100621 "polling, because is was requested explicitly "
622 "(e.g. first final block sent).\n");
Daniel Willmannefd5dbb2014-08-25 16:20:23 +0200623 } else if (need_poll) {
624 LOGP(DRLCMACDL, LOGL_DEBUG, "- Scheduling Ack/Nack "
Daniel Willmann635d47c2014-09-17 17:58:29 +0200625 "polling, because polling timed out.\n");
Daniel Willmannca102af2014-08-08 12:14:12 +0200626 } else {
627 LOGP(DRLCMACDL, LOGL_DEBUG, "- Scheduling Ack/Nack "
628 "polling, because %d blocks sent.\n",
629 POLL_ACK_AFTER_FRAMES);
630 }
631 /* scheduling not possible, because: */
632 if (poll_state != GPRS_RLCMAC_POLL_NONE)
633 LOGP(DRLCMACDL, LOGL_DEBUG, "Polling is already "
634 "sheduled for %s, so we must wait for "
635 "requesting downlink ack\n", tbf_name(this));
636 else if (control_ts != ts)
637 LOGP(DRLCMACDL, LOGL_DEBUG, "Polling cannot be "
638 "sheduled in this TS %d, waiting for "
639 "TS %d\n", ts, control_ts);
Daniel Willmannca102af2014-08-08 12:14:12 +0200640 else if (bts->sba()->find(trx->trx_no, ts, (fn + 13) % 2715648))
641 LOGP(DRLCMACDL, LOGL_DEBUG, "Polling cannot be "
642 "sheduled, because single block alllocation "
643 "already exists\n");
644 else {
645 LOGP(DRLCMACDL, LOGL_DEBUG, "Polling sheduled in this "
646 "TS %d\n", ts);
647 m_tx_counter = 0;
648 /* start timer whenever we send the final block */
649 if (rh->fbi == 1)
650 tbf_timer_start(this, 3191, bts_data()->t3191, 0);
651
652 /* schedule polling */
653 poll_state = GPRS_RLCMAC_POLL_SCHED;
654 poll_fn = (fn + 13) % 2715648;
655
Daniel Willmannefd5dbb2014-08-25 16:20:23 +0200656 /* Clear poll timeout flag */
657 state_flags &= ~(1 << GPRS_RLCMAC_FLAG_TO_DL_ACK);
658
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100659 /* Clear request flag */
660 m_dl_ack_requested = false;
661
Daniel Willmannca102af2014-08-08 12:14:12 +0200662 /* set polling in header */
663 rh->rrbp = 0; /* N+13 */
664 rh->s_p = 1; /* Polling */
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +0100665
666 m_last_dl_poll_fn = poll_fn;
Daniel Willmannca102af2014-08-08 12:14:12 +0200667 }
668 }
669
670 /* return data block as message */
671 dl_msg = msgb_alloc(len, "rlcmac_dl_data");
672 if (!dl_msg)
673 return NULL;
674
675 /* Increment TX-counter */
676 m_tx_counter++;
677
678 memcpy(msgb_put(dl_msg, len), data, len);
679 bts->rlc_sent();
680
681 return dl_msg;
682}
683
684int gprs_rlcmac_dl_tbf::update_window(const uint8_t ssn, const uint8_t *rbb)
685{
686 int16_t dist; /* must be signed */
687 uint16_t lost = 0, received = 0;
688 char show_rbb[65];
689 char show_v_b[RLC_MAX_SNS + 1];
690 const uint16_t mod_sns = m_window.mod_sns();
691
692 Decoding::extract_rbb(rbb, show_rbb);
693 /* show received array in debug (bit 64..1) */
694 LOGP(DRLCMACDL, LOGL_DEBUG, "- ack: (BSN=%d)\"%s\""
695 "(BSN=%d) R=ACK I=NACK\n", (ssn - 64) & mod_sns,
696 show_rbb, (ssn - 1) & mod_sns);
697
698 /* apply received array to receive state (SSN-64..SSN-1) */
699 /* calculate distance of ssn from V(S) */
700 dist = (m_window.v_s() - ssn) & mod_sns;
701 /* check if distance is less than distance V(A)..V(S) */
702 if (dist >= m_window.distance()) {
703 /* this might happpen, if the downlink assignment
704 * was not received by ms and the ack refers
705 * to previous TBF
706 * FIXME: we should implement polling for
707 * control ack!*/
708 LOGP(DRLCMACDL, LOGL_NOTICE, "- ack range is out of "
709 "V(A)..V(S) range %s Free TBF!\n", tbf_name(this));
710 return 1; /* indicate to free TBF */
711 }
712
713 m_window.update(bts, show_rbb, ssn,
714 &lost, &received);
715
716 /* report lost and received packets */
717 gprs_rlcmac_received_lost(this, received, lost);
718
719 /* raise V(A), if possible */
720 m_window.raise(m_window.move_window());
721
722 /* show receive state array in debug (V(A)..V(S)-1) */
723 m_window.show_state(show_v_b);
724 LOGP(DRLCMACDL, LOGL_DEBUG, "- V(B): (V(A)=%d)\"%s\""
725 "(V(S)-1=%d) A=Acked N=Nacked U=Unacked "
726 "X=Resend-Unacked I=Invalid\n",
727 m_window.v_a(), show_v_b,
728 m_window.v_s_mod(-1));
729
730 if (state_is(GPRS_RLCMAC_FINISHED) && m_window.window_empty()) {
731 LOGP(DRLCMACDL, LOGL_NOTICE, "Received acknowledge of "
732 "all blocks, but without final ack "
733 "inidcation (don't worry)\n");
734 }
735 return 0;
736}
737
738
739int gprs_rlcmac_dl_tbf::maybe_start_new_window()
740{
741 struct msgb *msg;
742 uint16_t received;
743
744 LOGP(DRLCMACDL, LOGL_DEBUG, "- Final ACK received.\n");
745 /* range V(A)..V(S)-1 */
746 received = m_window.count_unacked();
747
748 /* report all outstanding packets as received */
749 gprs_rlcmac_received_lost(this, received, 0);
750
751 set_state(GPRS_RLCMAC_WAIT_RELEASE);
752
753 /* check for LLC PDU in the LLC Queue */
754 msg = llc_dequeue(gprs_bssgp_pcu_current_bctx());
755 if (!msg) {
756 /* no message, start T3193, change state to RELEASE */
757 LOGP(DRLCMACDL, LOGL_DEBUG, "- No new message, so we release.\n");
758 /* start T3193 */
759 tbf_timer_start(this, 3193,
760 bts_data()->t3193_msec / 1000,
761 (bts_data()->t3193_msec % 1000) * 1000);
762
763 return 0;
764 }
765
766 /* we have more data so we will re-use this tbf */
767 reuse_tbf(msg->data, msg->len);
768 msgb_free(msg);
769 return 0;
770}
771
772int gprs_rlcmac_dl_tbf::rcvd_dl_ack(uint8_t final_ack, uint8_t ssn, uint8_t *rbb)
773{
774 LOGP(DRLCMACDL, LOGL_DEBUG, "%s downlink acknowledge\n", tbf_name(this));
775
776 if (!final_ack)
777 return update_window(ssn, rbb);
778 return maybe_start_new_window();
779}
780
781void gprs_rlcmac_dl_tbf::reuse_tbf(const uint8_t *data, const uint16_t len)
782{
Daniel Willmanne4818152014-08-15 16:52:09 +0200783 uint8_t trx;
Jacob Erlbeck90de3a72015-04-09 19:18:59 +0200784 struct gprs_rlcmac_dl_tbf *new_tbf = NULL;
Daniel Willmanne4818152014-08-15 16:52:09 +0200785 int8_t tfi; /* must be signed */
Daniel Willmanne4818152014-08-15 16:52:09 +0200786 struct msgb *msg;
787
Daniel Willmannca102af2014-08-08 12:14:12 +0200788 bts->tbf_reused();
Daniel Willmanne4818152014-08-15 16:52:09 +0200789
790 tfi = bts->tfi_find_free(GPRS_RLCMAC_DL_TBF, &trx, this->trx->trx_no);
Jacob Erlbeck90de3a72015-04-09 19:18:59 +0200791 if (tfi >= 0)
792 new_tbf = tbf_alloc_dl_tbf(bts->bts_data(), NULL, tfi, trx,
793 ms_class, 0);
794
Daniel Willmanne4818152014-08-15 16:52:09 +0200795 if (!new_tbf) {
796 LOGP(DRLCMAC, LOGL_NOTICE, "No PDCH resource\n");
Jacob Erlbeck767193e2015-05-20 12:06:46 +0200797 bssgp_tx_llc_discarded(gprs_bssgp_pcu_current_bctx(), tlli(),
Jacob Erlbeck90de3a72015-04-09 19:18:59 +0200798 1, len);
Jacob Erlbeck29d91e92015-04-29 14:46:52 +0200799 bts->llc_dropped_frame();
Daniel Willmanne4818152014-08-15 16:52:09 +0200800 return;
801 }
802
Jacob Erlbeck4f459792015-05-18 15:21:36 +0200803 new_tbf->set_ms(ms());
Daniel Willmanne4818152014-08-15 16:52:09 +0200804 new_tbf->ta = ta;
Daniel Willmanne4818152014-08-15 16:52:09 +0200805
806 /* Copy over all data to the new TBF */
807 new_tbf->m_llc.put_frame(data, len);
Daniel Willmannca102af2014-08-08 12:14:12 +0200808 bts->llc_frame_sched();
809
Daniel Willmanne4818152014-08-15 16:52:09 +0200810 while ((msg = m_llc.dequeue()))
811 new_tbf->m_llc.enqueue(msg);
812
Daniel Willmannca102af2014-08-08 12:14:12 +0200813 /* reset rlc states */
814 m_tx_counter = 0;
815 m_wait_confirm = 0;
816 m_window.reset();
817
818 /* keep to flags */
819 state_flags &= GPRS_RLCMAC_FLAG_TO_MASK;
820 state_flags &= ~(1 << GPRS_RLCMAC_FLAG_CCCH);
821
822 update();
823
824 LOGP(DRLCMAC, LOGL_DEBUG, "%s Trigger dowlink assignment on PACCH, "
825 "because another LLC PDU has arrived in between\n",
826 tbf_name(this));
Jacob Erlbeck71e55112015-05-21 11:10:15 +0200827 bts->trigger_dl_ass(new_tbf, this);
Daniel Willmannca102af2014-08-08 12:14:12 +0200828}
829
830bool gprs_rlcmac_dl_tbf::dl_window_stalled() const
831{
832 return m_window.window_stalled();
833}
834
Jacob Erlbeckeceb9102015-03-20 14:41:50 +0100835void gprs_rlcmac_dl_tbf::request_dl_ack()
836{
837 m_dl_ack_requested = true;
838}
839
840bool gprs_rlcmac_dl_tbf::need_control_ts() const
841{
842 if (poll_state != GPRS_RLCMAC_POLL_NONE)
843 return false;
844
845 return state_flags & (1 << GPRS_RLCMAC_FLAG_TO_DL_ACK) ||
846 m_tx_counter >= POLL_ACK_AFTER_FRAMES ||
847 m_dl_ack_requested;
848}
849
850bool gprs_rlcmac_dl_tbf::have_data() const
851{
852 return m_llc.chunk_size() > 0 || !llist_empty(&m_llc.queue);
853}
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +0100854
855int gprs_rlcmac_dl_tbf::frames_since_last_poll(unsigned fn) const
856{
857 unsigned wrapped;
858 if (m_last_dl_poll_fn < 0)
859 return -1;
860
861 wrapped = (fn + 2715648 - m_last_dl_poll_fn) % 2715648;
862 if (wrapped < 2715648/2)
863 return wrapped;
864 else
865 return wrapped - 2715648;
866}
867
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100868int gprs_rlcmac_dl_tbf::frames_since_last_drain(unsigned fn) const
869{
870 unsigned wrapped;
871 if (m_last_dl_drained_fn < 0)
872 return -1;
873
874 wrapped = (fn + 2715648 - m_last_dl_drained_fn) % 2715648;
875 if (wrapped < 2715648/2)
876 return wrapped;
877 else
878 return wrapped - 2715648;
879}
880
881bool gprs_rlcmac_dl_tbf::keep_open(unsigned fn) const
882{
883 int keep_time_frames;
884
885 if (bts_data()->dl_tbf_idle_msec <= 0)
886 return false;
887
888 keep_time_frames = msecs_to_frames(bts_data()->dl_tbf_idle_msec);
889 return frames_since_last_drain(fn) <= keep_time_frames;
890}