blob: b258a3c8011cba1c72860ccada3bb206258615af [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 }
208 dl_tbf->m_tlli = tlli;
209 dl_tbf->m_tlli_valid = 1;
210 dl_tbf->ta = ta;
Jacob Erlbeckfecece02015-05-08 12:13:08 +0200211 dl_tbf->update_ms(tlli);
Daniel Willmannca102af2014-08-08 12:14:12 +0200212
213 LOGP(DRLCMAC, LOGL_DEBUG, "%s [DOWNLINK] START\n", tbf_name(dl_tbf));
214
215 /* new TBF, so put first frame */
216 dl_tbf->m_llc.put_frame(data, len);
217 dl_tbf->bts->llc_frame_sched();
218
219 /* Store IMSI for later look-up and PCH retransmission */
220 dl_tbf->assign_imsi(imsi);
221
222 /* trigger downlink assignment and set state to ASSIGN.
223 * we don't use old_downlink, so the possible uplink is used
224 * to trigger downlink assignment. if there is no uplink,
225 * AGCH is used. */
226 dl_tbf->bts->trigger_dl_ass(dl_tbf, old_ul_tbf, imsi);
227 return 0;
228}
229
230/**
231 * TODO: split into unit test-able parts...
232 */
233int gprs_rlcmac_dl_tbf::handle(struct gprs_rlcmac_bts *bts,
Jacob Erlbeck93990462015-05-15 15:50:43 +0200234 const uint32_t tlli, const uint32_t tlli_old, const char *imsi,
Daniel Willmannca102af2014-08-08 12:14:12 +0200235 const uint8_t ms_class, const uint16_t delay_csec,
236 const uint8_t *data, const uint16_t len)
237{
238 struct gprs_rlcmac_dl_tbf *dl_tbf;
239
240 /* check for existing TBF */
Jacob Erlbeck93990462015-05-15 15:50:43 +0200241 dl_tbf = tbf_lookup_dl(bts->bts, tlli, tlli_old, imsi);
Daniel Willmannca102af2014-08-08 12:14:12 +0200242 if (dl_tbf) {
243 int rc = dl_tbf->append_data(ms_class, delay_csec, data, len);
244 if (rc >= 0)
245 dl_tbf->assign_imsi(imsi);
Jacob Erlbeck93990462015-05-15 15:50:43 +0200246
247 if (dl_tbf->ms())
248 dl_tbf->ms()->confirm_tlli(tlli);
Daniel Willmannca102af2014-08-08 12:14:12 +0200249 return rc;
250 }
251
Jacob Erlbeck93990462015-05-15 15:50:43 +0200252 return tbf_new_dl_assignment(bts, imsi, tlli, tlli_old, ms_class, data, len);
Daniel Willmannca102af2014-08-08 12:14:12 +0200253}
254
255struct msgb *gprs_rlcmac_dl_tbf::llc_dequeue(bssgp_bvc_ctx *bctx)
256{
257 struct msgb *msg;
Jacob Erlbeck6e4ccec2015-05-06 14:24:36 +0200258 struct timeval *tv_recv, *tv_disc;
259 struct timeval tv_now, tv_now2;
Daniel Willmannca102af2014-08-08 12:14:12 +0200260 uint32_t octets = 0, frames = 0;
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100261 struct timeval hyst_delta = {0, 0};
262 const unsigned keep_small_thresh = 60;
263
264 if (bts_data()->llc_discard_csec)
265 csecs_to_timeval(bts_data()->llc_discard_csec, &hyst_delta);
Daniel Willmannca102af2014-08-08 12:14:12 +0200266
267 gettimeofday(&tv_now, NULL);
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100268 timeradd(&tv_now, &hyst_delta, &tv_now2);
Daniel Willmannca102af2014-08-08 12:14:12 +0200269
270 while ((msg = m_llc.dequeue())) {
Jacob Erlbeck6e4ccec2015-05-06 14:24:36 +0200271 tv_disc = (struct timeval *)msg->data;
272 msgb_pull(msg, sizeof(*tv_disc));
273 tv_recv = (struct timeval *)msg->data;
274 msgb_pull(msg, sizeof(*tv_recv));
275
276 gprs_bssgp_update_queue_delay(tv_recv, &tv_now);
Daniel Willmannca102af2014-08-08 12:14:12 +0200277
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100278 /* Is the age below the low water mark? */
Jacob Erlbeck6e4ccec2015-05-06 14:24:36 +0200279 if (!gprs_llc::is_frame_expired(&tv_now2, tv_disc))
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100280 break;
281
282 /* Is the age below the high water mark */
Jacob Erlbeck6e4ccec2015-05-06 14:24:36 +0200283 if (!gprs_llc::is_frame_expired(&tv_now, tv_disc)) {
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100284 /* Has the previous message not been dropped? */
285 if (frames == 0)
286 break;
287
288 /* Hysteresis mode, try to discard LLC messages until
289 * the low water mark has been reached */
290
291 /* Check whether to abort the hysteresis mode */
292
293 /* Is the frame small, perhaps only a TCP ACK? */
294 if (msg->len <= keep_small_thresh)
295 break;
296
297 /* Is it a GMM message? */
298 if (!gprs_llc::is_user_data_frame(msg->data, msg->len))
299 break;
Daniel Willmannca102af2014-08-08 12:14:12 +0200300 }
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100301
302 bts->llc_timedout_frame();
303 frames++;
304 octets += msg->len;
305 msgb_free(msg);
Jacob Erlbeck29d91e92015-04-29 14:46:52 +0200306 bts->llc_dropped_frame();
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100307 continue;
Daniel Willmannca102af2014-08-08 12:14:12 +0200308 }
309
310 if (frames) {
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100311 LOGP(DRLCMACDL, LOGL_NOTICE, "%s Discarding LLC PDU "
312 "because lifetime limit reached, "
313 "count=%u new_queue_size=%zu\n",
314 tbf_name(this), frames, m_llc.m_queue_size);
Daniel Willmannca102af2014-08-08 12:14:12 +0200315 if (frames > 0xff)
316 frames = 0xff;
317 if (octets > 0xffffff)
318 octets = 0xffffff;
319 bssgp_tx_llc_discarded(bctx, m_tlli, frames, octets);
320 }
321
322 return msg;
323}
324
325/*
326 * Create DL data block
327 * The messages are fragmented and forwarded as data blocks.
328 */
329struct msgb *gprs_rlcmac_dl_tbf::create_dl_acked_block(uint32_t fn, uint8_t ts)
330{
331 LOGP(DRLCMACDL, LOGL_DEBUG, "%s downlink (V(A)==%d .. "
332 "V(S)==%d)\n", tbf_name(this),
333 m_window.v_a(), m_window.v_s());
334
335do_resend:
336 /* check if there is a block with negative acknowledgement */
337 int resend_bsn = m_window.resend_needed();
338 if (resend_bsn >= 0) {
339 LOGP(DRLCMACDL, LOGL_DEBUG, "- Resending BSN %d\n", resend_bsn);
340 /* re-send block with negative aknowlegement */
341 m_window.m_v_b.mark_unacked(resend_bsn);
342 bts->rlc_resent();
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100343 return create_dl_acked_block(fn, ts, resend_bsn);
Daniel Willmannca102af2014-08-08 12:14:12 +0200344 }
345
346 /* if the window has stalled, or transfer is complete,
347 * send an unacknowledged block */
Jacob Erlbeck95340242015-03-19 13:22:07 +0100348 if (state_is(GPRS_RLCMAC_FINISHED)) {
349 LOGP(DRLCMACDL, LOGL_DEBUG, "- Restarting at BSN %d, "
350 "because all blocks have been transmitted.\n",
351 m_window.v_a());
352 bts->rlc_restarted();
353 } else if (dl_window_stalled()) {
354 LOGP(DRLCMACDL, LOGL_NOTICE, "- Restarting at BSN %d, "
355 "because all window is stalled.\n",
356 m_window.v_a());
357 bts->rlc_stalled();
Jacob Erlbecke25b5b92015-03-19 14:21:33 +0100358 } else if (have_data()) {
359 /* New blocks may be send */
360 return create_new_bsn(fn, ts);
361 } else if (!m_window.window_empty()) {
362 LOGP(DRLCMACDL, LOGL_DEBUG, "- Restarting at BSN %d, "
363 "because all blocks have been transmitted (FLOW).\n",
364 m_window.v_a());
365 bts->rlc_restarted();
Jacob Erlbeck95340242015-03-19 13:22:07 +0100366 } else {
Jacob Erlbecke25b5b92015-03-19 14:21:33 +0100367 /* Nothing left to send, create dummy LLC commands */
Jacob Erlbeck95340242015-03-19 13:22:07 +0100368 return create_new_bsn(fn, ts);
Daniel Willmannca102af2014-08-08 12:14:12 +0200369 }
370
Jacob Erlbeck95340242015-03-19 13:22:07 +0100371 /* If V(S) == V(A) and finished state, we would have received
372 * acknowledgement of all transmitted block. In this case we
373 * would have transmitted the final block, and received ack
374 * from MS. But in this case we did not receive the final ack
375 * indication from MS. This should never happen if MS works
376 * correctly. */
377 if (m_window.window_empty()) {
378 LOGP(DRLCMACDL, LOGL_DEBUG, "- MS acked all blocks, "
379 "so we re-transmit final block!\n");
380 /* we just send final block again */
381 int16_t index = m_window.v_s_mod(-1);
382 bts->rlc_resent();
383 return create_dl_acked_block(fn, ts, index);
384 }
385
386 /* cycle through all unacked blocks */
387 int resend = m_window.mark_for_resend();
388
389 /* At this point there should be at least one unacked block
390 * to be resent. If not, this is an software error. */
391 if (resend == 0) {
392 LOGP(DRLCMACDL, LOGL_ERROR, "Software error: "
393 "There are no unacknowledged blocks, but V(A) "
394 " != V(S). PLEASE FIX!\n");
395 /* we just send final block again */
396 int16_t index = m_window.v_s_mod(-1);
397 return create_dl_acked_block(fn, ts, index);
398 }
399 goto do_resend;
Daniel Willmannca102af2014-08-08 12:14:12 +0200400}
401
402struct msgb *gprs_rlcmac_dl_tbf::create_new_bsn(const uint32_t fn, const uint8_t ts)
403{
404 struct rlc_dl_header *rh;
405 struct rlc_li_field *li;
406 struct msgb *msg;
407 uint8_t *delimiter, *data, *e_pointer;
408 uint16_t space, chunk;
409 gprs_rlc_data *rlc_data;
Daniel Willmannca102af2014-08-08 12:14:12 +0200410 const uint16_t bsn = m_window.v_s();
411
412 LOGP(DRLCMACDL, LOGL_DEBUG, "- Sending new block at BSN %d\n",
413 m_window.v_s());
414
415#warning "Selection of the CS doesn't belong here"
416 if (cs == 0) {
417 cs = bts_data()->initial_cs_dl;
418 if (cs < 1 || cs > 4)
419 cs = 1;
420 }
421 /* total length of block, including spare bits */
422 const uint8_t block_length = gprs_rlcmac_cs[cs].block_length;
423 /* length of usable data of block, w/o spare bits, inc. MAC */
424 const uint8_t block_data_len = gprs_rlcmac_cs[cs].block_data;
425
426 /* now we still have untransmitted LLC data, so we fill mac block */
427 rlc_data = m_rlc.block(bsn);
428 data = rlc_data->prepare(block_data_len);
429
430 rh = (struct rlc_dl_header *)data;
431 rh->pt = 0; /* Data Block */
432 rh->rrbp = rh->s_p = 0; /* Polling, set later, if required */
433 rh->usf = 7; /* will be set at scheduler */
434 rh->pr = 0; /* FIXME: power reduction */
435 rh->tfi = m_tfi; /* TFI */
436 rh->fbi = 0; /* Final Block Indicator, set late, if true */
437 rh->bsn = bsn; /* Block Sequence Number */
438 rh->e = 0; /* Extension bit, maybe set later */
439 e_pointer = data + 2; /* points to E of current chunk */
440 data += sizeof(*rh);
441 delimiter = data; /* where next length header would be stored */
442 space = block_data_len - sizeof(*rh);
443 while (1) {
Jacob Erlbeckcbb1e702015-03-25 12:21:55 +0100444 if (m_llc.frame_length() == 0) {
445 /* A header will need to by added, so we just need
446 * space-1 octets */
447 m_llc.put_dummy_frame(space - 1);
448
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100449 /* The data just drained, store the current fn */
450 if (m_last_dl_drained_fn < 0)
451 m_last_dl_drained_fn = fn;
452
Jacob Erlbeckcbb1e702015-03-25 12:21:55 +0100453 /* It is not clear, when the next real data will
454 * arrive, so request a DL ack/nack now */
455 request_dl_ack();
456
457 LOGP(DRLCMACDL, LOGL_DEBUG,
458 "-- Empty chunk, "
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100459 "added LLC dummy command of size %d, "
460 "drained_since=%d\n",
461 m_llc.frame_length(), frames_since_last_drain(fn));
Jacob Erlbeckcbb1e702015-03-25 12:21:55 +0100462 }
463
Daniel Willmannca102af2014-08-08 12:14:12 +0200464 chunk = m_llc.chunk_size();
Jacob Erlbeckcbb1e702015-03-25 12:21:55 +0100465
Daniel Willmannca102af2014-08-08 12:14:12 +0200466 /* if chunk will exceed block limit */
467 if (chunk > space) {
468 LOGP(DRLCMACDL, LOGL_DEBUG, "-- Chunk with length %d "
469 "larger than space (%d) left in block: copy "
470 "only remaining space, and we are done\n",
471 chunk, space);
472 /* block is filled, so there is no extension */
473 *e_pointer |= 0x01;
474 /* fill only space */
475 m_llc.consume(data, space);
476 /* return data block as message */
477 break;
478 }
479 /* if FINAL chunk would fit precisely in space left */
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100480 if (chunk == space && llist_empty(&m_llc.queue) && !keep_open(fn))
481 {
Daniel Willmannca102af2014-08-08 12:14:12 +0200482 LOGP(DRLCMACDL, LOGL_DEBUG, "-- Chunk with length %d "
483 "would exactly fit into space (%d): because "
484 "this is a final block, we don't add length "
485 "header, and we are done\n", chunk, space);
486 LOGP(DRLCMACDL, LOGL_INFO, "Complete DL frame for "
487 "%s that fits precisely in last block: "
488 "len=%d\n", tbf_name(this), m_llc.frame_length());
489 gprs_rlcmac_dl_bw(this, m_llc.frame_length());
490 /* block is filled, so there is no extension */
491 *e_pointer |= 0x01;
492 /* fill space */
493 m_llc.consume(data, space);
494 m_llc.reset();
495 /* final block */
496 rh->fbi = 1; /* we indicate final block */
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100497 request_dl_ack();
Daniel Willmannca102af2014-08-08 12:14:12 +0200498 set_state(GPRS_RLCMAC_FINISHED);
499 /* return data block as message */
500 break;
501 }
502 /* if chunk would fit exactly in space left */
503 if (chunk == space) {
504 LOGP(DRLCMACDL, LOGL_DEBUG, "-- Chunk with length %d "
505 "would exactly fit into space (%d): add length "
506 "header with LI=0, to make frame extend to "
507 "next block, and we are done\n", chunk, space);
508 /* make space for delimiter */
509 if (delimiter != data)
510 memmove(delimiter + 1, delimiter,
511 data - delimiter);
512 data++;
513 space--;
514 /* add LI with 0 length */
515 li = (struct rlc_li_field *)delimiter;
516 li->e = 1; /* not more extension */
517 li->m = 0; /* shall be set to 0, in case of li = 0 */
518 li->li = 0; /* chunk fills the complete space */
519 // no need to set e_pointer nor increase delimiter
520 /* fill only space, which is 1 octet less than chunk */
521 m_llc.consume(data, space);
522 /* return data block as message */
523 break;
524 }
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100525
Daniel Willmannca102af2014-08-08 12:14:12 +0200526 LOGP(DRLCMACDL, LOGL_DEBUG, "-- Chunk with length %d is less "
527 "than remaining space (%d): add length header to "
528 "to delimit LLC frame\n", chunk, space);
529 /* the LLC frame chunk ends in this block */
530 /* make space for delimiter */
531 if (delimiter != data)
532 memmove(delimiter + 1, delimiter, data - delimiter);
533 data++;
534 space--;
535 /* add LI to delimit frame */
536 li = (struct rlc_li_field *)delimiter;
537 li->e = 0; /* Extension bit, maybe set later */
538 li->m = 0; /* will be set later, if there is more LLC data */
539 li->li = chunk; /* length of chunk */
540 e_pointer = delimiter; /* points to E of current delimiter */
541 delimiter++;
542 /* copy (rest of) LLC frame to space and reset later */
543 m_llc.consume(data, chunk);
544 data += chunk;
545 space -= chunk;
546 LOGP(DRLCMACDL, LOGL_INFO, "Complete DL frame for %s"
547 "len=%d\n", tbf_name(this), m_llc.frame_length());
548 gprs_rlcmac_dl_bw(this, m_llc.frame_length());
549 m_llc.reset();
550 /* dequeue next LLC frame, if any */
551 msg = llc_dequeue(gprs_bssgp_pcu_current_bctx());
552 if (msg) {
553 LOGP(DRLCMACDL, LOGL_INFO, "- Dequeue next LLC for "
554 "%s (len=%d)\n", tbf_name(this), msg->len);
555 m_llc.put_frame(msg->data, msg->len);
556 bts->llc_frame_sched();
557 msgb_free(msg);
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100558 m_last_dl_drained_fn = -1;
Daniel Willmannca102af2014-08-08 12:14:12 +0200559 }
560 /* if we have more data and we have space left */
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100561 if (space > 0 && (m_llc.frame_length() || keep_open(fn))) {
Daniel Willmannca102af2014-08-08 12:14:12 +0200562 li->m = 1; /* we indicate more frames to follow */
563 continue;
564 }
565 /* if we don't have more LLC frames */
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100566 if (!m_llc.frame_length() && !keep_open(fn)) {
Daniel Willmannca102af2014-08-08 12:14:12 +0200567 LOGP(DRLCMACDL, LOGL_DEBUG, "-- Final block, so we "
568 "done.\n");
569 li->e = 1; /* we cannot extend */
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100570
Daniel Willmannca102af2014-08-08 12:14:12 +0200571 rh->fbi = 1; /* we indicate final block */
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100572 request_dl_ack();
Daniel Willmannca102af2014-08-08 12:14:12 +0200573 set_state(GPRS_RLCMAC_FINISHED);
574 break;
575 }
576 /* we have no space left */
577 LOGP(DRLCMACDL, LOGL_DEBUG, "-- No space left, so we are "
578 "done.\n");
579 li->e = 1; /* we cannot extend */
580 break;
581 }
582 LOGP(DRLCMACDL, LOGL_DEBUG, "data block: %s\n",
583 osmo_hexdump(rlc_data->block, block_length));
584#warning "move this up?"
585 rlc_data->len = block_length;
586 /* raise send state and set ack state array */
587 m_window.m_v_b.mark_unacked(bsn);
588 m_window.increment_send();
589
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100590 return create_dl_acked_block(fn, ts, bsn);
591}
592
Daniel Willmannca102af2014-08-08 12:14:12 +0200593struct msgb *gprs_rlcmac_dl_tbf::create_dl_acked_block(
594 const uint32_t fn, const uint8_t ts,
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100595 const int index)
Daniel Willmannca102af2014-08-08 12:14:12 +0200596{
597 uint8_t *data;
598 struct rlc_dl_header *rh;
599 struct msgb *dl_msg;
600 uint8_t len;
Daniel Willmannefd5dbb2014-08-25 16:20:23 +0200601 bool need_poll;
Daniel Willmannca102af2014-08-08 12:14:12 +0200602
603 /* get data and header from current block */
604 data = m_rlc.block(index)->block;
605 len = m_rlc.block(index)->len;
606 rh = (struct rlc_dl_header *)data;
607
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +0100608 /* If the TBF has just started, relate frames_since_last_poll to the
609 * current fn */
610 if (m_last_dl_poll_fn < 0)
611 m_last_dl_poll_fn = fn;
612
Daniel Willmannefd5dbb2014-08-25 16:20:23 +0200613 need_poll = state_flags & (1 << GPRS_RLCMAC_FLAG_TO_DL_ACK);
Daniel Willmannca102af2014-08-08 12:14:12 +0200614 /* Clear Polling, if still set in history buffer */
615 rh->s_p = 0;
616
617 /* poll after POLL_ACK_AFTER_FRAMES frames, or when final block is tx.
618 */
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100619 if (m_tx_counter >= POLL_ACK_AFTER_FRAMES || m_dl_ack_requested ||
Daniel Willmannefd5dbb2014-08-25 16:20:23 +0200620 need_poll) {
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100621 if (m_dl_ack_requested) {
Daniel Willmannca102af2014-08-08 12:14:12 +0200622 LOGP(DRLCMACDL, LOGL_DEBUG, "- Scheduling Ack/Nack "
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100623 "polling, because is was requested explicitly "
624 "(e.g. first final block sent).\n");
Daniel Willmannefd5dbb2014-08-25 16:20:23 +0200625 } else if (need_poll) {
626 LOGP(DRLCMACDL, LOGL_DEBUG, "- Scheduling Ack/Nack "
Daniel Willmann635d47c2014-09-17 17:58:29 +0200627 "polling, because polling timed out.\n");
Daniel Willmannca102af2014-08-08 12:14:12 +0200628 } else {
629 LOGP(DRLCMACDL, LOGL_DEBUG, "- Scheduling Ack/Nack "
630 "polling, because %d blocks sent.\n",
631 POLL_ACK_AFTER_FRAMES);
632 }
633 /* scheduling not possible, because: */
634 if (poll_state != GPRS_RLCMAC_POLL_NONE)
635 LOGP(DRLCMACDL, LOGL_DEBUG, "Polling is already "
636 "sheduled for %s, so we must wait for "
637 "requesting downlink ack\n", tbf_name(this));
638 else if (control_ts != ts)
639 LOGP(DRLCMACDL, LOGL_DEBUG, "Polling cannot be "
640 "sheduled in this TS %d, waiting for "
641 "TS %d\n", ts, control_ts);
Daniel Willmannca102af2014-08-08 12:14:12 +0200642 else if (bts->sba()->find(trx->trx_no, ts, (fn + 13) % 2715648))
643 LOGP(DRLCMACDL, LOGL_DEBUG, "Polling cannot be "
644 "sheduled, because single block alllocation "
645 "already exists\n");
646 else {
647 LOGP(DRLCMACDL, LOGL_DEBUG, "Polling sheduled in this "
648 "TS %d\n", ts);
649 m_tx_counter = 0;
650 /* start timer whenever we send the final block */
651 if (rh->fbi == 1)
652 tbf_timer_start(this, 3191, bts_data()->t3191, 0);
653
654 /* schedule polling */
655 poll_state = GPRS_RLCMAC_POLL_SCHED;
656 poll_fn = (fn + 13) % 2715648;
657
Daniel Willmannefd5dbb2014-08-25 16:20:23 +0200658 /* Clear poll timeout flag */
659 state_flags &= ~(1 << GPRS_RLCMAC_FLAG_TO_DL_ACK);
660
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100661 /* Clear request flag */
662 m_dl_ack_requested = false;
663
Daniel Willmannca102af2014-08-08 12:14:12 +0200664 /* set polling in header */
665 rh->rrbp = 0; /* N+13 */
666 rh->s_p = 1; /* Polling */
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +0100667
668 m_last_dl_poll_fn = poll_fn;
Daniel Willmannca102af2014-08-08 12:14:12 +0200669 }
670 }
671
672 /* return data block as message */
673 dl_msg = msgb_alloc(len, "rlcmac_dl_data");
674 if (!dl_msg)
675 return NULL;
676
677 /* Increment TX-counter */
678 m_tx_counter++;
679
680 memcpy(msgb_put(dl_msg, len), data, len);
681 bts->rlc_sent();
682
683 return dl_msg;
684}
685
686int gprs_rlcmac_dl_tbf::update_window(const uint8_t ssn, const uint8_t *rbb)
687{
688 int16_t dist; /* must be signed */
689 uint16_t lost = 0, received = 0;
690 char show_rbb[65];
691 char show_v_b[RLC_MAX_SNS + 1];
692 const uint16_t mod_sns = m_window.mod_sns();
693
694 Decoding::extract_rbb(rbb, show_rbb);
695 /* show received array in debug (bit 64..1) */
696 LOGP(DRLCMACDL, LOGL_DEBUG, "- ack: (BSN=%d)\"%s\""
697 "(BSN=%d) R=ACK I=NACK\n", (ssn - 64) & mod_sns,
698 show_rbb, (ssn - 1) & mod_sns);
699
700 /* apply received array to receive state (SSN-64..SSN-1) */
701 /* calculate distance of ssn from V(S) */
702 dist = (m_window.v_s() - ssn) & mod_sns;
703 /* check if distance is less than distance V(A)..V(S) */
704 if (dist >= m_window.distance()) {
705 /* this might happpen, if the downlink assignment
706 * was not received by ms and the ack refers
707 * to previous TBF
708 * FIXME: we should implement polling for
709 * control ack!*/
710 LOGP(DRLCMACDL, LOGL_NOTICE, "- ack range is out of "
711 "V(A)..V(S) range %s Free TBF!\n", tbf_name(this));
712 return 1; /* indicate to free TBF */
713 }
714
715 m_window.update(bts, show_rbb, ssn,
716 &lost, &received);
717
718 /* report lost and received packets */
719 gprs_rlcmac_received_lost(this, received, lost);
720
721 /* raise V(A), if possible */
722 m_window.raise(m_window.move_window());
723
724 /* show receive state array in debug (V(A)..V(S)-1) */
725 m_window.show_state(show_v_b);
726 LOGP(DRLCMACDL, LOGL_DEBUG, "- V(B): (V(A)=%d)\"%s\""
727 "(V(S)-1=%d) A=Acked N=Nacked U=Unacked "
728 "X=Resend-Unacked I=Invalid\n",
729 m_window.v_a(), show_v_b,
730 m_window.v_s_mod(-1));
731
732 if (state_is(GPRS_RLCMAC_FINISHED) && m_window.window_empty()) {
733 LOGP(DRLCMACDL, LOGL_NOTICE, "Received acknowledge of "
734 "all blocks, but without final ack "
735 "inidcation (don't worry)\n");
736 }
737 return 0;
738}
739
740
741int gprs_rlcmac_dl_tbf::maybe_start_new_window()
742{
743 struct msgb *msg;
744 uint16_t received;
745
746 LOGP(DRLCMACDL, LOGL_DEBUG, "- Final ACK received.\n");
747 /* range V(A)..V(S)-1 */
748 received = m_window.count_unacked();
749
750 /* report all outstanding packets as received */
751 gprs_rlcmac_received_lost(this, received, 0);
752
753 set_state(GPRS_RLCMAC_WAIT_RELEASE);
754
755 /* check for LLC PDU in the LLC Queue */
756 msg = llc_dequeue(gprs_bssgp_pcu_current_bctx());
757 if (!msg) {
758 /* no message, start T3193, change state to RELEASE */
759 LOGP(DRLCMACDL, LOGL_DEBUG, "- No new message, so we release.\n");
760 /* start T3193 */
761 tbf_timer_start(this, 3193,
762 bts_data()->t3193_msec / 1000,
763 (bts_data()->t3193_msec % 1000) * 1000);
764
765 return 0;
766 }
767
768 /* we have more data so we will re-use this tbf */
769 reuse_tbf(msg->data, msg->len);
770 msgb_free(msg);
771 return 0;
772}
773
774int gprs_rlcmac_dl_tbf::rcvd_dl_ack(uint8_t final_ack, uint8_t ssn, uint8_t *rbb)
775{
776 LOGP(DRLCMACDL, LOGL_DEBUG, "%s downlink acknowledge\n", tbf_name(this));
777
778 if (!final_ack)
779 return update_window(ssn, rbb);
780 return maybe_start_new_window();
781}
782
783void gprs_rlcmac_dl_tbf::reuse_tbf(const uint8_t *data, const uint16_t len)
784{
Daniel Willmanne4818152014-08-15 16:52:09 +0200785 uint8_t trx;
Jacob Erlbeck90de3a72015-04-09 19:18:59 +0200786 struct gprs_rlcmac_dl_tbf *new_tbf = NULL;
Daniel Willmanne4818152014-08-15 16:52:09 +0200787 int8_t tfi; /* must be signed */
Daniel Willmanne4818152014-08-15 16:52:09 +0200788 struct msgb *msg;
789
Daniel Willmannca102af2014-08-08 12:14:12 +0200790 bts->tbf_reused();
Daniel Willmanne4818152014-08-15 16:52:09 +0200791
792 tfi = bts->tfi_find_free(GPRS_RLCMAC_DL_TBF, &trx, this->trx->trx_no);
Jacob Erlbeck90de3a72015-04-09 19:18:59 +0200793 if (tfi >= 0)
794 new_tbf = tbf_alloc_dl_tbf(bts->bts_data(), NULL, tfi, trx,
795 ms_class, 0);
796
Daniel Willmanne4818152014-08-15 16:52:09 +0200797 if (!new_tbf) {
798 LOGP(DRLCMAC, LOGL_NOTICE, "No PDCH resource\n");
Jacob Erlbeck90de3a72015-04-09 19:18:59 +0200799 bssgp_tx_llc_discarded(gprs_bssgp_pcu_current_bctx(), m_tlli,
800 1, len);
Jacob Erlbeck29d91e92015-04-29 14:46:52 +0200801 bts->llc_dropped_frame();
Daniel Willmanne4818152014-08-15 16:52:09 +0200802 return;
803 }
804
805 new_tbf->m_tlli = m_tlli;
806 new_tbf->m_tlli_valid = m_tlli_valid;
807 new_tbf->ta = ta;
808 new_tbf->assign_imsi(m_imsi);
Jacob Erlbeckfecece02015-05-08 12:13:08 +0200809 new_tbf->update_ms(m_tlli);
Daniel Willmanne4818152014-08-15 16:52:09 +0200810
811 /* Copy over all data to the new TBF */
812 new_tbf->m_llc.put_frame(data, len);
Daniel Willmannca102af2014-08-08 12:14:12 +0200813 bts->llc_frame_sched();
814
Daniel Willmanne4818152014-08-15 16:52:09 +0200815 while ((msg = m_llc.dequeue()))
816 new_tbf->m_llc.enqueue(msg);
817
Daniel Willmannca102af2014-08-08 12:14:12 +0200818 /* reset rlc states */
819 m_tx_counter = 0;
820 m_wait_confirm = 0;
821 m_window.reset();
822
Jacob Erlbeck297edf72015-02-26 14:59:52 +0100823 /* mark TLLI as invalid */
824 m_tlli_valid = 0;
825
Daniel Willmannca102af2014-08-08 12:14:12 +0200826 /* keep to flags */
827 state_flags &= GPRS_RLCMAC_FLAG_TO_MASK;
828 state_flags &= ~(1 << GPRS_RLCMAC_FLAG_CCCH);
829
830 update();
831
832 LOGP(DRLCMAC, LOGL_DEBUG, "%s Trigger dowlink assignment on PACCH, "
833 "because another LLC PDU has arrived in between\n",
834 tbf_name(this));
Daniel Willmanne4818152014-08-15 16:52:09 +0200835 bts->trigger_dl_ass(new_tbf, this, NULL);
Daniel Willmannca102af2014-08-08 12:14:12 +0200836}
837
838bool gprs_rlcmac_dl_tbf::dl_window_stalled() const
839{
840 return m_window.window_stalled();
841}
842
Jacob Erlbeckeceb9102015-03-20 14:41:50 +0100843void gprs_rlcmac_dl_tbf::request_dl_ack()
844{
845 m_dl_ack_requested = true;
846}
847
848bool gprs_rlcmac_dl_tbf::need_control_ts() const
849{
850 if (poll_state != GPRS_RLCMAC_POLL_NONE)
851 return false;
852
853 return state_flags & (1 << GPRS_RLCMAC_FLAG_TO_DL_ACK) ||
854 m_tx_counter >= POLL_ACK_AFTER_FRAMES ||
855 m_dl_ack_requested;
856}
857
858bool gprs_rlcmac_dl_tbf::have_data() const
859{
860 return m_llc.chunk_size() > 0 || !llist_empty(&m_llc.queue);
861}
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +0100862
863int gprs_rlcmac_dl_tbf::frames_since_last_poll(unsigned fn) const
864{
865 unsigned wrapped;
866 if (m_last_dl_poll_fn < 0)
867 return -1;
868
869 wrapped = (fn + 2715648 - m_last_dl_poll_fn) % 2715648;
870 if (wrapped < 2715648/2)
871 return wrapped;
872 else
873 return wrapped - 2715648;
874}
875
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100876int gprs_rlcmac_dl_tbf::frames_since_last_drain(unsigned fn) const
877{
878 unsigned wrapped;
879 if (m_last_dl_drained_fn < 0)
880 return -1;
881
882 wrapped = (fn + 2715648 - m_last_dl_drained_fn) % 2715648;
883 if (wrapped < 2715648/2)
884 return wrapped;
885 else
886 return wrapped - 2715648;
887}
888
889bool gprs_rlcmac_dl_tbf::keep_open(unsigned fn) const
890{
891 int keep_time_frames;
892
893 if (bts_data()->dl_tbf_idle_msec <= 0)
894 return false;
895
896 keep_time_frames = msecs_to_frames(bts_data()->dl_tbf_idle_msec);
897 return frames_since_last_drain(fn) <= keep_time_frames;
898}