Harald Welte | 1733a38 | 2017-07-23 17:26:17 +0200 | [diff] [blame] | 1 | module BSSGP_Emulation { |
Harald Welte | 1733a38 | 2017-07-23 17:26:17 +0200 | [diff] [blame] | 2 | |
Harald Welte | 34b5a95 | 2019-05-27 11:54:11 +0200 | [diff] [blame] | 3 | /* BSSGP Emulation in TTCN-3 |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 4 | * (C) 2018-2020 Harald Welte <laforge@gnumonks.org> |
Harald Welte | 34b5a95 | 2019-05-27 11:54:11 +0200 | [diff] [blame] | 5 | * All rights reserved. |
| 6 | * |
| 7 | * Released under the terms of GNU General Public License, Version 2 or |
| 8 | * (at your option) any later version. |
| 9 | * |
| 10 | * SPDX-License-Identifier: GPL-2.0-or-later |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 11 | * |
| 12 | * This code implements BSSGP asa hierarchy of components: |
| 13 | * - the main BSSGP_CT which runs on top of a NSE (NS Entity). |
| 14 | * - demultiplex based on BVCI. BVCI=0 is handled to a user port |
| 15 | * - a per-BVC BSSGP_BVC_CT which runs on top of BSSGP_CT, it handles |
| 16 | * one PTP BVCI (i.e. one cell) |
| 17 | * - demultiplex based on TLLI |
| 18 | * - a per-TLLI BSSGP_Client_CT which runs on top of BSSGP_BVC_CT |
Harald Welte | 34b5a95 | 2019-05-27 11:54:11 +0200 | [diff] [blame] | 19 | */ |
| 20 | |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 21 | import from General_Types all; |
| 22 | import from Osmocom_Types all; |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 23 | import from NS_Types all; |
| 24 | import from NS_Emulation all; |
| 25 | import from BSSGP_Types all; |
| 26 | import from Osmocom_Gb_Types all; |
| 27 | import from IPL4asp_Types all; |
Harald Welte | 1733a38 | 2017-07-23 17:26:17 +0200 | [diff] [blame] | 28 | |
Harald Welte | 93331e7 | 2020-09-12 20:51:05 +0200 | [diff] [blame] | 29 | #ifdef BSSGP_EM_L3 |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 30 | import from MobileL3_GMM_SM_Types all; |
| 31 | import from MobileL3_Types all; |
Harald Welte | 93331e7 | 2020-09-12 20:51:05 +0200 | [diff] [blame] | 32 | #endif |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 33 | |
| 34 | import from LLC_Types all; |
| 35 | import from LLC_Templates all; |
| 36 | |
Harald Welte | a2526a8 | 2018-02-18 19:03:36 +0100 | [diff] [blame] | 37 | import from SNDCP_Types all; |
| 38 | |
Harald Welte | 12d19b8 | 2020-10-09 11:41:06 +0200 | [diff] [blame] | 39 | |
| 40 | modulepar { |
| 41 | /* tolerate CellID absence/presence in BVC-RESET in violation to spec */ |
| 42 | boolean mp_tolerate_bvc_reset_cellid := false; |
| 43 | } |
| 44 | |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 45 | /*********************************************************************** |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 46 | * Communication between Client Components and per-BVC component |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 47 | ***********************************************************************/ |
| 48 | |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 49 | type record BssgpStatusIndication { |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 50 | Nsei nsei optional, |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 51 | BssgpBvci bvci, |
| 52 | BvcState state |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 53 | }; |
| 54 | |
| 55 | type record BssgpResetIndication { |
| 56 | BssgpBvci bvci |
| 57 | }; |
| 58 | |
| 59 | template (value) BssgpStatusIndication |
| 60 | ts_BssgpStsInd(template (omit) Nsei nsei, template (value) BssgpBvci bvci, |
| 61 | template (value) BvcState state) := { |
| 62 | nsei := nsei, |
| 63 | bvci := bvci, |
| 64 | state := state |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 65 | } |
| 66 | |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 67 | template (present) BssgpStatusIndication |
| 68 | tr_BssgpStsInd(template Nsei nsei, template (present) BssgpBvci bvci, |
| 69 | template (present) BvcState state) := { |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 70 | nsei := nsei, |
| 71 | bvci := bvci, |
| 72 | state := state |
| 73 | } |
| 74 | |
| 75 | type enumerated BvcState { |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 76 | /* SGSN role: waiting to be reset by the peer */ |
| 77 | BVC_S_WAIT_RESET, |
| 78 | /* PCU role: waiting for NS_ALIVE_UNBLOCKED */ |
| 79 | BVC_S_WAIT_NS_ALIVE_UNBLOCKED, |
| 80 | /* BVC-BLOCKED state */ |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 81 | BVC_S_BLOCKED, |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 82 | /* BVC-UNBLOCKED state */ |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 83 | BVC_S_UNBLOCKED |
| 84 | }; |
| 85 | |
| 86 | /* port from our (internal) point of view */ |
| 87 | type port BSSGP_SP_PT message { |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 88 | in PDU_BSSGP, |
Harald Welte | 93331e7 | 2020-09-12 20:51:05 +0200 | [diff] [blame] | 89 | PDU_LLC |
| 90 | #ifdef BSSGP_EM_L3 |
| 91 | , |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 92 | PDU_L3_MS_SGSN, |
Harald Welte | 93331e7 | 2020-09-12 20:51:05 +0200 | [diff] [blame] | 93 | PDU_L3_SGSN_MS |
| 94 | #endif |
| 95 | ; |
Harald Welte | 955aa94 | 2019-05-03 01:29:29 +0200 | [diff] [blame] | 96 | out PDU_BSSGP, |
| 97 | PDU_LLC, |
| 98 | PDU_SN, |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 99 | NsStatusIndication, |
| 100 | BssgpStatusIndication, |
Harald Welte | 93331e7 | 2020-09-12 20:51:05 +0200 | [diff] [blame] | 101 | ASP_Event |
| 102 | #ifdef BSSGP_EM_L3 |
| 103 | , |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 104 | PDU_L3_MS_SGSN, |
Harald Welte | 93331e7 | 2020-09-12 20:51:05 +0200 | [diff] [blame] | 105 | PDU_L3_SGSN_MS |
| 106 | #endif |
| 107 | ; |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 108 | } with { extension "internal" }; |
| 109 | |
| 110 | /* port from the user point of view */ |
| 111 | type port BSSGP_PT message { |
| 112 | in ASP_Event, |
| 113 | NsStatusIndication, |
| 114 | BssgpStatusIndication, |
Harald Welte | 955aa94 | 2019-05-03 01:29:29 +0200 | [diff] [blame] | 115 | PDU_BSSGP, |
| 116 | PDU_LLC, |
Harald Welte | 93331e7 | 2020-09-12 20:51:05 +0200 | [diff] [blame] | 117 | PDU_SN |
| 118 | #ifdef BSSGP_EM_L3 |
| 119 | , |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 120 | PDU_L3_MS_SGSN, |
Harald Welte | 93331e7 | 2020-09-12 20:51:05 +0200 | [diff] [blame] | 121 | PDU_L3_SGSN_MS |
| 122 | #endif |
| 123 | ; |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 124 | out PDU_BSSGP, |
Harald Welte | 93331e7 | 2020-09-12 20:51:05 +0200 | [diff] [blame] | 125 | PDU_LLC |
| 126 | #ifdef BSSGP_EM_L3 |
| 127 | , |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 128 | PDU_L3_SGSN_MS, |
Harald Welte | 93331e7 | 2020-09-12 20:51:05 +0200 | [diff] [blame] | 129 | PDU_L3_MS_SGSN |
| 130 | #endif |
| 131 | ; |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 132 | } with { extension "internal" }; |
| 133 | |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 134 | signature BSSGP_register_client(hexstring imsi, OCT4 tlli); |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 135 | signature BSSGP_unregister_client(hexstring imsi); |
Harald Welte | f70997d | 2018-02-17 10:11:19 +0100 | [diff] [blame] | 136 | signature BSSGP_llgmm_assign(OCT4 tlli_old, OCT4 tlli); |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 137 | |
| 138 | type port BSSGP_PROC_PT procedure { |
Harald Welte | f70997d | 2018-02-17 10:11:19 +0100 | [diff] [blame] | 139 | inout BSSGP_register_client, BSSGP_unregister_client, BSSGP_llgmm_assign; |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 140 | } with { extension "internal" }; |
| 141 | |
| 142 | |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 143 | |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 144 | /*********************************************************************** |
| 145 | * Client Component for a single MS/TLLI |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 146 | *********************************************************************** |
| 147 | * This is what most users will want to derive their test cases from. It |
| 148 | * provides a set of three different ports (PTP, signaling, procedure) |
| 149 | * for (currently up to 3) different Cells. Those ports are all connected |
| 150 | * to one or multiple different per-BVC compoennts, depending on whether |
| 151 | * they share the same BSS or not. |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 152 | ***********************************************************************/ |
| 153 | |
| 154 | type component BSSGP_Client_CT { |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 155 | /* one port array for each client; allows talking to up to 3 BVC/Cell (handover, ...) */ |
| 156 | port BSSGP_PT BSSGP[3]; /* PTP-BVC */ |
| 157 | port BSSGP_PT BSSGP_SIG[3]; /* Signaling BVC */ |
| 158 | port BSSGP_PROC_PT BSSGP_PROC[3]; /* registration / deregistration */ |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 159 | }; |
| 160 | |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 161 | function f_bssgp_client_register(hexstring imsi, OCT4 tlli, BSSGP_PROC_PT PT := BSSGP_PROC[0]) |
| 162 | runs on BSSGP_Client_CT { |
| 163 | PT.call(BSSGP_register_client:{imsi, tlli}) { |
| 164 | [] PT.getreply(BSSGP_register_client:{imsi, tlli}) {}; |
| 165 | } |
| 166 | } |
| 167 | |
| 168 | function f_bssgp_client_unregister(hexstring imsi, BSSGP_PROC_PT PT := BSSGP_PROC[0]) |
| 169 | runs on BSSGP_Client_CT { |
| 170 | PT.call(BSSGP_unregister_client:{imsi}) { |
| 171 | [] PT.getreply(BSSGP_unregister_client:{imsi}) {}; |
| 172 | } |
| 173 | } |
| 174 | |
| 175 | /* TS 44.064 7.2.1.1 LLGMM-ASSIGN */ |
| 176 | function f_bssgp_client_llgmm_assign(OCT4 tlli_old, OCT4 tlli_new, BSSGP_PROC_PT PT := BSSGP_PROC[0]) |
| 177 | runs on BSSGP_Client_CT { |
| 178 | PT.call(BSSGP_llgmm_assign:{tlli_old, tlli_new}) { |
| 179 | [] PT.getreply(BSSGP_llgmm_assign:{tlli_old, tlli_new}) {}; |
| 180 | } |
| 181 | } |
| 182 | |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 183 | /*********************************************************************** |
| 184 | * Main Component |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 185 | *********************************************************************** |
| 186 | * This component exists once, and it runs on to of the NS_Emulation. |
| 187 | * It handles the BVC-RESET for the signaling BVCI, and dispatches messages |
| 188 | * to the per-BVC components running above it. Messages are routed by: |
| 189 | * - PTP BVCI in NS header (if non-0) |
| 190 | * - BVCI IE in messages on BVCI=0 in NS header |
| 191 | * Messages for which no unique BVC can be identified (like paging without |
| 192 | * a BVCI IE set) are broadcast to all BVC components. |
| 193 | * We also broadcast state changes (BssgpStatusIndication) and reset events |
| 194 | * (BssgpResetIndication) of the signaling BVC to all per-BVC components. |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 195 | ***********************************************************************/ |
| 196 | |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 197 | function BssgpStart(BssgpConfig cfg, charstring id) runs on BSSGP_CT { |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 198 | g_cfg := cfg; |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 199 | |
| 200 | /* create the per-BVC components based on the configuration */ |
| 201 | for (var integer i := 0; i < lengthof(g_cfg.bvc); i := i+1) { |
| 202 | var BssgpBvcConfig bvc_cfg := g_cfg.bvc[i]; |
| 203 | var charstring bvc_id := id & "-BVCI" & int2str(bvc_cfg.bvci); |
| 204 | /* create, connect and start the BVC component */ |
| 205 | var BSSGP_BVC_CT bvc_ct := BSSGP_BVC_CT.create(bvc_id); |
| 206 | connect(bvc_ct:BVC, self:BVC); |
| 207 | bvc_ct.start(f_bssgp_bvc_main(bvc_cfg, g_cfg.sgsn_role, bvc_id)); |
| 208 | /* populate the BVC state table */ |
| 209 | BvcTable[i] := { |
| 210 | bvci := bvc_cfg.bvci, |
| 211 | cell_id := bvc_cfg.cell_id, |
| 212 | comp_ref := bvc_ct |
| 213 | }; |
| 214 | } |
| 215 | |
| 216 | if (g_cfg.sgsn_role) { |
| 217 | /* The SGSN side waits for an inbound BVC-RESET on the signaling BVC */ |
| 218 | f_sign_change_state(BVC_S_WAIT_RESET); |
| 219 | } else { |
| 220 | /* The BSS/PCU side waits for an inbound NsStatusIndication to Tx BVC-RESET */ |
| 221 | f_sign_change_state(BVC_S_WAIT_NS_ALIVE_UNBLOCKED); |
| 222 | } |
| 223 | |
| 224 | /* main loop */ |
| 225 | f_bssgp_ScanEvents(); |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 226 | } |
| 227 | |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 228 | /* master component, exists once per BSSGP instance (NSE) */ |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 229 | type component BSSGP_CT { |
Stefan Sperling | f82bbb6 | 2018-05-03 19:14:28 +0200 | [diff] [blame] | 230 | /* UDP ports towards the bottom (IUT) */ |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 231 | port NS_PT BSCP; |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 232 | |
| 233 | /* control by the user */ |
| 234 | port BSSGP_CT_PROC_PT PROC; |
| 235 | |
| 236 | var BssgpConfig g_cfg; |
| 237 | |
| 238 | /* Signaling BVC (BVCI=0) */ |
| 239 | var BvcState g_sign_bvc_state := BVC_S_WAIT_RESET; |
| 240 | timer g_T2 := 60.0; |
| 241 | |
| 242 | /* port to per-BVC components */ |
| 243 | port BSSGP_BVC_SP_PT BVC; |
| 244 | /* per-BVC state table */ |
| 245 | var BvcEntity BvcTable[16]; |
| 246 | }; |
| 247 | |
| 248 | /* one element in the per-BVC state table */ |
| 249 | type record BvcEntity { |
| 250 | /* PTP BVCI of this BVC/Cell */ |
| 251 | BssgpBvci bvci, |
| 252 | /* Cell Identity of this cell */ |
| 253 | BssgpCellId cell_id, |
| 254 | /* reference to the per-BVC/cell component */ |
| 255 | BSSGP_BVC_CT comp_ref |
| 256 | }; |
| 257 | |
| 258 | /* find the per-BVC component for a given BVCI */ |
| 259 | private function f_comp_for_bvci(BssgpBvci bvci) runs on BSSGP_CT return BSSGP_BVC_CT { |
| 260 | var integer i; |
| 261 | |
| 262 | for (i := 0; i < lengthof(BvcTable); i := i+1) { |
| 263 | if (BvcTable[i].bvci == bvci) { |
| 264 | return BvcTable[i].comp_ref; |
| 265 | } |
| 266 | } |
| 267 | return null; |
| 268 | } |
| 269 | |
| 270 | /* We are in BVC_S_WAIT_RSET state (only happens in SGSN role) */ |
| 271 | altstep as_sig_wait_reset() runs on BSSGP_CT { |
| 272 | var NsUnitdataIndication udi; |
| 273 | |
| 274 | /* Respond to RESET for signalling BVCI 0 */ |
| 275 | [] BSCP.receive(f_BnsUdInd(tr_BVC_RESET(?, 0, omit), 0)) -> value udi { |
| 276 | log("Rx BVC-RESET for Signaling BVCI=0"); |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 277 | BSCP.send(f_BnsUdReq(ts_BVC_RESET_ACK(0, omit), 0, 0)); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 278 | f_sign_change_state(BVC_S_UNBLOCKED); |
| 279 | } |
| 280 | |
| 281 | /* work-around for old, buggy libosmogb before Change-Id Ie87820537d6d616da4fd4bbf73eab06e28fda5e1 */ |
| 282 | [mp_tolerate_bvc_reset_cellid] BSCP.receive(f_BnsUdInd(tr_BVC_RESET(?, 0, g_cfg.bvc[0].cell_id), 0)) -> value udi { |
| 283 | log("Rx BVC-RESET for Signaling BVCI=0"); |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 284 | BSCP.send(f_BnsUdReq(ts_BVC_RESET_ACK(0, omit), 0, 0)); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 285 | f_sign_change_state(BVC_S_UNBLOCKED); |
| 286 | } |
| 287 | } |
| 288 | |
| 289 | /* We are in BVC_S_UNBLOCKED state */ |
| 290 | altstep as_sig_unblocked() runs on BSSGP_CT { |
| 291 | var BSSGP_BVC_CT bvc_comp_ref; |
| 292 | var BSSGP_Client_CT vc_conn; |
| 293 | var NsUnitdataIndication udi; |
| 294 | var NsUnitdataRequest udr; |
| 295 | |
| 296 | /* Messages PTP BVCI in BVCI field of NS: dispatch by that */ |
| 297 | [] BSCP.receive(f_BnsUdInd(?, (2..65535))) -> value udi { |
| 298 | bvc_comp_ref := f_comp_for_bvci(valueof(udi.bvci)); |
| 299 | if (isbound(bvc_comp_ref) and bvc_comp_ref != null) { |
| 300 | /* dispatch to BVC component */ |
| 301 | BVC.send(udi) to bvc_comp_ref; |
| 302 | } else { |
| 303 | setverdict(fail, "Rx BSSGP for unknown PTP BVCI ", udi.bvci, ": ", udi.bssgp); |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 304 | BSCP.send(f_BnsUdReq(ts_BSSGP_STATUS(udi.bvci, BSSGP_CAUSE_BVCI_UNKNOWN, udi.bssgp), udi.bvci, 0)); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 305 | } |
| 306 | } |
| 307 | |
| 308 | /* Messages with BVCI = 0 (Signaling) in BVCI field of NS */ |
| 309 | |
| 310 | /* Route based on PTP BVCI in payload/IE of signaling PDU */ |
| 311 | [] BSCP.receive(f_BnsUdInd(?, 0)) -> value udi { |
| 312 | var template (omit) BssgpBvci ptp_bvci := f_BSSGP_BVCI_get(udi.bssgp); |
| 313 | if (istemplatekind(ptp_bvci, "omit")) { |
| 314 | log("Rx on SIG BVCI without PTP BVCI: broadcasting"); |
| 315 | for (var integer i := 0; i < lengthof(BvcTable); i := i+1) { |
| 316 | if (isbound(BvcTable[i].comp_ref) and BvcTable[i].comp_ref != null) { |
| 317 | BVC.send(udi) to BvcTable[i].comp_ref; |
| 318 | } |
| 319 | } |
| 320 | } else { |
| 321 | bvc_comp_ref := f_comp_for_bvci(valueof(ptp_bvci)); |
| 322 | if (isbound(bvc_comp_ref) and bvc_comp_ref != null) { |
| 323 | /* dispatch to BVC component */ |
| 324 | BVC.send(udi) to bvc_comp_ref; |
| 325 | } else { |
| 326 | setverdict(fail, "Rx SIG BSSGP for unknown PTP BVCI ", ptp_bvci, ": ", udi.bssgp); |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 327 | BSCP.send(f_BnsUdReq(ts_BSSGP_STATUS(udi.bvci, BSSGP_CAUSE_BVCI_UNKNOWN, udi.bssgp), 0, 0)); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 328 | } |
| 329 | } |
| 330 | } |
| 331 | |
| 332 | /* Handle PS-PAGING on SIGN BVCI with no conditional BVCI IE */ |
| 333 | [] BSCP.receive(f_BnsUdInd(PDU_BSSGP:{pDU_BSSGP_PAGING_PS:=?}, 0)) -> value udi { |
| 334 | /* FIXME: use LA, RA or BSS Area to dispatch instead of broadcast */ |
| 335 | for (var integer i := 0; i < lengthof(BvcTable); i := i+1) { |
| 336 | if (isbound(BvcTable[i].comp_ref) and BvcTable[i].comp_ref != null) { |
| 337 | BVC.send(udi) to BvcTable[i].comp_ref; |
| 338 | } |
| 339 | } |
| 340 | } |
| 341 | /* Handle CS-PAGING on SIGN BVCI with no conditional BVCI IE */ |
| 342 | [] BSCP.receive(f_BnsUdInd(PDU_BSSGP:{pDU_BSSGP_PAGING_CS:=?}, 0)) -> value udi { |
| 343 | /* FIXME: use LA, RA or BSS Area to dispatch instead of broadcast */ |
| 344 | for (var integer i := 0; i < lengthof(BvcTable); i := i+1) { |
| 345 | if (isbound(BvcTable[i].comp_ref) and BvcTable[i].comp_ref != null) { |
| 346 | BVC.send(udi) to BvcTable[i].comp_ref; |
| 347 | } |
| 348 | } |
| 349 | } |
| 350 | |
| 351 | /* per-BVC component sends us something; forward to NS without any validation */ |
| 352 | [] BVC.receive(NsUnitdataRequest:?) -> value udr { |
| 353 | /* patch in the NSEI, as the per-BVC components have no idea about it */ |
| 354 | udr.nsei := g_cfg.nsei; |
| 355 | BSCP.send(udr); |
| 356 | } |
| 357 | } |
| 358 | |
| 359 | /* We are in BVC_S_WAIT_NS_ALIVE_UNBLOCKED (only happens in BSS role) */ |
| 360 | altstep as_sig_wait_ns_alive_unblocked() runs on BSSGP_CT { |
| 361 | var NsStatusIndication nsi; |
Harald Welte | dc0a090 | 2020-11-10 21:03:29 +0100 | [diff] [blame] | 362 | [] BSCP.receive(NsStatusIndication:{g_cfg.nsei,?, complement (NSVC_S_ALIVE_UNBLOCKED), NSVC_S_ALIVE_UNBLOCKED, true}) -> value nsi { |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 363 | /* if we just became NS-unblocked, send a BCC-RESET */ |
| 364 | if (g_cfg.sgsn_role == false) { |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 365 | BSCP.send(f_BnsUdReq(ts_BVC_RESET(BSSGP_CAUSE_OM_INTERVENTION, 0, omit), 0, 0)); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 366 | g_T2.start; |
| 367 | /* The BVC_RESET_ACK is handled in the as_sig_allstate() below */ |
| 368 | } |
| 369 | /* Idea: We could send BVC-UNBLOCK here like some SGSN do */ |
| 370 | } |
| 371 | |
| 372 | } |
| 373 | |
| 374 | /* handling of events irrespective of BVC state */ |
| 375 | altstep as_sig_allstate() runs on BSSGP_CT { |
| 376 | var BSSGP_Client_CT vc_conn; |
| 377 | var NsUnitdataIndication udi; |
| 378 | var NsStatusIndication nsi; |
| 379 | var ASP_Event evt; |
| 380 | var BSSGP_BVC_CT bvc_comp_ref; |
| 381 | var BssgpBvci bvci; |
| 382 | |
| 383 | /* Respond to RESET for signalling BVCI 0 */ |
| 384 | [] BSCP.receive(f_BnsUdInd(tr_BVC_RESET(?, 0, omit), 0)) -> value udi { |
| 385 | log("Rx BVC-RESET for Signaling BVCI=0"); |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 386 | BSCP.send(f_BnsUdReq(ts_BVC_RESET_ACK(0, omit), 0, 0)); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 387 | for (var integer i := 0; i < sizeof(BvcTable); i := i+1) { |
| 388 | if (isbound(BvcTable[i].comp_ref) and BvcTable[i].comp_ref != null) { |
| 389 | BVC.send(BssgpResetIndication:{0}) to BvcTable[i].comp_ref; |
| 390 | } |
| 391 | } |
| 392 | } |
| 393 | |
| 394 | /* any BLOCK or UNBLOCK for the SIGNALING BVCI are illegal */ |
| 395 | [] BSCP.receive(f_BnsUdInd(t_BVC_BLOCK(0, ?), 0)) -> value udi { |
| 396 | setverdict(fail, "Rx BVC-BLOCK illegal for BVCI=0: ", udi); |
| 397 | } |
| 398 | [] BSCP.receive(f_BnsUdInd(t_BVC_UNBLOCK(0), 0)) -> value udi { |
| 399 | setverdict(fail, "Rx BVC-UNBLOCK illegal for BVCI=0: ", udi); |
| 400 | } |
| 401 | [] BSCP.receive(f_BnsUdInd(t_BVC_BLOCK_ACK(0), 0)) -> value udi { |
| 402 | setverdict(fail, "Rx BVC-BLOCK-ACK illegal for BVCI=0: ", udi); |
| 403 | } |
| 404 | [] BSCP.receive(f_BnsUdInd(t_BVC_UNBLOCK_ACK(0), 0)) -> value udi { |
| 405 | setverdict(fail, "Rx BVC-UNBLOCK-ACK illegal for BVCI=0: ", udi); |
| 406 | } |
| 407 | |
| 408 | /* Respond to BLOCK for wrong BVCI */ |
| 409 | [] BSCP.receive(f_BnsUdInd(t_BVC_BLOCK(?, ?), 0)) -> value udi { |
| 410 | setverdict(fail, "Rx BVC-BLOCK for unknown BVCI"); |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 411 | BSCP.send(f_BnsUdReq(ts_BSSGP_STATUS(0, BSSGP_CAUSE_BVCI_UNKNOWN, udi.bssgp), 0, 0)); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 412 | } |
| 413 | |
| 414 | /* Respond to RESET with wrong BVCI */ |
| 415 | [] BSCP.receive(f_BnsUdInd(tr_BVC_RESET(?, ?, ?), 0)) -> value udi { |
| 416 | var BssgpBvci ptp_bvci := oct2int(udi.bssgp.pDU_BSSGP_BVC_RESET.bVCI.unstructured_value); |
| 417 | setverdict(fail, "Rx BVC-RESET for unknown BVCI ", ptp_bvci); |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 418 | BSCP.send(f_BnsUdReq(ts_BSSGP_STATUS(ptp_bvci, BSSGP_CAUSE_BVCI_UNKNOWN, udi.bssgp), 0, 0)); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 419 | } |
| 420 | |
| 421 | /* BVC-RESET-ACK for BVCI=0 while T2 is running: Answer to a BVC-RESET we sent earlier */ |
| 422 | [g_T2.running] BSCP.receive(f_BnsUdInd(tr_BVC_RESET_ACK(0, omit), 0)) -> value udi { |
| 423 | log("BVCI(0) Rx BVC-RESET-ACK"); |
| 424 | g_T2.stop; |
| 425 | f_sign_change_state(BVC_S_UNBLOCKED); |
| 426 | for (var integer i := 0; i < sizeof(BvcTable); i := i+1) { |
| 427 | if (isbound(BvcTable[i].comp_ref) and BvcTable[i].comp_ref != null) { |
| 428 | BVC.send(BssgpResetIndication:{0}) to BvcTable[i].comp_ref; |
| 429 | } |
| 430 | } |
| 431 | } |
| 432 | [] g_T2.timeout { |
| 433 | setverdict(fail, "Timeout waiting for BVC-RESET-ACK on BVCI=0"); |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 434 | BSCP.send(f_BnsUdReq(ts_BSSGP_STATUS(udi.bvci, BSSGP_CAUSE_BVCI_UNKNOWN, udi.bssgp), 0, 0)); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 435 | g_T2.start; |
| 436 | } |
| 437 | |
| 438 | /* default case of handling unknown PDUs */ |
| 439 | [] BSCP.receive(f_BnsUdInd(?, ?)) -> value udi { |
| 440 | setverdict(fail, "Rx Unexpected BSSGP PDU ", udi.bssgp," in state ", g_sign_bvc_state); |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 441 | BSCP.send(f_BnsUdReq(ts_BSSGP_STATUS(0, BSSGP_CAUSE_PDU_NOT_COMPATIBLE_WITH_PROTOCOL_STATE, udi.bssgp), 0, 0)); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 442 | } |
| 443 | |
| 444 | /* Forwarding of ASP_Event to per-BVC components */ |
| 445 | [] BSCP.receive(ASP_Event:?) -> value evt { |
| 446 | for (var integer i := 0; i < sizeof(BvcTable); i := i+1) { |
| 447 | if (isbound(BvcTable[i].comp_ref) and BvcTable[i].comp_ref != null) { |
| 448 | BVC.send(evt) to BvcTable[i].comp_ref; |
| 449 | } |
| 450 | } |
| 451 | } |
| 452 | /* Keep NS Status Indicaitons to us; no need to inform per-BVC components [for now?] */ |
Harald Welte | dc0a090 | 2020-11-10 21:03:29 +0100 | [diff] [blame] | 453 | [] BSCP.receive(tr_NsStsInd(g_cfg.nsei)) -> value nsi { } |
Harald Welte | 445fc61 | 2020-11-10 19:15:30 +0100 | [diff] [blame] | 454 | /* We should never see any different NSEI: There's one BSSGP_CT per NSE */ |
Harald Welte | dc0a090 | 2020-11-10 21:03:29 +0100 | [diff] [blame] | 455 | [] BSCP.receive(tr_NsStsInd(?)) -> value nsi { |
Harald Welte | 445fc61 | 2020-11-10 19:15:30 +0100 | [diff] [blame] | 456 | setverdict(fail, "Rx NsStatusInd for wrong NSEI ", nsi); |
| 457 | } |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 458 | |
| 459 | /* Procedure port request to resolve the per-BVC component for a given ptp BVCI */ |
| 460 | [] PROC.getcall(BSSGP_get_bvci_ct:{?}) -> param(bvci) sender vc_conn { |
| 461 | for (var integer i := 0; i < sizeof(BvcTable); i := i+1) { |
| 462 | if (BvcTable[i].bvci == bvci) { |
| 463 | PROC.reply(BSSGP_get_bvci_ct:{bvci} value BvcTable[i].comp_ref) to vc_conn; |
| 464 | return; |
| 465 | } |
| 466 | } |
| 467 | } |
| 468 | } |
| 469 | |
| 470 | /* send the highest decoded layer of the message through given port */ |
| 471 | private function f_send_bssgp_dec(BssgpDecoded dec, BSSGP_Client_CT vc_conn, BSSGP_SP_PT pt) { |
| 472 | #ifdef BSSGP_EM_L3 |
| 473 | if (ispresent(dec.l3_mt)) { |
| 474 | pt.send(dec.l3_mt) to vc_conn; |
| 475 | } else if (ispresent(dec.l3_mo)) { |
| 476 | pt.send(dec.l3_mo) to vc_conn; |
| 477 | } else |
| 478 | #endif |
| 479 | if (ispresent(dec.sndcp)) { |
| 480 | pt.send(dec.sndcp) to vc_conn; |
| 481 | } else if (ispresent(dec.llc)) { |
| 482 | pt.send(dec.llc) to vc_conn; |
| 483 | } else { |
| 484 | pt.send(dec.bssgp) to vc_conn; |
| 485 | } |
| 486 | } |
| 487 | |
| 488 | |
| 489 | function f_llc_get_n_u_tx(inout LLC_Entity llc) return uint9_t { |
| 490 | var uint9_t ret := llc.n_u_tx_next; |
| 491 | llc.n_u_tx_next := llc.n_u_tx_next + 1; |
| 492 | return ret; |
| 493 | } |
| 494 | |
| 495 | #ifdef BSSGP_EM_L3 |
| 496 | function f_llc_sapi_by_l3_mo(PDU_L3_MS_SGSN l3_mo) return BIT4 { |
| 497 | if (ischosen(l3_mo.msgs.gprs_mm)) { |
| 498 | return c_LLC_SAPI_LLGMM; |
| 499 | } else if (ischosen(l3_mo.msgs.gprs_sm)) { |
| 500 | return c_LLC_SAPI_LLGMM; |
| 501 | } else if (ischosen(l3_mo.msgs.sms)) { |
| 502 | return c_LLC_SAPI_LLSMS; |
| 503 | } |
| 504 | setverdict(fail, "No LLC SAPI for ", l3_mo); |
| 505 | mtc.stop; |
| 506 | } |
| 507 | |
| 508 | private function f_llc_sapi_by_l3_mt(PDU_L3_SGSN_MS l3_mt) return BIT4 { |
| 509 | if (ischosen(l3_mt.msgs.gprs_mm)) { |
| 510 | return c_LLC_SAPI_LLGMM; |
| 511 | } else if (ischosen(l3_mt.msgs.gprs_sm)) { |
| 512 | return c_LLC_SAPI_LLGMM; |
| 513 | } else if (ischosen(l3_mt.msgs.sms)) { |
| 514 | return c_LLC_SAPI_LLSMS; |
| 515 | } |
| 516 | setverdict(fail, "No LLC SAPI for ", l3_mt); |
| 517 | mtc.stop; |
| 518 | } |
| 519 | #endif |
| 520 | |
| 521 | /* main loop of BSSGP_CT */ |
| 522 | private function f_bssgp_ScanEvents() runs on BSSGP_CT { |
| 523 | while (true) { |
| 524 | alt { |
| 525 | [g_sign_bvc_state == BVC_S_WAIT_RESET] as_sig_wait_reset(); |
| 526 | [g_sign_bvc_state == BVC_S_WAIT_NS_ALIVE_UNBLOCKED] as_sig_wait_ns_alive_unblocked(); |
| 527 | [g_sign_bvc_state == BVC_S_UNBLOCKED] as_sig_unblocked(); |
| 528 | [] as_sig_allstate(); |
| 529 | } |
| 530 | } /* while */ |
| 531 | } |
| 532 | |
| 533 | /* generate a send template. Cannot be a real template as we want to use g_cfg.nsei */ |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 534 | private function f_BnsUdReq(template PDU_BSSGP pdu, BssgpBvci bvci, integer lsp) |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 535 | runs on BSSGP_CT return NsUnitdataRequest { |
| 536 | var NsUnitdataRequest udr := { |
| 537 | bvci := bvci, |
| 538 | nsei := g_cfg.nsei, |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 539 | lsp := lsp, |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 540 | /* for some weird reason we get "Dynamic test case error: Text encoder: Encoding an |
| 541 | * unbound integer value." when trying to send the reocrd rather than the octetstring */ |
| 542 | //sdu := omit, |
| 543 | //bssgp := valueof(pdu) |
| 544 | sdu := enc_PDU_BSSGP(valueof(pdu)), |
| 545 | bssgp := omit |
| 546 | } |
| 547 | return udr; |
| 548 | } |
| 549 | |
| 550 | /* generate a receive template. Cannot be a real template as we want to use g_cfg.nsei */ |
| 551 | private function f_BnsUdInd(template PDU_BSSGP pdu, template BssgpBvci bvci) |
| 552 | runs on BSSGP_CT return template (present) NsUnitdataIndication { |
| 553 | var template (present) NsUnitdataIndication udi := { |
| 554 | bvci := bvci, |
| 555 | nsei := g_cfg.nsei, |
| 556 | sdu := *, |
| 557 | bssgp := pdu |
| 558 | } |
| 559 | return udi; |
| 560 | } |
| 561 | |
| 562 | /* change state of signaling BVCI; notify per-BVC components */ |
| 563 | private function f_sign_change_state(BvcState new_state) runs on BSSGP_CT { |
| 564 | if (new_state == g_sign_bvc_state) { |
| 565 | return; |
| 566 | } |
| 567 | log("BVCI(0) State Transition: ", g_sign_bvc_state, " -> ", new_state); |
| 568 | g_sign_bvc_state := new_state; |
| 569 | for (var integer i := 0; i < sizeof(BvcTable); i := i+1) { |
| 570 | if (isbound(BvcTable[i].comp_ref) and BvcTable[i].comp_ref != null) { |
| 571 | BVC.send(ts_BssgpStsInd(g_cfg.nsei, 0, g_sign_bvc_state)) to BvcTable[i].comp_ref; |
| 572 | } |
| 573 | } |
| 574 | } |
| 575 | |
| 576 | /* User wants to get per-BVC component reference from BSSGP_CT */ |
| 577 | signature BSSGP_get_bvci_ct(BssgpBvci bvci) return BSSGP_BVC_CT; |
| 578 | |
| 579 | type port BSSGP_CT_PROC_PT procedure { |
| 580 | inout BSSGP_get_bvci_ct |
| 581 | } with { extension "internal" }; |
| 582 | |
| 583 | /* convenience wrapper function for user */ |
| 584 | function f_bssgp_get_bvci_ct(BssgpBvci bvci, BSSGP_CT_PROC_PT PT) return BSSGP_BVC_CT { |
| 585 | var BSSGP_BVC_CT res; |
| 586 | PT.call(BSSGP_get_bvci_ct:{bvci}) { |
| 587 | [] PT.getreply(BSSGP_get_bvci_ct:{bvci})-> value res { |
| 588 | return res; |
| 589 | } |
| 590 | } |
| 591 | } |
| 592 | |
| 593 | /*********************************************************************** |
| 594 | * per-BVC (Cell) Component |
| 595 | *********************************************************************** |
| 596 | * Any number of these components runs on top of the BSSGP_CT, each |
| 597 | * representing one PTP BVC within this NSE. Users (test cases) can |
| 598 | * register with TLLI and/or IMSI via the procedure port. |
| 599 | ***********************************************************************/ |
| 600 | |
| 601 | /* per-BVC component. Exists once per cell within a BSSGP_CT */ |
| 602 | type component BSSGP_BVC_CT { |
| 603 | /* port towards the underlying BSSGP_CT */ |
| 604 | port BSSGP_BVC_PT BVC; |
| 605 | |
| 606 | /* BSSGP-User SAP towards the user (Client) */ |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 607 | port BSSGP_SP_PT BSSGP_SP; |
Stefan Sperling | f82bbb6 | 2018-05-03 19:14:28 +0200 | [diff] [blame] | 608 | port BSSGP_SP_PT BSSGP_SP_SIG; |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 609 | port BSSGP_PROC_PT BSSGP_PROC; |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 610 | |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 611 | var BssgpBvcConfig g_cfg; |
| 612 | var boolean g_sgsn_role; |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 613 | |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 614 | /* default Link Selector Parameter for this BVC (for traffic unrelated to a TLLI) */ |
| 615 | var integer g_bvc_lsp; |
| 616 | |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 617 | var BvcState g_ptp_bvc_state := BVC_S_BLOCKED; |
| 618 | timer g_T1 := 15.0; |
| 619 | timer g_T2 := 60.0; |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 620 | var boolean g_t1_waits_for_block_ack := false; |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 621 | |
| 622 | var ClientEntity ClientTable[16]; |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 623 | }; |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 624 | |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 625 | /* port between global BSSGP_CT and per-BVC BSSGP_BVC_CT */ |
| 626 | type port BSSGP_BVC_SP_PT message { |
| 627 | in NsUnitdataRequest; |
| 628 | out ASP_Event, |
| 629 | BssgpStatusIndication, |
| 630 | BssgpResetIndication, |
| 631 | NsUnitdataIndication; |
| 632 | } with { extension "internal" }; |
| 633 | type port BSSGP_BVC_PT message { |
| 634 | in ASP_Event, |
| 635 | BssgpStatusIndication, |
| 636 | BssgpResetIndication, |
| 637 | NsUnitdataIndication; |
| 638 | out NsUnitdataRequest; |
| 639 | } with { extension "internal" }; |
Alexander Couzens | 6b449fb | 2018-07-31 14:19:36 +0200 | [diff] [blame] | 640 | |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 641 | |
| 642 | /* one element in the per-TLLI state table */ |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 643 | type record ClientEntity { |
| 644 | OCT4 tlli, |
| 645 | OCT4 tlli_old optional, |
| 646 | hexstring imsi, |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 647 | BSSGP_Client_CT comp_ref, |
| 648 | /* LLC entities, one for each SAPI */ |
| 649 | LLC_Entity llc[16] |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 650 | }; |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 651 | type record LLC_Entity { |
| 652 | boolean sgsn_role, |
| 653 | /* N(U) on transmit side for next PDU */ |
| 654 | uint9_t n_u_tx_next, |
| 655 | /* N(U) on receive side, last PDU */ |
| 656 | uint9_t n_u_rx_last optional |
| 657 | }; |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 658 | type record length(16) of LLC_Entity LLC_Entities; |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 659 | |
Alexander Couzens | cdfb751 | 2018-07-31 15:37:14 +0200 | [diff] [blame] | 660 | function f_llc_create(boolean sgsn_role := false) return LLC_Entities { |
| 661 | var LLC_Entities llc; |
| 662 | for (var integer i := 0; i < 16; i := i+1) { |
| 663 | llc[i] := valueof(t_LLC_init(sgsn_role)); |
| 664 | } |
| 665 | return llc; |
| 666 | } |
| 667 | |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 668 | private template LLC_Entity t_LLC_init(boolean sgsn_role := false) := { |
| 669 | sgsn_role := sgsn_role, |
| 670 | n_u_tx_next := 0, |
| 671 | n_u_rx_last := - |
| 672 | } |
| 673 | |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 674 | /* configuration of BSSGP_CT */ |
| 675 | type record BssgpConfig { |
| 676 | Nsvci nsei, |
| 677 | boolean sgsn_role, |
| 678 | BssgpBvcConfigs bvc |
| 679 | }; |
| 680 | /* Configuration of one BVC (Cell) BSSGP_BVC_CT */ |
| 681 | type record BssgpBvcConfig { |
| 682 | BssgpBvci bvci, |
| 683 | BssgpCellId cell_id, |
| 684 | BssgpDecodeDepth depth |
| 685 | }; |
| 686 | type record of BssgpBvcConfig BssgpBvcConfigs; |
Oliver Smith | aac9b9c | 2019-09-02 08:36:36 +0200 | [diff] [blame] | 687 | type enumerated BssgpDecodeDepth { |
| 688 | BSSGP_DECODE_DEPTH_BSSGP, |
| 689 | BSSGP_DECODE_DEPTH_LLC, |
Harald Welte | 93331e7 | 2020-09-12 20:51:05 +0200 | [diff] [blame] | 690 | BSSGP_DECODE_DEPTH_SNDCP |
| 691 | #ifdef BSSGP_EM_L3 |
| 692 | , |
Oliver Smith | aac9b9c | 2019-09-02 08:36:36 +0200 | [diff] [blame] | 693 | BSSGP_DECODE_DEPTH_L3 |
Harald Welte | 93331e7 | 2020-09-12 20:51:05 +0200 | [diff] [blame] | 694 | #endif |
Oliver Smith | aac9b9c | 2019-09-02 08:36:36 +0200 | [diff] [blame] | 695 | }; |
| 696 | |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 697 | /* |
| 698 | private function f_tbl_init() runs on BSSGP_BVC_CT { |
| 699 | var integer i; |
| 700 | for (i := 0; i < sizeof(ImsiTable); i := i+1) { |
| 701 | ImsiTable[i] := -; |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 702 | } |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 703 | |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 704 | for (i := 0; i < sizeof(TlliTable); i := i+1) { |
| 705 | TlliTable[i] := -; |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 706 | } |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 707 | } |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 708 | */ |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 709 | |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 710 | private function f_tbl_client_add(hexstring imsi, OCT4 tlli, BSSGP_Client_CT vc_conn) |
| 711 | runs on BSSGP_BVC_CT { |
| 712 | var integer i; |
| 713 | for (i := 0; i < sizeof(ClientTable); i := i+1) { |
| 714 | if (not isvalue(ClientTable[i].comp_ref)) { |
| 715 | log("Adding Client=", vc_conn, ", IMSI=", imsi, ", TLLI=", tlli, ", index=", i); |
| 716 | ClientTable[i] := { |
| 717 | tlli := tlli, |
| 718 | tlli_old := omit, |
| 719 | imsi := imsi, |
| 720 | comp_ref := vc_conn, |
| 721 | llc := - |
| 722 | }; |
| 723 | for (var integer j := 0; j < sizeof(ClientTable[i].llc); j := j+1) { |
| 724 | ClientTable[i].llc[j] := valueof(t_LLC_init(g_sgsn_role)); |
| 725 | } |
| 726 | return; |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 727 | } |
| 728 | } |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 729 | testcase.stop("Client Table full"); |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 730 | } |
| 731 | |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 732 | private function f_tbl_client_del(hexstring imsi, BSSGP_Client_CT vc_conn) runs on BSSGP_BVC_CT { |
| 733 | var integer i; |
| 734 | for (i := 0; i < sizeof(ClientTable); i := i+1) { |
| 735 | if (isvalue(ClientTable[i].imsi) and ClientTable[i].imsi == imsi) { |
| 736 | if (ClientTable[i].comp_ref != vc_conn) { |
| 737 | setverdict(fail, "Cannot unregister index=", i, " IMSI ", imsi, " registred to ", |
| 738 | ClientTable[i].comp_ref, " from ", vc_conn); |
| 739 | mtc.stop; |
| 740 | } |
| 741 | log("Removing Client IMSI=", imsi, ", index=", i); |
| 742 | ClientTable[i] := { |
| 743 | tlli := -, |
| 744 | tlli_old := omit, |
| 745 | imsi := ''H, |
| 746 | comp_ref := null, |
| 747 | llc := - }; |
| 748 | return; |
| 749 | } |
| 750 | } |
| 751 | log("Warning: Could not find client for IMSI ", imsi); |
| 752 | return; |
| 753 | } |
| 754 | |
| 755 | /* TS 44.064 7.2.1.1 LLGMM-ASSIGN */ |
| 756 | private function f_tbl_client_llgmm_assign(OCT4 tlli_old, OCT4 tlli_new, BSSGP_Client_CT vc_conn) |
| 757 | runs on BSSGP_BVC_CT { |
| 758 | var integer i := f_tbl_idx_by_comp(vc_conn); |
| 759 | |
| 760 | if (tlli_old == 'FFFFFFFF'O and tlli_new != 'FFFFFFFF'O) { |
| 761 | /* TLLI assignment */ |
| 762 | ClientTable[i].tlli := tlli_new; |
| 763 | ClientTable[i].tlli_old := omit; |
| 764 | } else if (tlli_old != 'FFFFFFFF'O and tlli_new != 'FFFFFFFF'O) { |
| 765 | /* TLLI change: both active */ |
| 766 | ClientTable[i].tlli := tlli_new; |
| 767 | ClientTable[i].tlli_old := tlli_old; |
| 768 | } else if (tlli_old != 'FFFFFFFF'O and tlli_new == 'FFFFFFFF'O) { |
| 769 | /* TLLI unassignment: old shall be unassigned; new stays */ |
| 770 | ClientTable[i].tlli_old := omit; |
| 771 | } |
| 772 | } |
| 773 | |
| 774 | private function f_tbl_comp_by_imsi(hexstring imsi) runs on BSSGP_BVC_CT return BSSGP_Client_CT { |
| 775 | var integer i; |
| 776 | for (i := 0; i < sizeof(ClientTable); i := i+1) { |
| 777 | if (isvalue(ClientTable[i].imsi) and isvalue(ClientTable[i].comp_ref) |
| 778 | and ClientTable[i].imsi == imsi) { |
| 779 | return ClientTable[i].comp_ref; |
| 780 | } |
| 781 | } |
| 782 | setverdict(fail, "Couldn't find Component for IMSI ", imsi); |
| 783 | mtc.stop; |
| 784 | } |
| 785 | |
| 786 | private function f_tbl_comp_by_tlli(OCT4 tlli) runs on BSSGP_BVC_CT return BSSGP_Client_CT { |
| 787 | var integer i; |
| 788 | for (i := 0; i < sizeof(ClientTable); i := i+1) { |
| 789 | if (isvalue(ClientTable[i].comp_ref) and |
| 790 | (isvalue(ClientTable[i].tlli) and (ClientTable[i].tlli == tlli or |
| 791 | isvalue(ClientTable[i].tlli_old) and ClientTable[i].tlli_old == tlli) )) { |
| 792 | return ClientTable[i].comp_ref; |
| 793 | } |
| 794 | } |
| 795 | setverdict(fail, "Couldn't find Component for TLLI ", tlli); |
| 796 | mtc.stop; |
| 797 | } |
| 798 | |
| 799 | private function f_tbl_idx_by_comp(BSSGP_Client_CT comp_ref) runs on BSSGP_BVC_CT return integer { |
| 800 | var integer i; |
| 801 | for (i := 0; i < sizeof(ClientTable); i := i+1) { |
| 802 | if (isvalue(ClientTable[i].comp_ref) and ClientTable[i].comp_ref == comp_ref) { |
| 803 | return i; |
| 804 | } |
| 805 | } |
| 806 | setverdict(fail, "Couldn't find Client for Component ", comp_ref); |
| 807 | mtc.stop; |
| 808 | } |
| 809 | |
| 810 | private function f_tbl_tlli_by_comp(BSSGP_Client_CT comp_ref) runs on BSSGP_BVC_CT return OCT4 { |
| 811 | var integer i; |
| 812 | for (i := 0; i < sizeof(ClientTable); i := i+1) { |
| 813 | if (isvalue(ClientTable[i].tlli) and isvalue(ClientTable[i].comp_ref) |
| 814 | and ClientTable[i].comp_ref == comp_ref) { |
| 815 | return ClientTable[i].tlli; |
| 816 | } |
| 817 | } |
| 818 | setverdict(fail, "Couldn't find TLLI for Component ", comp_ref); |
| 819 | mtc.stop; |
| 820 | } |
| 821 | |
| 822 | /* PDU_BSSGP enhanced with LLC and possibly L3 decoded payloads */ |
| 823 | type record BssgpDecoded { |
| 824 | PDU_BSSGP bssgp, |
| 825 | PDU_LLC llc optional, |
| 826 | #ifdef BSSGP_EM_L3 |
| 827 | PDU_L3_MS_SGSN l3_mo optional, |
| 828 | PDU_L3_SGSN_MS l3_mt optional, |
| 829 | #endif |
| 830 | PDU_SN sndcp optional |
| 831 | } |
| 832 | |
| 833 | /* Decode a PDU_BSSGP into a BssgpDecoded (i.e. with LLC/L3 decoded, as applicable) */ |
| 834 | private function f_dec_bssgp(PDU_BSSGP bssgp) runs on BSSGP_BVC_CT return BssgpDecoded { |
| 835 | var BssgpDecoded dec := { |
| 836 | bssgp := bssgp, |
| 837 | llc := omit, |
| 838 | #ifdef BSSGP_EM_L3 |
| 839 | l3_mo := omit, |
| 840 | l3_mt := omit, |
| 841 | #endif |
| 842 | sndcp := omit |
| 843 | }; |
| 844 | |
| 845 | /* Decode LLC, if it is a PDU that contains LLC */ |
| 846 | if (g_cfg.depth >= BSSGP_DECODE_DEPTH_LLC) { |
| 847 | if (ischosen(bssgp.pDU_BSSGP_DL_UNITDATA)) { |
| 848 | dec.llc := dec_PDU_LLC(bssgp.pDU_BSSGP_DL_UNITDATA.lLC_PDU.lLC_PDU); |
| 849 | } else if (ischosen(bssgp.pDU_BSSGP_UL_UNITDATA)) { |
| 850 | dec.llc := dec_PDU_LLC(bssgp.pDU_BSSGP_UL_UNITDATA.lLC_PDU.lLC_PDU); |
| 851 | } |
| 852 | } |
| 853 | |
| 854 | /* Decode SNDCP, if it is a LLC PDU containing user plane data */ |
| 855 | if (g_cfg.depth >= BSSGP_DECODE_DEPTH_SNDCP) { |
| 856 | if (isvalue(dec.llc) and match(dec.llc, tr_LLC_UI_USER)) { |
| 857 | dec.sndcp := dec_PDU_SN(dec.llc.pDU_LLC_UI.information_field_UI); |
| 858 | } |
| 859 | } |
| 860 | |
| 861 | #ifdef BSSGP_EM_L3 |
| 862 | /* Decode L3, if it is a LLC PDU containing L3 */ |
| 863 | if (g_cfg.depth >= BSSGP_DECODE_DEPTH_L3) { |
| 864 | if (isvalue(dec.llc) and match(dec.llc, tr_LLC_UI_L3)) { |
| 865 | if (g_sgsn_role) { |
| 866 | dec.l3_mo := dec_PDU_L3_MS_SGSN(dec.llc.pDU_LLC_UI.information_field_UI); |
| 867 | } else { |
| 868 | dec.l3_mt := dec_PDU_L3_SGSN_MS(dec.llc.pDU_LLC_UI.information_field_UI); |
| 869 | } |
| 870 | } |
| 871 | } |
| 872 | #endif |
| 873 | |
| 874 | return dec; |
| 875 | } |
| 876 | |
| 877 | private function f_ptp_sendUnblock() runs on BSSGP_BVC_CT { |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 878 | BVC.send(ts_ptp_BnsUdReq(t_BVC_UNBLOCK(g_cfg.bvci), 0, g_bvc_lsp)); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 879 | g_t1_waits_for_block_ack := false; |
| 880 | g_T1.start; |
| 881 | } |
| 882 | |
| 883 | private function f_ptp_sendBlock(BssgpCause cause) runs on BSSGP_BVC_CT { |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 884 | BVC.send(ts_ptp_BnsUdReq(t_BVC_BLOCK(g_cfg.bvci, cause), 0, g_bvc_lsp)); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 885 | g_t1_waits_for_block_ack := true; |
| 886 | g_T1.start; |
| 887 | } |
| 888 | |
| 889 | private function f_ptp_sendStatus(BssgpCause cause, PDU_BSSGP pdu) runs on BSSGP_BVC_CT { |
| 890 | /* FIXME: Make sure correct Signaling or PTP BVCI is used! */ |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 891 | BVC.send(ts_ptp_BnsUdReq(ts_BSSGP_STATUS(g_cfg.bvci, cause, pdu), g_cfg.bvci, g_bvc_lsp)); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 892 | } |
| 893 | |
| 894 | private function f_ptp_sendReset() runs on BSSGP_BVC_CT { |
Harald Welte | c967d0e | 2020-09-14 16:07:26 +0200 | [diff] [blame] | 895 | var PDU_BSSGP pdu; |
| 896 | |
| 897 | /* The Cell Identifier IE is mandatory in the BVC-RESET PDU sent from BSS to |
| 898 | * SGSN in order to reset a BVC corresponding to a PTP functional entity. The |
| 899 | * Cell Identifier IE shall not be used in any other BVC-RESET PDU. */ |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 900 | if (g_sgsn_role) { |
| 901 | pdu := valueof(ts_BVC_RESET(BSSGP_CAUSE_OM_INTERVENTION, g_cfg.bvci, omit)); |
Harald Welte | c967d0e | 2020-09-14 16:07:26 +0200 | [diff] [blame] | 902 | } else { |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 903 | pdu := valueof(ts_BVC_RESET(BSSGP_CAUSE_OM_INTERVENTION, g_cfg.bvci, g_cfg.cell_id)); |
Harald Welte | c967d0e | 2020-09-14 16:07:26 +0200 | [diff] [blame] | 904 | } |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 905 | |
| 906 | /* BVC-RESET is always sent via the SIGNALLING BVCI, see Table 5.4.1 */ |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 907 | BVC.send(ts_ptp_BnsUdReq(pdu, 0, g_bvc_lsp)); |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 908 | g_T2.start; |
| 909 | //f_change_state(BVC_S_WAIT_RESET); |
| 910 | } |
| 911 | |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 912 | /* PTP-BVC is in BVC_S_BLOCKED state */ |
| 913 | private altstep as_ptp_blocked() runs on BSSGP_BVC_CT { |
| 914 | var NsUnitdataIndication udi; |
| 915 | |
| 916 | [g_T1.running and not g_t1_waits_for_block_ack] BVC.receive(tr_ptp_BnsUdInd(t_BVC_UNBLOCK_ACK(g_cfg.bvci), 0)) { |
| 917 | g_T1.stop; |
| 918 | f_ptp_change_state(BVC_S_UNBLOCKED); |
| 919 | } |
| 920 | |
| 921 | /* RESET-ACK before T2 timeout: reset successful. In SGSN role, CellID must be present */ |
| 922 | [g_T2.running and g_sgsn_role] BVC.receive(tr_ptp_BnsUdInd(tr_BVC_RESET_ACK(g_cfg.bvci, g_cfg.cell_id), 0)) -> value udi { |
| 923 | g_T2.stop; |
| 924 | f_ptp_change_state(BVC_S_UNBLOCKED); |
| 925 | } |
| 926 | /* RESET-ACK before T2 timeout: reset successful. In BSS role, CellID must be absent */ |
| 927 | [g_T2.running and not g_sgsn_role] BVC.receive(tr_ptp_BnsUdInd(tr_BVC_RESET_ACK(g_cfg.bvci, omit), 0)) -> value udi { |
| 928 | g_T2.stop; |
| 929 | f_ptp_change_state(BVC_S_UNBLOCKED); |
| 930 | } |
| 931 | |
| 932 | [] g_T2.timeout { |
| 933 | /* BVC-RESET-ACK PDU was not received within T2: retransmit */ |
| 934 | f_ptp_sendReset(); |
| 935 | } |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 936 | } |
| 937 | |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 938 | /* PTP-BVC is in UNBLOCKED state */ |
| 939 | private altstep as_ptp_unblocked() runs on BSSGP_BVC_CT { |
| 940 | var NsUnitdataIndication udi; |
| 941 | var NsStatusIndication nsi; |
| 942 | var BSSGP_Client_CT vc_conn; |
| 943 | var ASP_Event evt; |
| 944 | var PDU_BSSGP bs_pdu; |
| 945 | var PDU_LLC llc; |
| 946 | #ifdef BSSGP_EM_L3 |
| 947 | var PDU_L3_MS_SGSN l3_mo; |
| 948 | var PDU_L3_SGSN_MS l3_mt; |
| 949 | #endif |
| 950 | |
| 951 | /* bogus unblock, just respond with ACK */ |
| 952 | [] BVC.receive(tr_ptp_BnsUdInd(t_BVC_UNBLOCK(g_cfg.bvci), 0)) -> value udi { |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 953 | BVC.send(ts_ptp_BnsUdReq(t_BVC_UNBLOCK_ACK(g_cfg.bvci), 0, g_bvc_lsp)); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 954 | } |
| 955 | /* Respond to BLOCK with BLOCK-ACK + change state */ |
| 956 | [] BVC.receive(tr_ptp_BnsUdInd(t_BVC_BLOCK(g_cfg.bvci, ?), 0)) -> value udi { |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 957 | BVC.send(ts_ptp_BnsUdReq(t_BVC_BLOCK_ACK(g_cfg.bvci), 0, g_bvc_lsp)); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 958 | g_T1.stop; |
| 959 | f_ptp_change_state(BVC_S_BLOCKED); |
| 960 | } |
| 961 | /* BLOCK-ACK before T1 timeout: mark as blocked */ |
| 962 | [g_T1.running and g_t1_waits_for_block_ack] BVC.receive(tr_ptp_BnsUdInd(t_BVC_BLOCK_ACK(g_cfg.bvci), 0)) -> value udi { |
| 963 | g_T1.stop; |
| 964 | f_ptp_change_state(BVC_S_BLOCKED); |
| 965 | } |
| 966 | /* Re-transmit BLOCK / UNBLOCK on T1 timeout */ |
| 967 | [not g_t1_waits_for_block_ack] g_T1.timeout { |
| 968 | f_ptp_sendUnblock(); |
| 969 | } |
| 970 | [g_t1_waits_for_block_ack] g_T1.timeout { |
| 971 | f_ptp_sendBlock(BSSGP_CAUSE_OM_INTERVENTION); |
| 972 | } |
| 973 | |
| 974 | /* simply acknowledge all per-BVC Flow Control Messages */ |
| 975 | [g_sgsn_role] BVC.receive(tr_ptp_BnsUdInd(tr_BVC_FC_BVC, g_cfg.bvci)) -> value udi { |
| 976 | var OCT1 tag := udi.bssgp.pDU_BSSGP_FLOW_CONTROL_BVC.tag.unstructured_Value; |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 977 | BVC.send(ts_ptp_BnsUdReq(t_BVC_FC_BVC_ACK(tag), g_cfg.bvci, g_bvc_lsp)); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 978 | } |
| 979 | /* |
| 980 | [g_sgsn_role] BVC.receive(tr_ptp_BnsUdInd(t_BVC_FC_MS, g_cfg.bvci)) { |
| 981 | BVC.send(ts_ptp_BnsUdReq(t_BVC_FC_MS_ACK, g_cfg.bvci)); |
| 982 | } |
| 983 | */ |
| 984 | /* Any other PTP BSSGP message: If it has TLLI, route to component; otherwise broadcast */ |
| 985 | [] BVC.receive(tr_ptp_BnsUdInd(?, g_cfg.bvci)) -> value udi { |
| 986 | var BssgpDecoded dec := f_dec_bssgp(udi.bssgp); |
| 987 | var template OCT4 tlli := f_bssgp_get_tlli(udi.bssgp); |
| 988 | if (isvalue(tlli)) { |
| 989 | vc_conn := f_tbl_comp_by_tlli(valueof(tlli)); |
| 990 | f_send_bssgp_dec(dec, vc_conn, BSSGP_SP); |
| 991 | } else { |
| 992 | log("No TLLI: Broadcasting ", dec); |
| 993 | /* broadcast this message to all components */ |
| 994 | // TITAN DOESN'T DO THIS, *SIGH*: "BSSGP_SP.send(dec) to all component;" |
| 995 | for (var integer i := 0; i < sizeof(ClientTable); i := i+1) { |
| 996 | if (isbound(ClientTable[i].comp_ref) and ClientTable[i].comp_ref != null) { |
| 997 | f_send_bssgp_dec(dec, ClientTable[i].comp_ref, BSSGP_SP); |
| 998 | } |
| 999 | } |
| 1000 | } |
| 1001 | } |
| 1002 | |
| 1003 | /* Any other SIG BSSGP message: If it has TLLI, route to component; otherwise broadcast */ |
| 1004 | [] BVC.receive(tr_ptp_BnsUdInd(?, 0)) -> value udi { |
| 1005 | var BssgpDecoded dec := f_dec_bssgp(udi.bssgp); |
| 1006 | var template OCT4 tlli := f_bssgp_get_tlli(udi.bssgp); |
| 1007 | if (isvalue(tlli)) { |
| 1008 | vc_conn := f_tbl_comp_by_tlli(valueof(tlli)); |
| 1009 | f_send_bssgp_dec(dec, vc_conn, BSSGP_SP_SIG); |
| 1010 | } else { |
| 1011 | log("No TLLI: Broadcasting ", dec); |
| 1012 | /* broadcast this message to all components */ |
| 1013 | // TITAN DOESN'T DO THIS, *SIGH*: "BSSGP_SP.send(dec) to all component;" |
| 1014 | for (var integer i := 0; i < sizeof(ClientTable); i := i+1) { |
| 1015 | if (isbound(ClientTable[i].comp_ref) and ClientTable[i].comp_ref != null) { |
| 1016 | f_send_bssgp_dec(dec, ClientTable[i].comp_ref, BSSGP_SP_SIG); |
| 1017 | } |
| 1018 | } |
| 1019 | } |
| 1020 | } |
| 1021 | |
| 1022 | /* ConnHdlr sends BSSGP on BVCI=0 port: forward it to BSSGP_CT */ |
| 1023 | [] BSSGP_SP_SIG.receive(PDU_BSSGP:?)-> value bs_pdu sender vc_conn { |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 1024 | BVC.send(ts_ptp_BnsUdReq(bs_pdu, 0, g_bvc_lsp)); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 1025 | } |
| 1026 | |
| 1027 | /* ConnHdlr sends BSSGP on BVCI=PTP port: forward it to BSSGP_CT */ |
| 1028 | [] BSSGP_SP.receive(PDU_BSSGP:?)-> value bs_pdu sender vc_conn { |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 1029 | BVC.send(ts_ptp_BnsUdReq(bs_pdu, g_cfg.bvci, g_bvc_lsp)); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 1030 | } |
| 1031 | |
| 1032 | #ifdef BSSGP_EM_L3 |
| 1033 | /* ConnHdlr sends L3: Encode and send as UL_UD / DL_UD */ |
| 1034 | [g_sgsn_role] BSSGP_SP.receive(PDU_L3_SGSN_MS:?) -> value l3_mt sender vc_conn { |
| 1035 | var integer idx := f_tbl_idx_by_comp(vc_conn); |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 1036 | var OCT4 tlli := ClientTable[idx].tlli; |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 1037 | var octetstring l3_enc := enc_PDU_L3_SGSN_MS(l3_mt); |
| 1038 | var BIT4 sapi := f_llc_sapi_by_l3_mt(l3_mt); |
| 1039 | var integer n_u := f_llc_get_n_u_tx(ClientTable[idx].llc[bit2int(sapi)]); |
| 1040 | var octetstring llc_enc := enc_PDU_LLC(valueof(ts_LLC_UI(l3_enc, sapi, '1'B, n_u))); |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 1041 | BVC.send(ts_ptp_BnsUdReq(ts_BSSGP_DL_UD(tlli, llc_enc), g_cfg.bvci, oct2int(tlli))); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 1042 | } |
| 1043 | [not g_sgsn_role] BSSGP_SP.receive(PDU_L3_MS_SGSN:?) -> value l3_mo sender vc_conn { |
| 1044 | var integer idx := f_tbl_idx_by_comp(vc_conn); |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 1045 | var OCT4 tlli := ClientTable[idx].tlli; |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 1046 | var octetstring l3_enc := enc_PDU_L3_MS_SGSN(l3_mo); |
| 1047 | var BIT4 sapi := f_llc_sapi_by_l3_mo(l3_mo); |
| 1048 | var integer n_u := f_llc_get_n_u_tx(ClientTable[idx].llc[bit2int(sapi)]); |
| 1049 | var octetstring llc_enc := enc_PDU_LLC(valueof(ts_LLC_UI(l3_enc, sapi, '1'B, n_u))); |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 1050 | BVC.send(ts_ptp_BnsUdReq(ts_BSSGP_UL_UD(tlli, g_cfg.cell_id, llc_enc), g_cfg.bvci, oct2int(tlli))); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 1051 | } |
| 1052 | #endif |
| 1053 | |
| 1054 | /* ConnHdlr sends raw LLC: Encode and send as UL_UD / DL_UD */ |
| 1055 | [not g_sgsn_role] BSSGP_SP.receive(PDU_LLC:?) -> value llc sender vc_conn { |
| 1056 | var integer idx := f_tbl_idx_by_comp(vc_conn); |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 1057 | var OCT4 tlli := ClientTable[idx].tlli; |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 1058 | var octetstring llc_enc := enc_PDU_LLC(llc); |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 1059 | BVC.send(ts_ptp_BnsUdReq(ts_BSSGP_UL_UD(tlli, g_cfg.cell_id, llc_enc), g_cfg.bvci, oct2int(tlli))); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 1060 | } |
| 1061 | [g_sgsn_role] BSSGP_SP.receive(PDU_LLC:?) -> value llc sender vc_conn { |
| 1062 | var integer idx := f_tbl_idx_by_comp(vc_conn); |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 1063 | var OCT4 tlli := ClientTable[idx].tlli; |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 1064 | var octetstring llc_enc := enc_PDU_LLC(llc); |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 1065 | BVC.send(ts_ptp_BnsUdReq(ts_BSSGP_DL_UD(tlli, llc_enc), g_cfg.bvci, oct2int(tlli))); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 1066 | } |
Harald Welte | 853c0ad | 2018-02-15 17:45:29 +0100 | [diff] [blame] | 1067 | } |
| 1068 | |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 1069 | /* Events permitted in all states */ |
| 1070 | private altstep as_ptp_allstate() runs on BSSGP_BVC_CT { |
| 1071 | var NsUnitdataIndication udi; |
| 1072 | var BSSGP_Client_CT vc_conn; |
| 1073 | var OCT4 tlli, tlli_old; |
| 1074 | var hexstring imsi; |
| 1075 | |
| 1076 | /* Signaling BVC was reset */ |
| 1077 | [] BVC.receive(BssgpResetIndication:{0}) { |
| 1078 | if (not g_sgsn_role) { |
| 1079 | f_ptp_change_state(BVC_S_BLOCKED); |
| 1080 | /* when the BSS side signaling PTP is RESET, all PTP BVC must start the |
| 1081 | * reset procedure */ |
| 1082 | f_ptp_sendReset(); |
| 1083 | } else { |
| 1084 | f_ptp_change_state(BVC_S_UNBLOCKED); |
| 1085 | } |
| 1086 | } |
| 1087 | |
| 1088 | /* we are a SGSN: BSS/PCU-originated RESET must have a cell ID */ |
| 1089 | [g_sgsn_role] BVC.receive(tr_ptp_BnsUdInd(tr_BVC_RESET(?, g_cfg.bvci, g_cfg.cell_id), 0)) -> value udi { |
| 1090 | log("Rx BVC-RESET from BVCI=", g_cfg.bvci); |
| 1091 | /* Respond to RESET with correct BVCI but without CellID */ |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 1092 | BVC.send(ts_ptp_BnsUdReq(ts_BVC_RESET_ACK(g_cfg.bvci, omit), 0, g_bvc_lsp)); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 1093 | /* FIXME: reset all state? What about clients? */ |
| 1094 | f_ptp_change_state(BVC_S_UNBLOCKED); |
| 1095 | } |
| 1096 | /* we are a BSS/PCU: SGSN-originated RESET must not have a cell ID */ |
| 1097 | [not g_sgsn_role] BVC.receive(tr_ptp_BnsUdInd(tr_BVC_RESET(?, g_cfg.bvci, omit), 0)) -> value udi { |
| 1098 | log("Rx BVC-RESET from BVCI=", g_cfg.bvci); |
| 1099 | /* Respond to RESET with correct BVCI with CellID */ |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 1100 | BVC.send(ts_ptp_BnsUdReq(ts_BVC_RESET_ACK(g_cfg.bvci, g_cfg.cell_id), 0, g_bvc_lsp)); |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 1101 | /* FIXME: reset all state? What about clients? */ |
| 1102 | f_ptp_change_state(BVC_S_UNBLOCKED); |
| 1103 | } |
| 1104 | |
| 1105 | /* Ignore those for now */ |
| 1106 | [] BVC.receive(ASP_Event:?) { } |
| 1107 | [] BVC.receive(BssgpStatusIndication:?) { } |
| 1108 | |
| 1109 | /* catch-all */ |
| 1110 | [] BVC.receive(tr_ptp_BnsUdInd(?, 0)) -> value udi { |
| 1111 | setverdict(fail, "Received unexpected NS (SIG): ", udi); |
| 1112 | } |
| 1113 | [] BVC.receive(tr_ptp_BnsUdInd(?, ?)) -> value udi { |
| 1114 | setverdict(fail, "Received unexpected NS (PTP): ", udi); |
| 1115 | } |
| 1116 | [] BVC.receive { |
| 1117 | setverdict(fail, "Received unexpected message from BSSGP_CT"); |
| 1118 | } |
| 1119 | |
| 1120 | /* registration/deregistration of Clients (per-TLLI components) */ |
| 1121 | [] BSSGP_PROC.getcall(BSSGP_register_client:{?,?}) -> param(imsi, tlli) sender vc_conn { |
| 1122 | f_tbl_client_add(imsi, tlli, vc_conn); |
| 1123 | BSSGP_PROC.reply(BSSGP_register_client:{imsi, tlli}) to vc_conn; |
| 1124 | } |
| 1125 | [] BSSGP_PROC.getcall(BSSGP_unregister_client:{?}) -> param(imsi) sender vc_conn { |
| 1126 | f_tbl_client_del(imsi, vc_conn); |
| 1127 | BSSGP_PROC.reply(BSSGP_unregister_client:{imsi}) to vc_conn; |
| 1128 | } |
| 1129 | [] BSSGP_PROC.getcall(BSSGP_llgmm_assign:{?,?}) -> param(tlli_old, tlli) sender vc_conn { |
| 1130 | f_tbl_client_llgmm_assign(tlli_old, tlli, vc_conn); |
| 1131 | BSSGP_PROC.reply(BSSGP_llgmm_assign:{tlli_old, tlli}) to vc_conn; |
| 1132 | } |
| 1133 | } |
| 1134 | |
| 1135 | /* main loop for per-BVC component */ |
| 1136 | private function f_bssgp_bvc_ScanEvents() runs on BSSGP_BVC_CT { |
| 1137 | while (true) { |
| 1138 | alt { |
| 1139 | [g_ptp_bvc_state == BVC_S_BLOCKED] as_ptp_blocked(); |
| 1140 | [g_ptp_bvc_state == BVC_S_UNBLOCKED] as_ptp_unblocked(); |
| 1141 | [] as_ptp_allstate(); |
| 1142 | } |
| 1143 | } |
| 1144 | } |
| 1145 | |
| 1146 | /* main function for per-BVC Component */ |
| 1147 | private function f_bssgp_bvc_main(BssgpBvcConfig cfg, boolean sgsn_role, charstring id) runs on BSSGP_BVC_CT { |
| 1148 | g_cfg := cfg; |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 1149 | g_bvc_lsp := cfg.bvci; |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 1150 | g_sgsn_role := sgsn_role; |
| 1151 | f_bssgp_bvc_ScanEvents(); |
| 1152 | } |
| 1153 | |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 1154 | template (value) NsUnitdataRequest ts_ptp_BnsUdReq(template (value) PDU_BSSGP pdu, template (value) BssgpBvci bvci, |
| 1155 | template (value) integer lsp) := { |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 1156 | bvci := bvci, |
| 1157 | nsei := 0, // overwritten in BSSGP_CT |
Harald Welte | c450552 | 2020-11-11 18:55:09 +0100 | [diff] [blame^] | 1158 | lsp := lsp, |
Harald Welte | 5339b2e | 2020-10-04 22:52:56 +0200 | [diff] [blame] | 1159 | /* for some weird reason we get "Dynamic test case error: Text encoder: Encoding an |
| 1160 | * unbound integer value." when trying to send the reocrd rather than the octetstring */ |
| 1161 | //sdu := omit, |
| 1162 | //bssgp := valueof(pdu) |
| 1163 | sdu := enc_PDU_BSSGP(valueof(pdu)), |
| 1164 | bssgp := omit |
| 1165 | } |
| 1166 | |
| 1167 | template (present) NsUnitdataIndication tr_ptp_BnsUdInd(template (present) PDU_BSSGP pdu, template (present) BssgpBvci bvci) := { |
| 1168 | bvci := bvci, |
| 1169 | nsei := ?, |
| 1170 | sdu := *, |
| 1171 | bssgp := pdu |
| 1172 | } |
| 1173 | |
| 1174 | /* change state of PTP BVC; broadcast state change to clients */ |
| 1175 | private function f_ptp_change_state(BvcState new_state) runs on BSSGP_BVC_CT { |
| 1176 | if (new_state == g_ptp_bvc_state) { |
| 1177 | return; |
| 1178 | } |
| 1179 | log("BVCI(", g_cfg.bvci, ") State Transition: ", g_ptp_bvc_state, " -> ", new_state); |
| 1180 | g_ptp_bvc_state := new_state; |
| 1181 | for (var integer i := 0; i < sizeof(ClientTable); i := i+1) { |
| 1182 | if (isbound(ClientTable[i].comp_ref) and ClientTable[i].comp_ref != null) { |
| 1183 | BSSGP_SP.send(ts_BssgpStsInd(omit, g_cfg.bvci, g_ptp_bvc_state)) to ClientTable[i].comp_ref; |
| 1184 | } |
| 1185 | } |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 1186 | } |
| 1187 | |
| 1188 | /* attempt to extract the TLLI from a BSSGP PDU */ |
| 1189 | function f_bssgp_get_tlli(PDU_BSSGP bssgp) return template OCT4 { |
| 1190 | if (ischosen(bssgp.pDU_BSSGP_DL_UNITDATA)) { |
| 1191 | return bssgp.pDU_BSSGP_DL_UNITDATA.tLLI_current; |
| 1192 | } else if (ischosen(bssgp.pDU_BSSGP_UL_UNITDATA)) { |
| 1193 | return bssgp.pDU_BSSGP_UL_UNITDATA.tLLI; |
| 1194 | } else if (ischosen(bssgp.pDU_BSSGP_RA_CAPABILITY)) { |
| 1195 | return bssgp.pDU_BSSGP_RA_CAPABILITY.tLLI.tLLI_Value; |
| 1196 | } else if (ischosen(bssgp.pDU_BSSGP_RA_CAPABILITY_UPDATE)) { |
| 1197 | return bssgp.pDU_BSSGP_RA_CAPABILITY_UPDATE.tLLI.tLLI_Value; |
| 1198 | } else if (ischosen(bssgp.pDU_BSSGP_RA_CAPABILITY_UPDATE_ACK)) { |
| 1199 | return bssgp.pDU_BSSGP_RA_CAPABILITY_UPDATE_ACK.tLLI.tLLI_Value; |
| 1200 | } else if (ischosen(bssgp.pDU_BSSGP_RADIO_STATUS)) { |
| 1201 | return bssgp.pDU_BSSGP_RADIO_STATUS.tLLI.tLLI_Value; |
| 1202 | } else if (ischosen(bssgp.pDU_BSSGP_SUSPEND)) { |
| 1203 | return bssgp.pDU_BSSGP_SUSPEND.tLLI.tLLI_Value; |
| 1204 | } else if (ischosen(bssgp.pDU_BSSGP_SUSPEND_ACK)) { |
| 1205 | return bssgp.pDU_BSSGP_SUSPEND_ACK.tLLI.tLLI_Value; |
| 1206 | } else if (ischosen(bssgp.pDU_BSSGP_SUSPEND_NACK)) { |
| 1207 | return bssgp.pDU_BSSGP_SUSPEND_NACK.tLLI.tLLI_Value; |
| 1208 | } else if (ischosen(bssgp.pDU_BSSGP_RESUME)) { |
| 1209 | return bssgp.pDU_BSSGP_RESUME.tLLI.tLLI_Value; |
| 1210 | } else if (ischosen(bssgp.pDU_BSSGP_RESUME_ACK)) { |
| 1211 | return bssgp.pDU_BSSGP_RESUME_ACK.tLLI.tLLI_Value; |
| 1212 | } else if (ischosen(bssgp.pDU_BSSGP_RESUME_NACK)) { |
| 1213 | return bssgp.pDU_BSSGP_RESUME_NACK.tLLI.tLLI_Value; |
| 1214 | } else if (ischosen(bssgp.pDU_BSSGP_FLUSH_LL)) { |
| 1215 | return bssgp.pDU_BSSGP_FLUSH_LL.tLLI.tLLI_Value; |
| 1216 | } else if (ischosen(bssgp.pDU_BSSGP_FLUSH_LL_ACK)) { |
| 1217 | return bssgp.pDU_BSSGP_FLUSH_LL_ACK.tLLI.tLLI_Value; |
| 1218 | } else if (ischosen(bssgp.pDU_BSSGP_LLC_DISCARDED)) { |
| 1219 | return bssgp.pDU_BSSGP_LLC_DISCARDED.tLLI.tLLI_Value; |
| 1220 | } else if (ischosen(bssgp.pDU_BSSGP_LLC_DISCARDED)) { |
| 1221 | return bssgp.pDU_BSSGP_LLC_DISCARDED.tLLI.tLLI_Value; |
| 1222 | } else if (ischosen(bssgp.pDU_BSSGP_PAGING_CS) and |
| 1223 | isvalue(bssgp.pDU_BSSGP_PAGING_CS.tLLI)) { |
| 1224 | return bssgp.pDU_BSSGP_PAGING_CS.tLLI.tLLI_Value; |
| 1225 | } else if (ischosen(bssgp.pDU_BSSGP_FLOW_CONTROL_MS)) { |
| 1226 | return bssgp.pDU_BSSGP_FLOW_CONTROL_MS.tLLI.tLLI_Value; |
| 1227 | } else if (ischosen(bssgp.pDU_BSSGP_FLOW_CONTROL_MS_ACK)) { |
| 1228 | return bssgp.pDU_BSSGP_FLOW_CONTROL_MS_ACK.tLLI.tLLI_Value; |
| 1229 | } |
| 1230 | /* TODO: Handover, PFC, LCS */ |
| 1231 | return omit; |
| 1232 | } |
| 1233 | |
Harald Welte | f70997d | 2018-02-17 10:11:19 +0100 | [diff] [blame] | 1234 | |
Harald Welte | 5ac3149 | 2018-02-15 20:39:13 +0100 | [diff] [blame] | 1235 | |
Harald Welte | 1733a38 | 2017-07-23 17:26:17 +0200 | [diff] [blame] | 1236 | } |