Pau Espin Pedrol | 6ad11a6 | 2021-07-27 12:27:08 +0200 | [diff] [blame] | 1 | /* tbf_ul_ass_fsm.c |
| 2 | * |
| 3 | * Copyright (C) 2021 by sysmocom - s.f.m.c. GmbH <info@sysmocom.de> |
| 4 | * Author: Pau Espin Pedrol <pespin@sysmocom.de> |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or |
| 7 | * modify it under the terms of the GNU General Public License |
| 8 | * as published by the Free Software Foundation; either version 2 |
| 9 | * of the License, or (at your option) any later version. |
| 10 | * |
| 11 | * This program is distributed in the hope that it will be useful, |
| 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | * GNU General Public License for more details. |
Pau Espin Pedrol | 6ad11a6 | 2021-07-27 12:27:08 +0200 | [diff] [blame] | 15 | */ |
| 16 | |
| 17 | #include <unistd.h> |
| 18 | |
| 19 | #include <talloc.h> |
| 20 | |
| 21 | #include <osmocom/core/bitvec.h> |
| 22 | |
| 23 | #include <tbf_ul_ass_fsm.h> |
| 24 | #include <gprs_rlcmac.h> |
| 25 | #include <gprs_debug.h> |
| 26 | #include <gprs_ms.h> |
| 27 | #include <encoding.h> |
| 28 | #include <bts.h> |
| 29 | #include <tbf.h> |
| 30 | #include <tbf_ul.h> |
| 31 | |
| 32 | #define X(s) (1 << (s)) |
| 33 | |
| 34 | const struct osmo_tdef_state_timeout tbf_ul_ass_fsm_timeouts[32] = { |
| 35 | [TBF_UL_ASS_NONE] = {}, |
| 36 | [TBF_UL_ASS_SEND_ASS] = {}, |
| 37 | [TBF_UL_ASS_SEND_ASS_REJ] = {}, |
| 38 | [TBF_UL_ASS_WAIT_ACK] = {}, |
| 39 | }; |
| 40 | |
| 41 | const struct value_string tbf_ul_ass_fsm_event_names[] = { |
| 42 | { TBF_UL_ASS_EV_SCHED_ASS, "SCHED_ASS" }, |
| 43 | { TBF_UL_ASS_EV_SCHED_ASS_REJ, "SCHED_ASS_REJ" }, |
| 44 | { TBF_UL_ASS_EV_CREATE_RLCMAC_MSG, "CREATE_RLCMAC_MSG" }, |
| 45 | { TBF_UL_ASS_EV_RX_ASS_CTRL_ACK, "RX_ASS_CTRL_ACK" }, |
| 46 | { TBF_UL_ASS_EV_ASS_POLL_TIMEOUT, "ASS_POLL_TIMEOUT" }, |
Pau Espin Pedrol | b3291bc | 2021-10-14 19:21:38 +0200 | [diff] [blame] | 47 | { TBF_UL_ASS_EV_ABORT, "ABORT" }, |
Pau Espin Pedrol | 6ad11a6 | 2021-07-27 12:27:08 +0200 | [diff] [blame] | 48 | { 0, NULL } |
| 49 | }; |
| 50 | |
| 51 | static struct msgb *create_packet_access_reject(const struct tbf_ul_ass_fsm_ctx *ctx) |
| 52 | { |
| 53 | struct msgb *msg; |
| 54 | struct GprsMs *ms = tbf_ms(ctx->tbf); |
| 55 | |
| 56 | msg = msgb_alloc(GSM_MACBLOCK_LEN, "rlcmac_ul_ass_rej"); |
| 57 | |
| 58 | struct bitvec *packet_access_rej = bitvec_alloc(GSM_MACBLOCK_LEN, ctx->tbf); |
| 59 | |
| 60 | bitvec_unhex(packet_access_rej, DUMMY_VEC); |
| 61 | |
| 62 | write_packet_access_reject(packet_access_rej, ms_tlli(ms), |
Pau Espin Pedrol | 56b7c64 | 2021-11-15 18:20:05 +0100 | [diff] [blame] | 63 | osmo_tdef_get(ms->bts->pcu->T_defs, 3172, OSMO_TDEF_MS, -1)); |
Pau Espin Pedrol | 6ad11a6 | 2021-07-27 12:27:08 +0200 | [diff] [blame] | 64 | |
| 65 | bts_do_rate_ctr_inc(ms->bts, CTR_PKT_ACCESS_REJ); |
| 66 | |
| 67 | bitvec_pack(packet_access_rej, msgb_put(msg, GSM_MACBLOCK_LEN)); |
| 68 | |
| 69 | bitvec_free(packet_access_rej); |
| 70 | return msg; |
| 71 | |
| 72 | } |
| 73 | |
| 74 | struct msgb *create_packet_ul_assign(const struct tbf_ul_ass_fsm_ctx *ctx, |
| 75 | const struct tbf_ul_ass_ev_create_rlcmac_msg_ctx *d) |
| 76 | { |
| 77 | struct msgb *msg = NULL; |
| 78 | struct gprs_rlcmac_ul_tbf *new_tbf = NULL; |
| 79 | RlcMacDownlink_t *mac_control_block = NULL; |
| 80 | struct GprsMs *ms = tbf_ms(ctx->tbf); |
| 81 | uint32_t tlli; |
| 82 | int rc; |
| 83 | unsigned int rrbp; |
| 84 | uint32_t new_poll_fn; |
| 85 | |
| 86 | rc = tbf_check_polling(ctx->tbf, d->fn, d->ts, &new_poll_fn, &rrbp); |
| 87 | if (rc < 0) |
| 88 | return NULL; |
| 89 | |
| 90 | new_tbf = ms_ul_tbf(ms); |
| 91 | if (!new_tbf) { |
| 92 | LOGPTBF(ctx->tbf, LOGL_ERROR, |
| 93 | "We have a schedule for uplink assignment, but there is no uplink TBF\n"); |
| 94 | tbf_ul_ass_fsm_state_chg(ctx->fi, TBF_UL_ASS_NONE); |
| 95 | return NULL; |
| 96 | } |
| 97 | |
| 98 | msg = msgb_alloc(GSM_MACBLOCK_LEN, "rlcmac_ul_ass"); |
| 99 | if (!msg) |
| 100 | return NULL; |
| 101 | |
| 102 | /* Initialize a bit vector that uses allocated msgb as the data buffer. */ |
| 103 | struct bitvec bv = { |
| 104 | .data = msgb_put(msg, GSM_MACBLOCK_LEN), |
| 105 | .data_len = GSM_MACBLOCK_LEN, |
| 106 | }; |
| 107 | bitvec_unhex(&bv, DUMMY_VEC); |
| 108 | |
Pau Espin Pedrol | 1e16e1d | 2022-10-27 15:40:20 +0200 | [diff] [blame] | 109 | if (ctx->tbf != ul_tbf_as_tbf_const(new_tbf)) |
Pau Espin Pedrol | 17bfbed | 2021-11-12 13:12:48 +0100 | [diff] [blame] | 110 | LOGPTBF(ctx->tbf, LOGL_INFO, "start Packet Uplink Assignment (PACCH) for %s\n", |
Pau Espin Pedrol | 1e16e1d | 2022-10-27 15:40:20 +0200 | [diff] [blame] | 111 | tbf_name(ul_tbf_as_tbf_const(new_tbf))); |
Pau Espin Pedrol | 7eb9e69 | 2021-11-10 17:54:38 +0100 | [diff] [blame] | 112 | else |
Pau Espin Pedrol | 17bfbed | 2021-11-12 13:12:48 +0100 | [diff] [blame] | 113 | LOGPTBF(ctx->tbf, LOGL_INFO, "start Packet Uplink Assignment (PACCH)\n"); |
Pau Espin Pedrol | 7eb9e69 | 2021-11-10 17:54:38 +0100 | [diff] [blame] | 114 | |
Pau Espin Pedrol | 6ad11a6 | 2021-07-27 12:27:08 +0200 | [diff] [blame] | 115 | mac_control_block = (RlcMacDownlink_t *)talloc_zero(ctx->tbf, RlcMacDownlink_t); |
| 116 | tlli = ms_tlli(ms); |
| 117 | write_packet_uplink_assignment(mac_control_block, tbf_tfi(ctx->tbf), |
| 118 | (tbf_direction(ctx->tbf) == GPRS_RLCMAC_DL_TBF), ms_tlli(ms), |
| 119 | tlli != GSM_RESERVED_TMSI, new_tbf, 1, rrbp, bts_get_ms_pwr_alpha(ms->bts), |
| 120 | the_pcu->vty.gamma, -1, tbf_is_egprs_enabled(ctx->tbf)); |
| 121 | |
| 122 | LOGP(DTBF, LOGL_DEBUG, "+++++++++++++++++++++++++ TX : Packet Uplink Assignment +++++++++++++++++++++++++\n"); |
| 123 | rc = encode_gsm_rlcmac_downlink(&bv, mac_control_block); |
| 124 | if (rc < 0) { |
| 125 | LOGP(DTBF, LOGL_ERROR, "Encoding of Packet Uplink Ass failed (%d)\n", rc); |
| 126 | goto free_ret; |
| 127 | } |
| 128 | LOGP(DTBF, LOGL_DEBUG, "------------------------- TX : Packet Uplink Assignment -------------------------\n"); |
| 129 | bts_do_rate_ctr_inc(ms->bts, CTR_PKT_UL_ASSIGNMENT); |
| 130 | |
| 131 | tbf_set_polling(ctx->tbf, new_poll_fn, d->ts, PDCH_ULC_POLL_UL_ASS); |
Pau Espin Pedrol | bd1f01f | 2022-10-27 15:19:39 +0200 | [diff] [blame] | 132 | LOGPTBF(ctx->tbf, LOGL_INFO, "Scheduled UL Assignment polling on PACCH (FN=%d, TS=%d)\n", |
Pau Espin Pedrol | a161bf4 | 2021-07-30 13:42:06 +0200 | [diff] [blame] | 133 | new_poll_fn, d->ts); |
Pau Espin Pedrol | 6ad11a6 | 2021-07-27 12:27:08 +0200 | [diff] [blame] | 134 | |
| 135 | talloc_free(mac_control_block); |
| 136 | return msg; |
| 137 | |
| 138 | free_ret: |
| 139 | talloc_free(mac_control_block); |
| 140 | msgb_free(msg); |
| 141 | return NULL; |
| 142 | } |
| 143 | |
| 144 | static void st_none_on_enter(struct osmo_fsm_inst *fi, uint32_t prev_state) |
| 145 | { |
| 146 | struct tbf_ul_ass_fsm_ctx *ctx = (struct tbf_ul_ass_fsm_ctx *)fi->priv; |
| 147 | unsigned long val; |
| 148 | unsigned int sec, micro; |
| 149 | |
| 150 | /* Start release after rejecting only if it is UL TBF */ |
| 151 | if (prev_state == TBF_UL_ASS_SEND_ASS_REJ && |
| 152 | tbf_direction(ctx->tbf) == GPRS_RLCMAC_UL_TBF) { |
| 153 | /* tbf_free() called upon trigger */ |
| 154 | fi->T = -2000; |
| 155 | val = osmo_tdef_get(the_pcu->T_defs, fi->T, OSMO_TDEF_MS, -1); |
| 156 | sec = val / 1000; |
| 157 | micro = (val % 1000) * 1000; |
| 158 | LOGPTBF(ctx->tbf, LOGL_DEBUG, "starting timer X2000 [reject (PACCH)] with %u sec. %u microsec\n", |
| 159 | sec, micro); |
| 160 | osmo_timer_schedule(&fi->timer, sec, micro); |
| 161 | } |
| 162 | |
| 163 | } |
| 164 | |
| 165 | static void st_none(struct osmo_fsm_inst *fi, uint32_t event, void *data) |
| 166 | { |
| 167 | switch (event) { |
| 168 | case TBF_UL_ASS_EV_SCHED_ASS: |
| 169 | tbf_ul_ass_fsm_state_chg(fi, TBF_UL_ASS_SEND_ASS); |
| 170 | break; |
| 171 | case TBF_UL_ASS_EV_SCHED_ASS_REJ: |
| 172 | tbf_ul_ass_fsm_state_chg(fi, TBF_UL_ASS_SEND_ASS_REJ); |
| 173 | break; |
Pau Espin Pedrol | b3291bc | 2021-10-14 19:21:38 +0200 | [diff] [blame] | 174 | case TBF_UL_ASS_EV_ABORT: |
| 175 | /* Nothing to do, we are already in proper state */ |
| 176 | break; |
Pau Espin Pedrol | 6ad11a6 | 2021-07-27 12:27:08 +0200 | [diff] [blame] | 177 | default: |
| 178 | OSMO_ASSERT(0); |
| 179 | } |
| 180 | } |
| 181 | |
| 182 | static void st_send_ass(struct osmo_fsm_inst *fi, uint32_t event, void *data) |
| 183 | { |
| 184 | struct tbf_ul_ass_fsm_ctx *ctx = (struct tbf_ul_ass_fsm_ctx *)fi->priv; |
| 185 | struct tbf_ul_ass_ev_create_rlcmac_msg_ctx *data_ctx; |
| 186 | |
| 187 | switch (event) { |
| 188 | case TBF_UL_ASS_EV_CREATE_RLCMAC_MSG: |
| 189 | data_ctx = (struct tbf_ul_ass_ev_create_rlcmac_msg_ctx *)data; |
| 190 | data_ctx->msg = create_packet_ul_assign(ctx, data_ctx); |
| 191 | if (!data_ctx->msg) |
| 192 | return; |
| 193 | tbf_ul_ass_fsm_state_chg(fi, TBF_UL_ASS_WAIT_ACK); |
| 194 | break; |
Pau Espin Pedrol | b3291bc | 2021-10-14 19:21:38 +0200 | [diff] [blame] | 195 | case TBF_UL_ASS_EV_ABORT: |
| 196 | /* Cancel pending schedule for Pkt Ul Ass: */ |
| 197 | tbf_ul_ass_fsm_state_chg(fi, TBF_UL_ASS_NONE); |
| 198 | break; |
Pau Espin Pedrol | 6ad11a6 | 2021-07-27 12:27:08 +0200 | [diff] [blame] | 199 | default: |
| 200 | OSMO_ASSERT(0); |
| 201 | } |
| 202 | } |
| 203 | |
| 204 | static void st_send_ass_rej(struct osmo_fsm_inst *fi, uint32_t event, void *data) |
| 205 | { |
| 206 | struct tbf_ul_ass_fsm_ctx *ctx = (struct tbf_ul_ass_fsm_ctx *)fi->priv; |
| 207 | struct tbf_ul_ass_ev_create_rlcmac_msg_ctx *data_ctx; |
| 208 | |
| 209 | switch (event) { |
| 210 | case TBF_UL_ASS_EV_CREATE_RLCMAC_MSG: |
| 211 | data_ctx = (struct tbf_ul_ass_ev_create_rlcmac_msg_ctx *)data; |
| 212 | data_ctx->msg = create_packet_access_reject(ctx); |
| 213 | if (!data_ctx->msg) |
| 214 | return; |
| 215 | tbf_ul_ass_fsm_state_chg(fi, TBF_UL_ASS_NONE); |
| 216 | break; |
Pau Espin Pedrol | b3291bc | 2021-10-14 19:21:38 +0200 | [diff] [blame] | 217 | case TBF_UL_ASS_EV_ABORT: |
| 218 | /* Cancel pending schedule for Pkt Ul Ass Rej: */ |
| 219 | tbf_ul_ass_fsm_state_chg(fi, TBF_UL_ASS_NONE); |
| 220 | break; |
Pau Espin Pedrol | 6ad11a6 | 2021-07-27 12:27:08 +0200 | [diff] [blame] | 221 | default: |
| 222 | OSMO_ASSERT(0); |
| 223 | } |
| 224 | } |
| 225 | |
| 226 | static void st_wait_ack(struct osmo_fsm_inst *fi, uint32_t event, void *data) |
| 227 | { |
Pau Espin Pedrol | 432d4f3 | 2021-07-27 16:09:30 +0200 | [diff] [blame] | 228 | struct tbf_ul_ass_fsm_ctx *ctx = (struct tbf_ul_ass_fsm_ctx *)fi->priv; |
| 229 | |
Pau Espin Pedrol | 6ad11a6 | 2021-07-27 12:27:08 +0200 | [diff] [blame] | 230 | switch (event) { |
| 231 | case TBF_UL_ASS_EV_RX_ASS_CTRL_ACK: |
| 232 | tbf_ul_ass_fsm_state_chg(fi, TBF_UL_ASS_NONE); |
| 233 | break; |
| 234 | case TBF_UL_ASS_EV_ASS_POLL_TIMEOUT: |
Pau Espin Pedrol | 432d4f3 | 2021-07-27 16:09:30 +0200 | [diff] [blame] | 235 | LOGPTBF(ctx->tbf, LOGL_NOTICE, |
| 236 | "Timeout for polling PACKET CONTROL ACK for PACKET UPLINK ASSIGNMENT: %s\n", |
| 237 | tbf_rlcmac_diag(ctx->tbf)); |
Pau Espin Pedrol | 880cbd3 | 2021-10-14 18:43:30 +0200 | [diff] [blame] | 238 | if (tbf_state(ctx->tbf) == TBF_ST_ASSIGN) { |
| 239 | /* Reschedule Pkt Ul Ass */ |
| 240 | tbf_ul_ass_fsm_state_chg(fi, TBF_UL_ASS_SEND_ASS); |
| 241 | } else { |
| 242 | /* We are most probably in RELEASING, so stop retrying. */ |
| 243 | tbf_ul_ass_fsm_state_chg(fi, TBF_UL_ASS_NONE); |
| 244 | } |
Pau Espin Pedrol | 6ad11a6 | 2021-07-27 12:27:08 +0200 | [diff] [blame] | 245 | break; |
Pau Espin Pedrol | b3291bc | 2021-10-14 19:21:38 +0200 | [diff] [blame] | 246 | case TBF_UL_ASS_EV_ABORT: |
| 247 | /* There's nothing we can do here, we already transmitted and |
| 248 | * hence we must keep the POLL since the MS is already expected |
| 249 | * to transmit there. Whenever we receive event CTRL_ACK or |
| 250 | * TIMEOUT above, it will move back to ST_NONE autoamtically */ |
| 251 | break; |
Pau Espin Pedrol | 6ad11a6 | 2021-07-27 12:27:08 +0200 | [diff] [blame] | 252 | default: |
| 253 | OSMO_ASSERT(0); |
| 254 | } |
| 255 | } |
| 256 | |
| 257 | static int tbf_ul_ass_fsm_timer_cb(struct osmo_fsm_inst *fi) |
| 258 | { |
| 259 | struct tbf_ul_ass_fsm_ctx *ctx = (struct tbf_ul_ass_fsm_ctx *)fi->priv; |
| 260 | switch (fi->T) { |
| 261 | case -2000: |
| 262 | tbf_free(ctx->tbf); |
| 263 | break; |
| 264 | default: |
| 265 | OSMO_ASSERT(0); |
| 266 | } |
| 267 | return 0; |
| 268 | } |
| 269 | |
| 270 | static struct osmo_fsm_state tbf_ul_ass_fsm_states[] = { |
| 271 | [TBF_UL_ASS_NONE] = { |
| 272 | .in_event_mask = |
| 273 | X(TBF_UL_ASS_EV_SCHED_ASS) | |
Pau Espin Pedrol | b3291bc | 2021-10-14 19:21:38 +0200 | [diff] [blame] | 274 | X(TBF_UL_ASS_EV_SCHED_ASS_REJ) | |
| 275 | X(TBF_UL_ASS_EV_ABORT), |
Pau Espin Pedrol | 6ad11a6 | 2021-07-27 12:27:08 +0200 | [diff] [blame] | 276 | .out_state_mask = |
| 277 | X(TBF_UL_ASS_SEND_ASS) | |
| 278 | X(TBF_UL_ASS_SEND_ASS_REJ), |
| 279 | .name = "NONE", |
| 280 | .action = st_none, |
| 281 | .onenter = st_none_on_enter, |
| 282 | }, |
| 283 | [TBF_UL_ASS_SEND_ASS] = { |
Pau Espin Pedrol | b3291bc | 2021-10-14 19:21:38 +0200 | [diff] [blame] | 284 | .in_event_mask = |
| 285 | X(TBF_UL_ASS_EV_CREATE_RLCMAC_MSG) | |
| 286 | X(TBF_UL_ASS_EV_ABORT), |
Pau Espin Pedrol | ea7cb48 | 2021-09-22 16:53:41 +0200 | [diff] [blame] | 287 | .out_state_mask = |
| 288 | X(TBF_UL_ASS_WAIT_ACK) | |
| 289 | X(TBF_UL_ASS_NONE), |
Pau Espin Pedrol | 6ad11a6 | 2021-07-27 12:27:08 +0200 | [diff] [blame] | 290 | .name = "SEND_ASS", |
| 291 | .action = st_send_ass, |
| 292 | }, |
| 293 | [TBF_UL_ASS_SEND_ASS_REJ] = { |
Pau Espin Pedrol | b3291bc | 2021-10-14 19:21:38 +0200 | [diff] [blame] | 294 | .in_event_mask = |
| 295 | X(TBF_UL_ASS_EV_CREATE_RLCMAC_MSG) | |
| 296 | X(TBF_UL_ASS_EV_ABORT), |
Pau Espin Pedrol | 6ad11a6 | 2021-07-27 12:27:08 +0200 | [diff] [blame] | 297 | .out_state_mask = X(TBF_UL_ASS_NONE), |
| 298 | .name = "SEND_ASS_REJ", |
| 299 | .action = st_send_ass_rej, |
| 300 | }, |
| 301 | [TBF_UL_ASS_WAIT_ACK] = { |
| 302 | .in_event_mask = |
| 303 | X(TBF_UL_ASS_EV_RX_ASS_CTRL_ACK) | |
Pau Espin Pedrol | b3291bc | 2021-10-14 19:21:38 +0200 | [diff] [blame] | 304 | X(TBF_UL_ASS_EV_ASS_POLL_TIMEOUT) | |
| 305 | X(TBF_UL_ASS_EV_ABORT), |
Pau Espin Pedrol | 6ad11a6 | 2021-07-27 12:27:08 +0200 | [diff] [blame] | 306 | .out_state_mask = |
| 307 | X(TBF_UL_ASS_NONE) | |
| 308 | X(TBF_UL_ASS_SEND_ASS), |
| 309 | .name = "WAIT_ACK", |
| 310 | .action = st_wait_ack, |
| 311 | }, |
| 312 | }; |
| 313 | |
| 314 | struct osmo_fsm tbf_ul_ass_fsm = { |
| 315 | .name = "UL_ASS_TBF", |
| 316 | .states = tbf_ul_ass_fsm_states, |
| 317 | .num_states = ARRAY_SIZE(tbf_ul_ass_fsm_states), |
| 318 | .timer_cb = tbf_ul_ass_fsm_timer_cb, |
| 319 | .log_subsys = DTBF, |
| 320 | .event_names = tbf_ul_ass_fsm_event_names, |
| 321 | }; |
| 322 | |
| 323 | static __attribute__((constructor)) void tbf_ul_ass_fsm_init(void) |
| 324 | { |
| 325 | OSMO_ASSERT(osmo_fsm_register(&tbf_ul_ass_fsm) == 0); |
| 326 | } |
| 327 | |
| 328 | |
| 329 | struct msgb *tbf_ul_ass_create_rlcmac_msg(const struct gprs_rlcmac_tbf* tbf, uint32_t fn, uint8_t ts) |
| 330 | { |
| 331 | int rc; |
| 332 | struct tbf_ul_ass_ev_create_rlcmac_msg_ctx data_ctx = { |
| 333 | .fn = fn, |
| 334 | .ts = ts, |
| 335 | .msg = NULL, |
| 336 | }; |
| 337 | |
| 338 | rc = osmo_fsm_inst_dispatch(tbf_ul_ass_fi(tbf), TBF_UL_ASS_EV_CREATE_RLCMAC_MSG, &data_ctx); |
| 339 | if (rc != 0 || !data_ctx.msg) |
| 340 | return NULL; |
| 341 | return data_ctx.msg; |
| 342 | } |
| 343 | |
| 344 | bool tbf_ul_ass_rts(const struct gprs_rlcmac_tbf* tbf) |
| 345 | { |
| 346 | struct osmo_fsm_inst *fi = tbf_ul_ass_fi(tbf); |
| 347 | return fi->state == TBF_UL_ASS_SEND_ASS || fi->state == TBF_UL_ASS_SEND_ASS_REJ; |
| 348 | } |