blob: 0aa22f90a0db2d115e0f243aca195d742d959f40 [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,
138 const uint32_t tlli, const char *imsi)
139{
140 /* TODO: look up by IMSI first, then tlli, then old_tlli */
141 return bts->dl_tbf_by_tlli(tlli);
142}
143
144static int tbf_new_dl_assignment(struct gprs_rlcmac_bts *bts,
145 const char *imsi,
146 const uint32_t tlli, const uint8_t ms_class,
147 const uint8_t *data, const uint16_t len)
148{
149 uint8_t trx, ta, ss;
150 int8_t use_trx;
151 struct gprs_rlcmac_ul_tbf *ul_tbf, *old_ul_tbf;
Jacob Erlbeck90de3a72015-04-09 19:18:59 +0200152 struct gprs_rlcmac_dl_tbf *dl_tbf = NULL;
Daniel Willmannca102af2014-08-08 12:14:12 +0200153 int8_t tfi; /* must be signed */
154 int rc;
155
156 /* check for uplink data, so we copy our informations */
157#warning "Do the same look up for IMSI, TLLI and OLD_TLLI"
158#warning "Refactor the below lines... into a new method"
159 ul_tbf = bts->bts->ul_tbf_by_tlli(tlli);
160 if (ul_tbf && ul_tbf->m_contention_resolution_done
161 && !ul_tbf->m_final_ack_sent) {
162 use_trx = ul_tbf->trx->trx_no;
163 ta = ul_tbf->ta;
164 ss = 0;
165 old_ul_tbf = ul_tbf;
166 } else {
167 use_trx = -1;
168 /* we already have an uplink TBF, so we use that TA */
169 if (ul_tbf)
170 ta = ul_tbf->ta;
171 else {
172 /* recall TA */
173 rc = bts->bts->timing_advance()->recall(tlli);
174 if (rc < 0) {
175 LOGP(DRLCMAC, LOGL_NOTICE, "TA unknown"
176 ", assuming 0\n");
177 ta = 0;
178 } else
179 ta = rc;
180 }
181 ss = 1; /* PCH assignment only allows one timeslot */
182 old_ul_tbf = NULL;
183 }
184
185 // Create new TBF (any TRX)
186#warning "Copy and paste with alloc_ul_tbf"
187 tfi = bts->bts->tfi_find_free(GPRS_RLCMAC_DL_TBF, &trx, use_trx);
Jacob Erlbeck90de3a72015-04-09 19:18:59 +0200188 if (tfi >= 0)
189 /* set number of downlink slots according to multislot class */
190 dl_tbf = tbf_alloc_dl_tbf(bts, ul_tbf, tfi, trx, ms_class, ss);
191
Daniel Willmannca102af2014-08-08 12:14:12 +0200192 if (!dl_tbf) {
193 LOGP(DRLCMAC, LOGL_NOTICE, "No PDCH resource\n");
Jacob Erlbeck90de3a72015-04-09 19:18:59 +0200194 bssgp_tx_llc_discarded(gprs_bssgp_pcu_current_bctx(), tlli,
195 1, len);
Jacob Erlbeck29d91e92015-04-29 14:46:52 +0200196 bts->bts->llc_dropped_frame();
Daniel Willmannca102af2014-08-08 12:14:12 +0200197 return -EBUSY;
198 }
199 dl_tbf->m_tlli = tlli;
200 dl_tbf->m_tlli_valid = 1;
201 dl_tbf->ta = ta;
202
203 LOGP(DRLCMAC, LOGL_DEBUG, "%s [DOWNLINK] START\n", tbf_name(dl_tbf));
204
205 /* new TBF, so put first frame */
206 dl_tbf->m_llc.put_frame(data, len);
207 dl_tbf->bts->llc_frame_sched();
208
209 /* Store IMSI for later look-up and PCH retransmission */
210 dl_tbf->assign_imsi(imsi);
211
212 /* trigger downlink assignment and set state to ASSIGN.
213 * we don't use old_downlink, so the possible uplink is used
214 * to trigger downlink assignment. if there is no uplink,
215 * AGCH is used. */
216 dl_tbf->bts->trigger_dl_ass(dl_tbf, old_ul_tbf, imsi);
217 return 0;
218}
219
220/**
221 * TODO: split into unit test-able parts...
222 */
223int gprs_rlcmac_dl_tbf::handle(struct gprs_rlcmac_bts *bts,
224 const uint32_t tlli, const char *imsi,
225 const uint8_t ms_class, const uint16_t delay_csec,
226 const uint8_t *data, const uint16_t len)
227{
228 struct gprs_rlcmac_dl_tbf *dl_tbf;
229
230 /* check for existing TBF */
231 dl_tbf = tbf_lookup_dl(bts->bts, tlli, imsi);
232 if (dl_tbf) {
233 int rc = dl_tbf->append_data(ms_class, delay_csec, data, len);
234 if (rc >= 0)
235 dl_tbf->assign_imsi(imsi);
236 return rc;
237 }
238
239 return tbf_new_dl_assignment(bts, imsi, tlli, ms_class, data, len);
240}
241
242struct msgb *gprs_rlcmac_dl_tbf::llc_dequeue(bssgp_bvc_ctx *bctx)
243{
244 struct msgb *msg;
Jacob Erlbeck6e4ccec2015-05-06 14:24:36 +0200245 struct timeval *tv_recv, *tv_disc;
246 struct timeval tv_now, tv_now2;
Daniel Willmannca102af2014-08-08 12:14:12 +0200247 uint32_t octets = 0, frames = 0;
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100248 struct timeval hyst_delta = {0, 0};
249 const unsigned keep_small_thresh = 60;
250
251 if (bts_data()->llc_discard_csec)
252 csecs_to_timeval(bts_data()->llc_discard_csec, &hyst_delta);
Daniel Willmannca102af2014-08-08 12:14:12 +0200253
254 gettimeofday(&tv_now, NULL);
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100255 timeradd(&tv_now, &hyst_delta, &tv_now2);
Daniel Willmannca102af2014-08-08 12:14:12 +0200256
257 while ((msg = m_llc.dequeue())) {
Jacob Erlbeck6e4ccec2015-05-06 14:24:36 +0200258 tv_disc = (struct timeval *)msg->data;
259 msgb_pull(msg, sizeof(*tv_disc));
260 tv_recv = (struct timeval *)msg->data;
261 msgb_pull(msg, sizeof(*tv_recv));
262
263 gprs_bssgp_update_queue_delay(tv_recv, &tv_now);
Daniel Willmannca102af2014-08-08 12:14:12 +0200264
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100265 /* Is the age below the low water mark? */
Jacob Erlbeck6e4ccec2015-05-06 14:24:36 +0200266 if (!gprs_llc::is_frame_expired(&tv_now2, tv_disc))
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100267 break;
268
269 /* Is the age below the high water mark */
Jacob Erlbeck6e4ccec2015-05-06 14:24:36 +0200270 if (!gprs_llc::is_frame_expired(&tv_now, tv_disc)) {
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100271 /* Has the previous message not been dropped? */
272 if (frames == 0)
273 break;
274
275 /* Hysteresis mode, try to discard LLC messages until
276 * the low water mark has been reached */
277
278 /* Check whether to abort the hysteresis mode */
279
280 /* Is the frame small, perhaps only a TCP ACK? */
281 if (msg->len <= keep_small_thresh)
282 break;
283
284 /* Is it a GMM message? */
285 if (!gprs_llc::is_user_data_frame(msg->data, msg->len))
286 break;
Daniel Willmannca102af2014-08-08 12:14:12 +0200287 }
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100288
289 bts->llc_timedout_frame();
290 frames++;
291 octets += msg->len;
292 msgb_free(msg);
Jacob Erlbeck29d91e92015-04-29 14:46:52 +0200293 bts->llc_dropped_frame();
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100294 continue;
Daniel Willmannca102af2014-08-08 12:14:12 +0200295 }
296
297 if (frames) {
Jacob Erlbeck0c1c8772015-03-20 12:02:42 +0100298 LOGP(DRLCMACDL, LOGL_NOTICE, "%s Discarding LLC PDU "
299 "because lifetime limit reached, "
300 "count=%u new_queue_size=%zu\n",
301 tbf_name(this), frames, m_llc.m_queue_size);
Daniel Willmannca102af2014-08-08 12:14:12 +0200302 if (frames > 0xff)
303 frames = 0xff;
304 if (octets > 0xffffff)
305 octets = 0xffffff;
306 bssgp_tx_llc_discarded(bctx, m_tlli, frames, octets);
307 }
308
309 return msg;
310}
311
312/*
313 * Create DL data block
314 * The messages are fragmented and forwarded as data blocks.
315 */
316struct msgb *gprs_rlcmac_dl_tbf::create_dl_acked_block(uint32_t fn, uint8_t ts)
317{
318 LOGP(DRLCMACDL, LOGL_DEBUG, "%s downlink (V(A)==%d .. "
319 "V(S)==%d)\n", tbf_name(this),
320 m_window.v_a(), m_window.v_s());
321
322do_resend:
323 /* check if there is a block with negative acknowledgement */
324 int resend_bsn = m_window.resend_needed();
325 if (resend_bsn >= 0) {
326 LOGP(DRLCMACDL, LOGL_DEBUG, "- Resending BSN %d\n", resend_bsn);
327 /* re-send block with negative aknowlegement */
328 m_window.m_v_b.mark_unacked(resend_bsn);
329 bts->rlc_resent();
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100330 return create_dl_acked_block(fn, ts, resend_bsn);
Daniel Willmannca102af2014-08-08 12:14:12 +0200331 }
332
333 /* if the window has stalled, or transfer is complete,
334 * send an unacknowledged block */
Jacob Erlbeck95340242015-03-19 13:22:07 +0100335 if (state_is(GPRS_RLCMAC_FINISHED)) {
336 LOGP(DRLCMACDL, LOGL_DEBUG, "- Restarting at BSN %d, "
337 "because all blocks have been transmitted.\n",
338 m_window.v_a());
339 bts->rlc_restarted();
340 } else if (dl_window_stalled()) {
341 LOGP(DRLCMACDL, LOGL_NOTICE, "- Restarting at BSN %d, "
342 "because all window is stalled.\n",
343 m_window.v_a());
344 bts->rlc_stalled();
Jacob Erlbecke25b5b92015-03-19 14:21:33 +0100345 } else if (have_data()) {
346 /* New blocks may be send */
347 return create_new_bsn(fn, ts);
348 } else if (!m_window.window_empty()) {
349 LOGP(DRLCMACDL, LOGL_DEBUG, "- Restarting at BSN %d, "
350 "because all blocks have been transmitted (FLOW).\n",
351 m_window.v_a());
352 bts->rlc_restarted();
Jacob Erlbeck95340242015-03-19 13:22:07 +0100353 } else {
Jacob Erlbecke25b5b92015-03-19 14:21:33 +0100354 /* Nothing left to send, create dummy LLC commands */
Jacob Erlbeck95340242015-03-19 13:22:07 +0100355 return create_new_bsn(fn, ts);
Daniel Willmannca102af2014-08-08 12:14:12 +0200356 }
357
Jacob Erlbeck95340242015-03-19 13:22:07 +0100358 /* If V(S) == V(A) and finished state, we would have received
359 * acknowledgement of all transmitted block. In this case we
360 * would have transmitted the final block, and received ack
361 * from MS. But in this case we did not receive the final ack
362 * indication from MS. This should never happen if MS works
363 * correctly. */
364 if (m_window.window_empty()) {
365 LOGP(DRLCMACDL, LOGL_DEBUG, "- MS acked all blocks, "
366 "so we re-transmit final block!\n");
367 /* we just send final block again */
368 int16_t index = m_window.v_s_mod(-1);
369 bts->rlc_resent();
370 return create_dl_acked_block(fn, ts, index);
371 }
372
373 /* cycle through all unacked blocks */
374 int resend = m_window.mark_for_resend();
375
376 /* At this point there should be at least one unacked block
377 * to be resent. If not, this is an software error. */
378 if (resend == 0) {
379 LOGP(DRLCMACDL, LOGL_ERROR, "Software error: "
380 "There are no unacknowledged blocks, but V(A) "
381 " != V(S). PLEASE FIX!\n");
382 /* we just send final block again */
383 int16_t index = m_window.v_s_mod(-1);
384 return create_dl_acked_block(fn, ts, index);
385 }
386 goto do_resend;
Daniel Willmannca102af2014-08-08 12:14:12 +0200387}
388
389struct msgb *gprs_rlcmac_dl_tbf::create_new_bsn(const uint32_t fn, const uint8_t ts)
390{
391 struct rlc_dl_header *rh;
392 struct rlc_li_field *li;
393 struct msgb *msg;
394 uint8_t *delimiter, *data, *e_pointer;
395 uint16_t space, chunk;
396 gprs_rlc_data *rlc_data;
Daniel Willmannca102af2014-08-08 12:14:12 +0200397 const uint16_t bsn = m_window.v_s();
398
399 LOGP(DRLCMACDL, LOGL_DEBUG, "- Sending new block at BSN %d\n",
400 m_window.v_s());
401
402#warning "Selection of the CS doesn't belong here"
403 if (cs == 0) {
404 cs = bts_data()->initial_cs_dl;
405 if (cs < 1 || cs > 4)
406 cs = 1;
407 }
408 /* total length of block, including spare bits */
409 const uint8_t block_length = gprs_rlcmac_cs[cs].block_length;
410 /* length of usable data of block, w/o spare bits, inc. MAC */
411 const uint8_t block_data_len = gprs_rlcmac_cs[cs].block_data;
412
413 /* now we still have untransmitted LLC data, so we fill mac block */
414 rlc_data = m_rlc.block(bsn);
415 data = rlc_data->prepare(block_data_len);
416
417 rh = (struct rlc_dl_header *)data;
418 rh->pt = 0; /* Data Block */
419 rh->rrbp = rh->s_p = 0; /* Polling, set later, if required */
420 rh->usf = 7; /* will be set at scheduler */
421 rh->pr = 0; /* FIXME: power reduction */
422 rh->tfi = m_tfi; /* TFI */
423 rh->fbi = 0; /* Final Block Indicator, set late, if true */
424 rh->bsn = bsn; /* Block Sequence Number */
425 rh->e = 0; /* Extension bit, maybe set later */
426 e_pointer = data + 2; /* points to E of current chunk */
427 data += sizeof(*rh);
428 delimiter = data; /* where next length header would be stored */
429 space = block_data_len - sizeof(*rh);
430 while (1) {
Jacob Erlbeckcbb1e702015-03-25 12:21:55 +0100431 if (m_llc.frame_length() == 0) {
432 /* A header will need to by added, so we just need
433 * space-1 octets */
434 m_llc.put_dummy_frame(space - 1);
435
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100436 /* The data just drained, store the current fn */
437 if (m_last_dl_drained_fn < 0)
438 m_last_dl_drained_fn = fn;
439
Jacob Erlbeckcbb1e702015-03-25 12:21:55 +0100440 /* It is not clear, when the next real data will
441 * arrive, so request a DL ack/nack now */
442 request_dl_ack();
443
444 LOGP(DRLCMACDL, LOGL_DEBUG,
445 "-- Empty chunk, "
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100446 "added LLC dummy command of size %d, "
447 "drained_since=%d\n",
448 m_llc.frame_length(), frames_since_last_drain(fn));
Jacob Erlbeckcbb1e702015-03-25 12:21:55 +0100449 }
450
Daniel Willmannca102af2014-08-08 12:14:12 +0200451 chunk = m_llc.chunk_size();
Jacob Erlbeckcbb1e702015-03-25 12:21:55 +0100452
Daniel Willmannca102af2014-08-08 12:14:12 +0200453 /* if chunk will exceed block limit */
454 if (chunk > space) {
455 LOGP(DRLCMACDL, LOGL_DEBUG, "-- Chunk with length %d "
456 "larger than space (%d) left in block: copy "
457 "only remaining space, and we are done\n",
458 chunk, space);
459 /* block is filled, so there is no extension */
460 *e_pointer |= 0x01;
461 /* fill only space */
462 m_llc.consume(data, space);
463 /* return data block as message */
464 break;
465 }
466 /* if FINAL chunk would fit precisely in space left */
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100467 if (chunk == space && llist_empty(&m_llc.queue) && !keep_open(fn))
468 {
Daniel Willmannca102af2014-08-08 12:14:12 +0200469 LOGP(DRLCMACDL, LOGL_DEBUG, "-- Chunk with length %d "
470 "would exactly fit into space (%d): because "
471 "this is a final block, we don't add length "
472 "header, and we are done\n", chunk, space);
473 LOGP(DRLCMACDL, LOGL_INFO, "Complete DL frame for "
474 "%s that fits precisely in last block: "
475 "len=%d\n", tbf_name(this), m_llc.frame_length());
476 gprs_rlcmac_dl_bw(this, m_llc.frame_length());
477 /* block is filled, so there is no extension */
478 *e_pointer |= 0x01;
479 /* fill space */
480 m_llc.consume(data, space);
481 m_llc.reset();
482 /* final block */
483 rh->fbi = 1; /* we indicate final block */
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100484 request_dl_ack();
Daniel Willmannca102af2014-08-08 12:14:12 +0200485 set_state(GPRS_RLCMAC_FINISHED);
486 /* return data block as message */
487 break;
488 }
489 /* if chunk would fit exactly in space left */
490 if (chunk == space) {
491 LOGP(DRLCMACDL, LOGL_DEBUG, "-- Chunk with length %d "
492 "would exactly fit into space (%d): add length "
493 "header with LI=0, to make frame extend to "
494 "next block, and we are done\n", chunk, space);
495 /* make space for delimiter */
496 if (delimiter != data)
497 memmove(delimiter + 1, delimiter,
498 data - delimiter);
499 data++;
500 space--;
501 /* add LI with 0 length */
502 li = (struct rlc_li_field *)delimiter;
503 li->e = 1; /* not more extension */
504 li->m = 0; /* shall be set to 0, in case of li = 0 */
505 li->li = 0; /* chunk fills the complete space */
506 // no need to set e_pointer nor increase delimiter
507 /* fill only space, which is 1 octet less than chunk */
508 m_llc.consume(data, space);
509 /* return data block as message */
510 break;
511 }
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100512
Daniel Willmannca102af2014-08-08 12:14:12 +0200513 LOGP(DRLCMACDL, LOGL_DEBUG, "-- Chunk with length %d is less "
514 "than remaining space (%d): add length header to "
515 "to delimit LLC frame\n", chunk, space);
516 /* the LLC frame chunk ends in this block */
517 /* make space for delimiter */
518 if (delimiter != data)
519 memmove(delimiter + 1, delimiter, data - delimiter);
520 data++;
521 space--;
522 /* add LI to delimit frame */
523 li = (struct rlc_li_field *)delimiter;
524 li->e = 0; /* Extension bit, maybe set later */
525 li->m = 0; /* will be set later, if there is more LLC data */
526 li->li = chunk; /* length of chunk */
527 e_pointer = delimiter; /* points to E of current delimiter */
528 delimiter++;
529 /* copy (rest of) LLC frame to space and reset later */
530 m_llc.consume(data, chunk);
531 data += chunk;
532 space -= chunk;
533 LOGP(DRLCMACDL, LOGL_INFO, "Complete DL frame for %s"
534 "len=%d\n", tbf_name(this), m_llc.frame_length());
535 gprs_rlcmac_dl_bw(this, m_llc.frame_length());
536 m_llc.reset();
537 /* dequeue next LLC frame, if any */
538 msg = llc_dequeue(gprs_bssgp_pcu_current_bctx());
539 if (msg) {
540 LOGP(DRLCMACDL, LOGL_INFO, "- Dequeue next LLC for "
541 "%s (len=%d)\n", tbf_name(this), msg->len);
542 m_llc.put_frame(msg->data, msg->len);
543 bts->llc_frame_sched();
544 msgb_free(msg);
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100545 m_last_dl_drained_fn = -1;
Daniel Willmannca102af2014-08-08 12:14:12 +0200546 }
547 /* if we have more data and we have space left */
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100548 if (space > 0 && (m_llc.frame_length() || keep_open(fn))) {
Daniel Willmannca102af2014-08-08 12:14:12 +0200549 li->m = 1; /* we indicate more frames to follow */
550 continue;
551 }
552 /* if we don't have more LLC frames */
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100553 if (!m_llc.frame_length() && !keep_open(fn)) {
Daniel Willmannca102af2014-08-08 12:14:12 +0200554 LOGP(DRLCMACDL, LOGL_DEBUG, "-- Final block, so we "
555 "done.\n");
556 li->e = 1; /* we cannot extend */
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100557
Daniel Willmannca102af2014-08-08 12:14:12 +0200558 rh->fbi = 1; /* we indicate final block */
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100559 request_dl_ack();
Daniel Willmannca102af2014-08-08 12:14:12 +0200560 set_state(GPRS_RLCMAC_FINISHED);
561 break;
562 }
563 /* we have no space left */
564 LOGP(DRLCMACDL, LOGL_DEBUG, "-- No space left, so we are "
565 "done.\n");
566 li->e = 1; /* we cannot extend */
567 break;
568 }
569 LOGP(DRLCMACDL, LOGL_DEBUG, "data block: %s\n",
570 osmo_hexdump(rlc_data->block, block_length));
571#warning "move this up?"
572 rlc_data->len = block_length;
573 /* raise send state and set ack state array */
574 m_window.m_v_b.mark_unacked(bsn);
575 m_window.increment_send();
576
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100577 return create_dl_acked_block(fn, ts, bsn);
578}
579
Daniel Willmannca102af2014-08-08 12:14:12 +0200580struct msgb *gprs_rlcmac_dl_tbf::create_dl_acked_block(
581 const uint32_t fn, const uint8_t ts,
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100582 const int index)
Daniel Willmannca102af2014-08-08 12:14:12 +0200583{
584 uint8_t *data;
585 struct rlc_dl_header *rh;
586 struct msgb *dl_msg;
587 uint8_t len;
Daniel Willmannefd5dbb2014-08-25 16:20:23 +0200588 bool need_poll;
Daniel Willmannca102af2014-08-08 12:14:12 +0200589
590 /* get data and header from current block */
591 data = m_rlc.block(index)->block;
592 len = m_rlc.block(index)->len;
593 rh = (struct rlc_dl_header *)data;
594
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +0100595 /* If the TBF has just started, relate frames_since_last_poll to the
596 * current fn */
597 if (m_last_dl_poll_fn < 0)
598 m_last_dl_poll_fn = fn;
599
Daniel Willmannefd5dbb2014-08-25 16:20:23 +0200600 need_poll = state_flags & (1 << GPRS_RLCMAC_FLAG_TO_DL_ACK);
Daniel Willmannca102af2014-08-08 12:14:12 +0200601 /* Clear Polling, if still set in history buffer */
602 rh->s_p = 0;
603
604 /* poll after POLL_ACK_AFTER_FRAMES frames, or when final block is tx.
605 */
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100606 if (m_tx_counter >= POLL_ACK_AFTER_FRAMES || m_dl_ack_requested ||
Daniel Willmannefd5dbb2014-08-25 16:20:23 +0200607 need_poll) {
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100608 if (m_dl_ack_requested) {
Daniel Willmannca102af2014-08-08 12:14:12 +0200609 LOGP(DRLCMACDL, LOGL_DEBUG, "- Scheduling Ack/Nack "
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100610 "polling, because is was requested explicitly "
611 "(e.g. first final block sent).\n");
Daniel Willmannefd5dbb2014-08-25 16:20:23 +0200612 } else if (need_poll) {
613 LOGP(DRLCMACDL, LOGL_DEBUG, "- Scheduling Ack/Nack "
Daniel Willmann635d47c2014-09-17 17:58:29 +0200614 "polling, because polling timed out.\n");
Daniel Willmannca102af2014-08-08 12:14:12 +0200615 } else {
616 LOGP(DRLCMACDL, LOGL_DEBUG, "- Scheduling Ack/Nack "
617 "polling, because %d blocks sent.\n",
618 POLL_ACK_AFTER_FRAMES);
619 }
620 /* scheduling not possible, because: */
621 if (poll_state != GPRS_RLCMAC_POLL_NONE)
622 LOGP(DRLCMACDL, LOGL_DEBUG, "Polling is already "
623 "sheduled for %s, so we must wait for "
624 "requesting downlink ack\n", tbf_name(this));
625 else if (control_ts != ts)
626 LOGP(DRLCMACDL, LOGL_DEBUG, "Polling cannot be "
627 "sheduled in this TS %d, waiting for "
628 "TS %d\n", ts, control_ts);
Daniel Willmannca102af2014-08-08 12:14:12 +0200629 else if (bts->sba()->find(trx->trx_no, ts, (fn + 13) % 2715648))
630 LOGP(DRLCMACDL, LOGL_DEBUG, "Polling cannot be "
631 "sheduled, because single block alllocation "
632 "already exists\n");
633 else {
634 LOGP(DRLCMACDL, LOGL_DEBUG, "Polling sheduled in this "
635 "TS %d\n", ts);
636 m_tx_counter = 0;
637 /* start timer whenever we send the final block */
638 if (rh->fbi == 1)
639 tbf_timer_start(this, 3191, bts_data()->t3191, 0);
640
641 /* schedule polling */
642 poll_state = GPRS_RLCMAC_POLL_SCHED;
643 poll_fn = (fn + 13) % 2715648;
644
Daniel Willmannefd5dbb2014-08-25 16:20:23 +0200645 /* Clear poll timeout flag */
646 state_flags &= ~(1 << GPRS_RLCMAC_FLAG_TO_DL_ACK);
647
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100648 /* Clear request flag */
649 m_dl_ack_requested = false;
650
Daniel Willmannca102af2014-08-08 12:14:12 +0200651 /* set polling in header */
652 rh->rrbp = 0; /* N+13 */
653 rh->s_p = 1; /* Polling */
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +0100654
655 m_last_dl_poll_fn = poll_fn;
Daniel Willmannca102af2014-08-08 12:14:12 +0200656 }
657 }
658
659 /* return data block as message */
660 dl_msg = msgb_alloc(len, "rlcmac_dl_data");
661 if (!dl_msg)
662 return NULL;
663
664 /* Increment TX-counter */
665 m_tx_counter++;
666
667 memcpy(msgb_put(dl_msg, len), data, len);
668 bts->rlc_sent();
669
670 return dl_msg;
671}
672
673int gprs_rlcmac_dl_tbf::update_window(const uint8_t ssn, const uint8_t *rbb)
674{
675 int16_t dist; /* must be signed */
676 uint16_t lost = 0, received = 0;
677 char show_rbb[65];
678 char show_v_b[RLC_MAX_SNS + 1];
679 const uint16_t mod_sns = m_window.mod_sns();
680
681 Decoding::extract_rbb(rbb, show_rbb);
682 /* show received array in debug (bit 64..1) */
683 LOGP(DRLCMACDL, LOGL_DEBUG, "- ack: (BSN=%d)\"%s\""
684 "(BSN=%d) R=ACK I=NACK\n", (ssn - 64) & mod_sns,
685 show_rbb, (ssn - 1) & mod_sns);
686
687 /* apply received array to receive state (SSN-64..SSN-1) */
688 /* calculate distance of ssn from V(S) */
689 dist = (m_window.v_s() - ssn) & mod_sns;
690 /* check if distance is less than distance V(A)..V(S) */
691 if (dist >= m_window.distance()) {
692 /* this might happpen, if the downlink assignment
693 * was not received by ms and the ack refers
694 * to previous TBF
695 * FIXME: we should implement polling for
696 * control ack!*/
697 LOGP(DRLCMACDL, LOGL_NOTICE, "- ack range is out of "
698 "V(A)..V(S) range %s Free TBF!\n", tbf_name(this));
699 return 1; /* indicate to free TBF */
700 }
701
702 m_window.update(bts, show_rbb, ssn,
703 &lost, &received);
704
705 /* report lost and received packets */
706 gprs_rlcmac_received_lost(this, received, lost);
707
708 /* raise V(A), if possible */
709 m_window.raise(m_window.move_window());
710
711 /* show receive state array in debug (V(A)..V(S)-1) */
712 m_window.show_state(show_v_b);
713 LOGP(DRLCMACDL, LOGL_DEBUG, "- V(B): (V(A)=%d)\"%s\""
714 "(V(S)-1=%d) A=Acked N=Nacked U=Unacked "
715 "X=Resend-Unacked I=Invalid\n",
716 m_window.v_a(), show_v_b,
717 m_window.v_s_mod(-1));
718
719 if (state_is(GPRS_RLCMAC_FINISHED) && m_window.window_empty()) {
720 LOGP(DRLCMACDL, LOGL_NOTICE, "Received acknowledge of "
721 "all blocks, but without final ack "
722 "inidcation (don't worry)\n");
723 }
724 return 0;
725}
726
727
728int gprs_rlcmac_dl_tbf::maybe_start_new_window()
729{
730 struct msgb *msg;
731 uint16_t received;
732
733 LOGP(DRLCMACDL, LOGL_DEBUG, "- Final ACK received.\n");
734 /* range V(A)..V(S)-1 */
735 received = m_window.count_unacked();
736
737 /* report all outstanding packets as received */
738 gprs_rlcmac_received_lost(this, received, 0);
739
740 set_state(GPRS_RLCMAC_WAIT_RELEASE);
741
742 /* check for LLC PDU in the LLC Queue */
743 msg = llc_dequeue(gprs_bssgp_pcu_current_bctx());
744 if (!msg) {
745 /* no message, start T3193, change state to RELEASE */
746 LOGP(DRLCMACDL, LOGL_DEBUG, "- No new message, so we release.\n");
747 /* start T3193 */
748 tbf_timer_start(this, 3193,
749 bts_data()->t3193_msec / 1000,
750 (bts_data()->t3193_msec % 1000) * 1000);
751
752 return 0;
753 }
754
755 /* we have more data so we will re-use this tbf */
756 reuse_tbf(msg->data, msg->len);
757 msgb_free(msg);
758 return 0;
759}
760
761int gprs_rlcmac_dl_tbf::rcvd_dl_ack(uint8_t final_ack, uint8_t ssn, uint8_t *rbb)
762{
763 LOGP(DRLCMACDL, LOGL_DEBUG, "%s downlink acknowledge\n", tbf_name(this));
764
765 if (!final_ack)
766 return update_window(ssn, rbb);
767 return maybe_start_new_window();
768}
769
770void gprs_rlcmac_dl_tbf::reuse_tbf(const uint8_t *data, const uint16_t len)
771{
Daniel Willmanne4818152014-08-15 16:52:09 +0200772 uint8_t trx;
Jacob Erlbeck90de3a72015-04-09 19:18:59 +0200773 struct gprs_rlcmac_dl_tbf *new_tbf = NULL;
Daniel Willmanne4818152014-08-15 16:52:09 +0200774 int8_t tfi; /* must be signed */
Daniel Willmanne4818152014-08-15 16:52:09 +0200775 struct msgb *msg;
776
Daniel Willmannca102af2014-08-08 12:14:12 +0200777 bts->tbf_reused();
Daniel Willmanne4818152014-08-15 16:52:09 +0200778
779 tfi = bts->tfi_find_free(GPRS_RLCMAC_DL_TBF, &trx, this->trx->trx_no);
Jacob Erlbeck90de3a72015-04-09 19:18:59 +0200780 if (tfi >= 0)
781 new_tbf = tbf_alloc_dl_tbf(bts->bts_data(), NULL, tfi, trx,
782 ms_class, 0);
783
Daniel Willmanne4818152014-08-15 16:52:09 +0200784 if (!new_tbf) {
785 LOGP(DRLCMAC, LOGL_NOTICE, "No PDCH resource\n");
Jacob Erlbeck90de3a72015-04-09 19:18:59 +0200786 bssgp_tx_llc_discarded(gprs_bssgp_pcu_current_bctx(), m_tlli,
787 1, len);
Jacob Erlbeck29d91e92015-04-29 14:46:52 +0200788 bts->llc_dropped_frame();
Daniel Willmanne4818152014-08-15 16:52:09 +0200789 return;
790 }
791
792 new_tbf->m_tlli = m_tlli;
793 new_tbf->m_tlli_valid = m_tlli_valid;
794 new_tbf->ta = ta;
795 new_tbf->assign_imsi(m_imsi);
796
797 /* Copy over all data to the new TBF */
798 new_tbf->m_llc.put_frame(data, len);
Daniel Willmannca102af2014-08-08 12:14:12 +0200799 bts->llc_frame_sched();
800
Daniel Willmanne4818152014-08-15 16:52:09 +0200801 while ((msg = m_llc.dequeue()))
802 new_tbf->m_llc.enqueue(msg);
803
Daniel Willmannca102af2014-08-08 12:14:12 +0200804 /* reset rlc states */
805 m_tx_counter = 0;
806 m_wait_confirm = 0;
807 m_window.reset();
808
Jacob Erlbeck297edf72015-02-26 14:59:52 +0100809 /* mark TLLI as invalid */
810 m_tlli_valid = 0;
811
Daniel Willmannca102af2014-08-08 12:14:12 +0200812 /* keep to flags */
813 state_flags &= GPRS_RLCMAC_FLAG_TO_MASK;
814 state_flags &= ~(1 << GPRS_RLCMAC_FLAG_CCCH);
815
816 update();
817
818 LOGP(DRLCMAC, LOGL_DEBUG, "%s Trigger dowlink assignment on PACCH, "
819 "because another LLC PDU has arrived in between\n",
820 tbf_name(this));
Daniel Willmanne4818152014-08-15 16:52:09 +0200821 bts->trigger_dl_ass(new_tbf, this, NULL);
Daniel Willmannca102af2014-08-08 12:14:12 +0200822}
823
824bool gprs_rlcmac_dl_tbf::dl_window_stalled() const
825{
826 return m_window.window_stalled();
827}
828
Jacob Erlbeckeceb9102015-03-20 14:41:50 +0100829void gprs_rlcmac_dl_tbf::request_dl_ack()
830{
831 m_dl_ack_requested = true;
832}
833
834bool gprs_rlcmac_dl_tbf::need_control_ts() const
835{
836 if (poll_state != GPRS_RLCMAC_POLL_NONE)
837 return false;
838
839 return state_flags & (1 << GPRS_RLCMAC_FLAG_TO_DL_ACK) ||
840 m_tx_counter >= POLL_ACK_AFTER_FRAMES ||
841 m_dl_ack_requested;
842}
843
844bool gprs_rlcmac_dl_tbf::have_data() const
845{
846 return m_llc.chunk_size() > 0 || !llist_empty(&m_llc.queue);
847}
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +0100848
849int gprs_rlcmac_dl_tbf::frames_since_last_poll(unsigned fn) const
850{
851 unsigned wrapped;
852 if (m_last_dl_poll_fn < 0)
853 return -1;
854
855 wrapped = (fn + 2715648 - m_last_dl_poll_fn) % 2715648;
856 if (wrapped < 2715648/2)
857 return wrapped;
858 else
859 return wrapped - 2715648;
860}
861
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100862int gprs_rlcmac_dl_tbf::frames_since_last_drain(unsigned fn) const
863{
864 unsigned wrapped;
865 if (m_last_dl_drained_fn < 0)
866 return -1;
867
868 wrapped = (fn + 2715648 - m_last_dl_drained_fn) % 2715648;
869 if (wrapped < 2715648/2)
870 return wrapped;
871 else
872 return wrapped - 2715648;
873}
874
875bool gprs_rlcmac_dl_tbf::keep_open(unsigned fn) const
876{
877 int keep_time_frames;
878
879 if (bts_data()->dl_tbf_idle_msec <= 0)
880 return false;
881
882 keep_time_frames = msecs_to_frames(bts_data()->dl_tbf_idle_msec);
883 return frames_since_last_drain(fn) <= keep_time_frames;
884}