Pau Espin Pedrol | 5c598c7 | 2022-03-31 20:22:05 +0200 | [diff] [blame] | 1 | /* 3GPP TS 44.064 |
Holger Hans Peter Freyther | be57081 | 2013-11-07 08:01:49 +0100 | [diff] [blame] | 2 | * Copyright (C) 2013 by Holger Hans Peter Freyther |
Pau Espin Pedrol | 4f8384b | 2022-03-31 19:36:12 +0200 | [diff] [blame] | 3 | * Copyright (C) 2022 by by Sysmocom s.f.m.c. GmbH |
Holger Hans Peter Freyther | be57081 | 2013-11-07 08:01:49 +0100 | [diff] [blame] | 4 | * |
| 5 | * This program is free software; you can redistribute it and/or |
| 6 | * modify it under the terms of the GNU General Public License |
| 7 | * as published by the Free Software Foundation; either version 2 |
| 8 | * of the License, or (at your option) any later version. |
| 9 | * |
| 10 | * This program is distributed in the hope that it will be useful, |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 | * GNU General Public License for more details. |
Holger Hans Peter Freyther | be57081 | 2013-11-07 08:01:49 +0100 | [diff] [blame] | 14 | */ |
| 15 | |
| 16 | #pragma once |
| 17 | |
Pau Espin Pedrol | da971ee | 2020-12-16 15:59:45 +0100 | [diff] [blame] | 18 | #ifdef __cplusplus |
Jacob Erlbeck | 1eae96c | 2015-06-15 11:19:13 +0200 | [diff] [blame] | 19 | extern "C" { |
Pau Espin Pedrol | da971ee | 2020-12-16 15:59:45 +0100 | [diff] [blame] | 20 | #endif |
Jacob Erlbeck | 1eae96c | 2015-06-15 11:19:13 +0200 | [diff] [blame] | 21 | |
Holger Hans Peter Freyther | be57081 | 2013-11-07 08:01:49 +0100 | [diff] [blame] | 22 | #include <stdint.h> |
Holger Hans Peter Freyther | acb5427 | 2013-11-07 08:15:58 +0100 | [diff] [blame] | 23 | #include <string.h> |
Pau Espin Pedrol | 1de6873 | 2020-03-11 14:04:52 +0100 | [diff] [blame] | 24 | #include <time.h> |
Holger Hans Peter Freyther | be57081 | 2013-11-07 08:01:49 +0100 | [diff] [blame] | 25 | |
Pau Espin Pedrol | 5c598c7 | 2022-03-31 20:22:05 +0200 | [diff] [blame] | 26 | #include <osmocom/core/endian.h> |
Pau Espin Pedrol | 4f8384b | 2022-03-31 19:36:12 +0200 | [diff] [blame] | 27 | #include <osmocom/core/linuxlist.h> |
| 28 | #include <osmocom/core/msgb.h> |
Pau Espin Pedrol | 5c598c7 | 2022-03-31 20:22:05 +0200 | [diff] [blame] | 29 | #include <osmocom/core/endian.h> |
Pau Espin Pedrol | 4f8384b | 2022-03-31 19:36:12 +0200 | [diff] [blame] | 30 | |
Holger Hans Peter Freyther | be57081 | 2013-11-07 08:01:49 +0100 | [diff] [blame] | 31 | #define LLC_MAX_LEN 1543 |
| 32 | |
Pau Espin Pedrol | 2182e62 | 2021-01-14 16:48:38 +0100 | [diff] [blame] | 33 | struct gprs_rlcmac_bts; |
Jacob Erlbeck | 1d0a52a | 2015-06-02 11:28:07 +0200 | [diff] [blame] | 34 | |
Pau Espin Pedrol | 5c598c7 | 2022-03-31 20:22:05 +0200 | [diff] [blame] | 35 | struct gprs_llc_hdr { |
| 36 | #if OSMO_IS_LITTLE_ENDIAN |
| 37 | union { /* 5.2, 6.2.0 */ |
| 38 | uint8_t address; |
| 39 | uint8_t sapi:4, unused:2, c_r:1, pd:1; |
| 40 | #elif OSMO_IS_BIG_ENDIAN |
| 41 | /* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */ |
| 42 | union { |
| 43 | uint8_t address; |
| 44 | uint8_t pd:1, c_r:1, unused:2, sapi:4; |
| 45 | #endif |
| 46 | }; |
| 47 | uint8_t control[0]; |
| 48 | } __attribute__ ((packed)); |
| 49 | |
Holger Hans Peter Freyther | be57081 | 2013-11-07 08:01:49 +0100 | [diff] [blame] | 50 | /** |
| 51 | * I represent the LLC data to a MS |
| 52 | */ |
| 53 | struct gprs_llc { |
Holger Hans Peter Freyther | be57081 | 2013-11-07 08:01:49 +0100 | [diff] [blame] | 54 | uint8_t frame[LLC_MAX_LEN]; /* current DL or UL frame */ |
Pau Espin Pedrol | 1463383 | 2022-03-31 19:08:07 +0200 | [diff] [blame] | 55 | uint16_t index; /* current write/read position of frame */ |
| 56 | uint16_t length; /* len of current DL LLC_frame, 0 == no frame */ |
Jacob Erlbeck | 6dbe822 | 2015-05-29 10:37:09 +0200 | [diff] [blame] | 57 | }; |
Pau Espin Pedrol | 4f8384b | 2022-03-31 19:36:12 +0200 | [diff] [blame] | 58 | bool llc_is_user_data_frame(const uint8_t *data, size_t len); |
| 59 | |
| 60 | void llc_init(struct gprs_llc *llc); |
| 61 | void llc_reset(struct gprs_llc *llc); |
| 62 | void llc_reset_frame_space(struct gprs_llc *llc); |
| 63 | |
| 64 | void llc_put_frame(struct gprs_llc *llc, const uint8_t *data, size_t len); |
| 65 | void llc_put_dummy_frame(struct gprs_llc *llc, size_t req_len); |
| 66 | void llc_append_frame(struct gprs_llc *llc, const uint8_t *data, size_t len); |
Holger Hans Peter Freyther | 550bb88 | 2013-12-04 17:10:54 +0100 | [diff] [blame] | 67 | |
Pau Espin Pedrol | da971ee | 2020-12-16 15:59:45 +0100 | [diff] [blame] | 68 | static inline uint16_t llc_chunk_size(const struct gprs_llc *llc) |
Holger Hans Peter Freyther | acb5427 | 2013-11-07 08:15:58 +0100 | [diff] [blame] | 69 | { |
Pau Espin Pedrol | 1463383 | 2022-03-31 19:08:07 +0200 | [diff] [blame] | 70 | return llc->length - llc->index; |
Holger Hans Peter Freyther | e231026 | 2013-11-13 16:56:15 +0100 | [diff] [blame] | 71 | } |
| 72 | |
Pau Espin Pedrol | da971ee | 2020-12-16 15:59:45 +0100 | [diff] [blame] | 73 | static inline uint16_t llc_remaining_space(const struct gprs_llc *llc) |
Holger Hans Peter Freyther | e231026 | 2013-11-13 16:56:15 +0100 | [diff] [blame] | 74 | { |
Pau Espin Pedrol | 1463383 | 2022-03-31 19:08:07 +0200 | [diff] [blame] | 75 | return LLC_MAX_LEN - llc->length; |
Holger Hans Peter Freyther | e231026 | 2013-11-13 16:56:15 +0100 | [diff] [blame] | 76 | } |
| 77 | |
Pau Espin Pedrol | da971ee | 2020-12-16 15:59:45 +0100 | [diff] [blame] | 78 | static inline uint16_t llc_frame_length(const struct gprs_llc *llc) |
Holger Hans Peter Freyther | e231026 | 2013-11-13 16:56:15 +0100 | [diff] [blame] | 79 | { |
Pau Espin Pedrol | 1463383 | 2022-03-31 19:08:07 +0200 | [diff] [blame] | 80 | return llc->length; |
Holger Hans Peter Freyther | e231026 | 2013-11-13 16:56:15 +0100 | [diff] [blame] | 81 | } |
| 82 | |
Pau Espin Pedrol | da971ee | 2020-12-16 15:59:45 +0100 | [diff] [blame] | 83 | static inline void llc_consume(struct gprs_llc *llc, size_t len) |
Holger Hans Peter Freyther | e231026 | 2013-11-13 16:56:15 +0100 | [diff] [blame] | 84 | { |
Pau Espin Pedrol | 1463383 | 2022-03-31 19:08:07 +0200 | [diff] [blame] | 85 | llc->index += len; |
Holger Hans Peter Freyther | acb5427 | 2013-11-07 08:15:58 +0100 | [diff] [blame] | 86 | } |
| 87 | |
Pau Espin Pedrol | da971ee | 2020-12-16 15:59:45 +0100 | [diff] [blame] | 88 | static inline void llc_consume_data(struct gprs_llc *llc, uint8_t *data, size_t len) |
Holger Hans Peter Freyther | acb5427 | 2013-11-07 08:15:58 +0100 | [diff] [blame] | 89 | { |
| 90 | /* copy and increment index */ |
Pau Espin Pedrol | 1463383 | 2022-03-31 19:08:07 +0200 | [diff] [blame] | 91 | memcpy(data, llc->frame + llc->index, len); |
Pau Espin Pedrol | da971ee | 2020-12-16 15:59:45 +0100 | [diff] [blame] | 92 | llc_consume(llc, len); |
Holger Hans Peter Freyther | acb5427 | 2013-11-07 08:15:58 +0100 | [diff] [blame] | 93 | } |
Holger Hans Peter Freyther | e231026 | 2013-11-13 16:56:15 +0100 | [diff] [blame] | 94 | |
Pau Espin Pedrol | da971ee | 2020-12-16 15:59:45 +0100 | [diff] [blame] | 95 | static inline bool llc_fits_in_current_frame(const struct gprs_llc *llc, uint8_t chunk_size) |
Holger Hans Peter Freyther | e231026 | 2013-11-13 16:56:15 +0100 | [diff] [blame] | 96 | { |
Pau Espin Pedrol | 1463383 | 2022-03-31 19:08:07 +0200 | [diff] [blame] | 97 | return llc->length + chunk_size <= LLC_MAX_LEN; |
Holger Hans Peter Freyther | e231026 | 2013-11-13 16:56:15 +0100 | [diff] [blame] | 98 | } |
Jacob Erlbeck | 6dbe822 | 2015-05-29 10:37:09 +0200 | [diff] [blame] | 99 | |
Pau Espin Pedrol | ee1cb75 | 2022-03-31 19:47:33 +0200 | [diff] [blame] | 100 | struct MetaInfo { |
| 101 | struct timespec recv_time; |
| 102 | struct timespec expire_time; |
| 103 | }; |
| 104 | /** |
| 105 | * I store the LLC frames that come from the SGSN. |
| 106 | */ |
Pau Espin Pedrol | 5c598c7 | 2022-03-31 20:22:05 +0200 | [diff] [blame] | 107 | enum gprs_llc_queue_prio { /* lowest value has highest prio */ |
| 108 | LLC_QUEUE_PRIO_GMM = 0, /* SAPI 1 */ |
| 109 | LLC_QUEUE_PRIO_TOM_SMS, /* SAPI 2,7,8 */ |
| 110 | LLC_QUEUE_PRIO_OTHER, /* Other SAPIs */ |
| 111 | _LLC_QUEUE_PRIO_SIZE /* used to calculate size of enum */ |
| 112 | }; |
Pau Espin Pedrol | ee1cb75 | 2022-03-31 19:47:33 +0200 | [diff] [blame] | 113 | struct gprs_llc_queue { |
| 114 | uint32_t avg_queue_delay; /* Average delay of data going through the queue */ |
| 115 | size_t queue_size; |
| 116 | size_t queue_octets; |
Pau Espin Pedrol | 5c598c7 | 2022-03-31 20:22:05 +0200 | [diff] [blame] | 117 | struct llist_head queue[_LLC_QUEUE_PRIO_SIZE]; /* queued LLC DL data. See enum gprs_llc_queue_prio. */ |
Pau Espin Pedrol | ee1cb75 | 2022-03-31 19:47:33 +0200 | [diff] [blame] | 118 | }; |
| 119 | |
| 120 | void llc_queue_calc_pdu_lifetime(struct gprs_rlcmac_bts *bts, const uint16_t pdu_delay_csec, |
| 121 | struct timespec *tv); |
| 122 | bool llc_queue_is_frame_expired(const struct timespec *tv_now, const struct timespec *tv); |
| 123 | |
| 124 | void llc_queue_init(struct gprs_llc_queue *q); |
| 125 | void llc_queue_clear(struct gprs_llc_queue *q, struct gprs_rlcmac_bts *bts); |
| 126 | void llc_queue_move_and_merge(struct gprs_llc_queue *q, struct gprs_llc_queue *o); |
| 127 | void llc_queue_enqueue(struct gprs_llc_queue *q, struct msgb *llc_msg, const struct timespec *expire_time); |
| 128 | struct msgb *llc_queue_dequeue(struct gprs_llc_queue *q, const struct MetaInfo **info); |
| 129 | |
Pau Espin Pedrol | da971ee | 2020-12-16 15:59:45 +0100 | [diff] [blame] | 130 | static inline size_t llc_queue_size(const struct gprs_llc_queue *q) |
Jacob Erlbeck | 6dbe822 | 2015-05-29 10:37:09 +0200 | [diff] [blame] | 131 | { |
Pau Espin Pedrol | 1463383 | 2022-03-31 19:08:07 +0200 | [diff] [blame] | 132 | return q->queue_size; |
Jacob Erlbeck | 6dbe822 | 2015-05-29 10:37:09 +0200 | [diff] [blame] | 133 | } |
Jacob Erlbeck | 07eb655 | 2015-06-15 11:05:44 +0200 | [diff] [blame] | 134 | |
Pau Espin Pedrol | da971ee | 2020-12-16 15:59:45 +0100 | [diff] [blame] | 135 | static inline size_t llc_queue_octets(const struct gprs_llc_queue *q) |
Jacob Erlbeck | 07eb655 | 2015-06-15 11:05:44 +0200 | [diff] [blame] | 136 | { |
Pau Espin Pedrol | 1463383 | 2022-03-31 19:08:07 +0200 | [diff] [blame] | 137 | return q->queue_octets; |
Jacob Erlbeck | 07eb655 | 2015-06-15 11:05:44 +0200 | [diff] [blame] | 138 | } |
Pau Espin Pedrol | da971ee | 2020-12-16 15:59:45 +0100 | [diff] [blame] | 139 | |
| 140 | #ifdef __cplusplus |
| 141 | } |
| 142 | #endif |