Harald Welte | 34b5a95 | 2019-05-27 11:54:11 +0200 | [diff] [blame] | 1 | /* GPRS-NS Emulation in TTCN-3 |
Harald Welte | 013d65a | 2020-09-13 14:41:31 +0200 | [diff] [blame] | 2 | * (C) 2018-2020 Harald Welte <laforge@gnumonks.org> |
Harald Welte | 34b5a95 | 2019-05-27 11:54:11 +0200 | [diff] [blame] | 3 | * contributions by sysmocom - s.f.m.c. GmbH |
| 4 | * All rights reserved. |
| 5 | * |
| 6 | * Released under the terms of GNU General Public License, Version 2 or |
| 7 | * (at your option) any later version. |
| 8 | * |
| 9 | * SPDX-License-Identifier: GPL-2.0-or-later |
| 10 | */ |
| 11 | |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 12 | module NS_Emulation { |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 13 | import from Misc_Helpers all; |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 14 | import from NS_Types all; |
| 15 | import from BSSGP_Types all; |
Harald Welte | 867243a | 2020-09-13 18:32:32 +0200 | [diff] [blame] | 16 | import from Osmocom_Types all; |
Harald Welte | e0abc47 | 2018-02-05 09:13:31 +0100 | [diff] [blame] | 17 | import from Osmocom_Gb_Types all; |
Harald Welte | 013d65a | 2020-09-13 14:41:31 +0200 | [diff] [blame] | 18 | import from NS_Provider_IPL4 all; |
Harald Welte | 867243a | 2020-09-13 18:32:32 +0200 | [diff] [blame] | 19 | #ifdef NS_EMULATION_FR |
| 20 | import from NS_Provider_FR all; |
| 21 | #endif |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 22 | import from IPL4asp_Types all; |
| 23 | |
| 24 | type record NsUnitdataRequest { |
| 25 | BssgpBvci bvci, |
| 26 | Nsei nsei, |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 27 | octetstring sdu optional, |
Harald Welte | e0abc47 | 2018-02-05 09:13:31 +0100 | [diff] [blame] | 28 | PDU_BSSGP bssgp optional |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 29 | } |
| 30 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 31 | template NsUnitdataRequest tr_NsUdReq(template Nsei nsei, template BssgpBvci bvci, template octetstring sdu, |
| 32 | template PDU_BSSGP bssgp) := { |
| 33 | bvci := bvci, |
| 34 | nsei := nsei, |
| 35 | sdu := sdu, |
| 36 | bssgp := bssgp |
| 37 | } |
| 38 | |
| 39 | template (value) NsUnitdataRequest ts_NsUdReq(template (value) Nsei nsei, |
| 40 | template (value) BssgpBvci bvci, |
| 41 | template (omit) octetstring sdu, |
| 42 | template (omit) PDU_BSSGP bssgp) := { |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 43 | bvci := bvci, |
| 44 | nsei := nsei, |
| 45 | sdu := sdu, |
| 46 | bssgp := bssgp |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 47 | } |
| 48 | |
| 49 | type record NsUnitdataIndication { |
| 50 | BssgpBvci bvci, |
| 51 | Nsei nsei, |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 52 | octetstring sdu optional, |
Harald Welte | e0abc47 | 2018-02-05 09:13:31 +0100 | [diff] [blame] | 53 | PDU_BSSGP bssgp optional |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 54 | } |
| 55 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 56 | template (present) NsUnitdataIndication tr_NsUdInd(template (present) Nsei nsei, |
| 57 | template (present) BssgpBvci bvci, |
| 58 | template octetstring sdu) := { |
| 59 | bvci := bvci, |
| 60 | nsei := nsei, |
| 61 | sdu := sdu, |
| 62 | bssgp := ? |
| 63 | } |
| 64 | |
| 65 | template (value) NsUnitdataIndication ts_NsUdInd(Nsei nsei, BssgpBvci bvci, octetstring sdu) := { |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 66 | bvci := bvci, |
| 67 | nsei := nsei, |
| 68 | sdu := sdu, |
Harald Welte | e0abc47 | 2018-02-05 09:13:31 +0100 | [diff] [blame] | 69 | bssgp := dec_PDU_BSSGP(sdu) |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 70 | } |
| 71 | |
| 72 | type record NsStatusIndication { |
| 73 | Nsei nsei, |
| 74 | Nsvci nsvci, |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 75 | NsvcState old_state, |
| 76 | NsvcState new_state |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 77 | } |
| 78 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 79 | template (present) NsStatusIndication tr_NsStsInd(template (present) Nsei nsei := ?, |
| 80 | template (present) Nsvci nsvci := ?, |
| 81 | template (present) NsvcState old_state := ?, |
| 82 | template (present) NsvcState state := ?) := { |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 83 | nsei := nsei, |
| 84 | nsvci := nsvci, |
| 85 | old_state := old_state, |
| 86 | new_state := state |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 87 | } |
| 88 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 89 | |
| 90 | template (value) NsStatusIndication ts_NsStsInd(Nsei nsei, Nsvci nsvci, NsvcState old_state, NsvcState state) := { |
| 91 | nsei := nsei, |
| 92 | nsvci := nsvci, |
| 93 | old_state := old_state, |
| 94 | new_state := state |
| 95 | } |
| 96 | |
| 97 | type enumerated NsvcState { |
| 98 | NSVC_S_DEAD_BLOCKED, |
| 99 | NSVC_S_WAIT_RESET, |
| 100 | NSVC_S_ALIVE_BLOCKED, |
| 101 | NSVC_S_ALIVE_UNBLOCKED |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 102 | } |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 103 | |
| 104 | /* port from our (internal) point of view */ |
| 105 | type port NS_SP_PT message { |
| 106 | in NsUnitdataRequest; |
| 107 | out NsUnitdataIndication, |
Harald Welte | 013d65a | 2020-09-13 14:41:31 +0200 | [diff] [blame] | 108 | NsStatusIndication; |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 109 | } with { extension "internal" }; |
| 110 | |
| 111 | /* port from the user point of view */ |
| 112 | type port NS_PT message { |
| 113 | in ASP_Event, |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 114 | NsStatusIndication, |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 115 | NsUnitdataIndication; |
| 116 | out NsUnitdataRequest; |
| 117 | } with { extension "internal" }; |
| 118 | |
Harald Welte | 013d65a | 2020-09-13 14:41:31 +0200 | [diff] [blame] | 119 | type component NS_Provider_CT { |
| 120 | /* upper port, facing to NS_Emulation:NSCP */ |
| 121 | port NS_PROVIDER_PT NSE; |
| 122 | /* lower layer ports (UDP/IP, Frame Relay) are added in derived components */ |
| 123 | }; |
| 124 | |
Harald Welte | bd612cd | 2020-09-14 09:42:28 +0200 | [diff] [blame] | 125 | type enumerated NS_Provider_LinkStatus { |
| 126 | NS_PROV_LINK_STATUS_UP, |
| 127 | NS_PROV_LINK_STATUS_DOWN |
| 128 | }; |
| 129 | type union NS_Provider_Evt { |
| 130 | NS_Provider_LinkStatus link_status |
| 131 | }; |
| 132 | |
Harald Welte | 013d65a | 2020-09-13 14:41:31 +0200 | [diff] [blame] | 133 | /* port between NS_Provider and NS_CT */ |
| 134 | type port NS_PROVIDER_PT message { |
Harald Welte | bd612cd | 2020-09-14 09:42:28 +0200 | [diff] [blame] | 135 | inout PDU_NS, NS_Provider_Evt; |
Harald Welte | 013d65a | 2020-09-13 14:41:31 +0200 | [diff] [blame] | 136 | } with { extension "internal" }; |
| 137 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 138 | type record NSVCConfigurationIP { |
| 139 | AddressFamily address_family, |
| 140 | PortNumber local_udp_port, |
| 141 | charstring local_ip, |
| 142 | PortNumber remote_udp_port, |
| 143 | charstring remote_ip |
| 144 | }; |
| 145 | type record NSVCConfigurationFR { |
| 146 | charstring netdev, /* HDLC net-device for AF_PACKET socket */ |
| 147 | integer dlci |
| 148 | }; |
| 149 | type union NSVCConfigurationP { |
| 150 | NSVCConfigurationIP ip, |
| 151 | NSVCConfigurationFR fr |
| 152 | }; |
| 153 | type record NSVCConfiguration { |
| 154 | NSVCConfigurationP provider, |
| 155 | Nsvci nsvci |
| 156 | }; |
| 157 | type record of NSVCConfiguration NSVCConfigurations; |
| 158 | type record NSConfiguration { |
| 159 | Nsvci nsei, |
| 160 | boolean role_sgsn, |
| 161 | boolean handle_sns, |
| 162 | NSVCConfigurations nsvc |
| 163 | } |
| 164 | |
| 165 | /*********************************************************************** |
| 166 | * per NS-VCG component. Exists once per [peer of] NSE |
| 167 | ***********************************************************************/ |
| 168 | |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 169 | type component NS_CT { |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 170 | /* NS-User SAP towards the user */ |
| 171 | port NS_SP_PT NS_SP; |
| 172 | |
| 173 | /* port towards the per-NSVC components */ |
| 174 | port NS_PT NSVC; |
| 175 | |
| 176 | /* all of the NS configuration a user passes to us */ |
| 177 | var NSConfiguration g_config; |
| 178 | var charstring g_id; |
| 179 | |
| 180 | /* references to the per-NSVC components */ |
| 181 | var NsvcTable g_nsvcs := {}; |
| 182 | |
| 183 | }; |
| 184 | type record NsvcTableEntry { |
| 185 | Nsvci nsvci, |
| 186 | NSVC_CT vc_conn, |
| 187 | NsvcState state |
| 188 | }; |
| 189 | type record of NsvcTableEntry NsvcTable; |
| 190 | |
| 191 | /* add one NSVC (component and table entry */ |
| 192 | function f_nsvc_add(NSVCConfiguration nsvc_cfg) runs on NS_CT { |
| 193 | var charstring nsvc_id := g_id & "-NSVCI" & int2str(nsvc_cfg.nsvci); |
| 194 | var NsvcTableEntry te; |
| 195 | |
| 196 | te.nsvci := nsvc_cfg.nsvci; |
| 197 | te.vc_conn := NSVC_CT.create(nsvc_id); |
| 198 | te.state := NSVC_S_DEAD_BLOCKED; |
| 199 | |
| 200 | connect(self:NSVC, te.vc_conn:NS_SP); |
| 201 | te.vc_conn.start(NSVCStart(nsvc_cfg, g_config, nsvc_id)); |
| 202 | |
| 203 | g_nsvcs := g_nsvcs & { te }; |
| 204 | } |
| 205 | |
| 206 | function f_nsvc_find_idx(Nsvci nsvci) runs on NS_CT return integer { |
| 207 | var integer i; |
| 208 | for (i := 0; i < lengthof(g_nsvcs); i := i+1) { |
| 209 | if (g_nsvcs[i].nsvci == nsvci) { |
| 210 | return i; |
| 211 | } |
| 212 | } |
| 213 | return -1; |
| 214 | } |
| 215 | |
| 216 | function f_nsvc_find(Nsvci nsvci) runs on NS_CT return NSVC_CT { |
| 217 | var integer i := f_nsvc_find_idx(nsvci); |
| 218 | if (i < 0) { |
| 219 | return null; |
| 220 | } else { |
| 221 | return g_nsvcs[i].vc_conn; |
| 222 | } |
| 223 | } |
| 224 | |
| 225 | function f_nsvc_update_state(Nsvci nsvci, NsvcState state) runs on NS_CT { |
| 226 | var integer i := f_nsvc_find_idx(nsvci); |
| 227 | if (i < 0) { |
| 228 | return; |
| 229 | } |
| 230 | g_nsvcs[i].state := state; |
| 231 | } |
| 232 | |
| 233 | function NSStart(NSConfiguration init_config, charstring id := testcasename()) runs on NS_CT { |
| 234 | g_config := init_config; |
| 235 | g_id := id; |
| 236 | |
| 237 | /* iterate over list of NS-VCs and start per-NSVC components */ |
| 238 | for (var integer i := 0; i < lengthof(g_config.nsvc); i := i+1) { |
| 239 | var NSVCConfiguration nsvc_cfg := g_config.nsvc[i]; |
| 240 | f_nsvc_add(nsvc_cfg); |
| 241 | } |
| 242 | |
| 243 | while (true) { |
| 244 | alt { |
| 245 | [] as_ns_common() {} |
| 246 | } |
| 247 | } |
| 248 | } |
| 249 | |
| 250 | private altstep as_ns_common() runs on NS_CT { |
| 251 | var NsStatusIndication rx_nssi; |
| 252 | var NsUnitdataIndication rx_nsudi; |
| 253 | var NsUnitdataRequest rx_nsudr; |
| 254 | /* pass from NS-VCs up to user */ |
| 255 | [] NSVC.receive(tr_NsStsInd(g_config.nsei)) -> value rx_nssi { |
| 256 | f_nsvc_update_state(rx_nssi.nsvci, rx_nssi.new_state); |
| 257 | NS_SP.send(rx_nssi); |
| 258 | } |
| 259 | [] NSVC.receive(tr_NsStsInd) -> value rx_nssi { |
| 260 | Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, |
| 261 | log2str("Received NsStatusInd for invalid NSEI: ", rx_nssi)); |
| 262 | } |
| 263 | [] NSVC.receive(tr_NsUdInd(g_config.nsei, ?, ?)) -> value rx_nsudi { |
| 264 | NS_SP.send(rx_nsudi); |
| 265 | } |
| 266 | [] NSVC.receive(tr_NsUdInd(?, ?, ?)) -> value rx_nsudi { |
| 267 | Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, |
| 268 | log2str("Received UnitDataInd for invalid NSEI: ", rx_nsudi)); |
| 269 | } |
| 270 | /* from user down to NS-VC */ |
| 271 | [] NS_SP.receive(tr_NsUdReq(g_config.nsei, ?, ?, *)) -> value rx_nsudr { |
| 272 | /* FIXME: load distribution function */ |
| 273 | NSVC.send(rx_nsudr) to g_nsvcs[0].vc_conn; |
| 274 | } |
| 275 | [] NS_SP.receive(tr_NsUdReq(?, ?, ?, *)) -> value rx_nsudr { |
| 276 | Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, |
| 277 | log2str("Received NsUnitdataReq for invalid NSEI: ", rx_nsudr)); |
| 278 | } |
| 279 | } |
| 280 | |
| 281 | /*********************************************************************** |
| 282 | per-NSVC component. Exists once for each NS-VC in the NS-VCG |
| 283 | ***********************************************************************/ |
| 284 | |
| 285 | type component NSVC_CT { |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 286 | /* UDP port towards the bottom (IUT) */ |
Harald Welte | 013d65a | 2020-09-13 14:41:31 +0200 | [diff] [blame] | 287 | port NS_PROVIDER_PT NSCP; |
| 288 | var NS_Provider_IPL4_CT vc_NSP_IP; |
Harald Welte | 867243a | 2020-09-13 18:32:32 +0200 | [diff] [blame] | 289 | #ifdef NS_EMULATION_FR |
| 290 | var NS_Provider_FR_CT vc_NSP_FR; |
| 291 | #endif |
Harald Welte | 013d65a | 2020-09-13 14:41:31 +0200 | [diff] [blame] | 292 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 293 | /* port towards the NS_CT */ |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 294 | port NS_SP_PT NS_SP; |
| 295 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 296 | /* configuration passed by the user */ |
| 297 | var NSVCConfiguration g_nsvc_config; |
| 298 | /* we cannot access the NS_CT.config and hence need to copy those */ |
| 299 | var NSConfiguration g_config; |
Alexander Couzens | 2c12b24 | 2018-07-31 00:30:11 +0200 | [diff] [blame] | 300 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 301 | var NsvcState vc_state := NSVC_S_DEAD_BLOCKED; |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 302 | |
| 303 | timer Tns_alive := 3.0; |
| 304 | timer Tns_test := 10.0; |
| 305 | timer Tns_block := 10.0; |
Harald Welte | 3dd8355 | 2020-09-14 11:38:01 +0200 | [diff] [blame] | 306 | timer Tns_reset := 10.0; |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 307 | } |
| 308 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 309 | function NSVCStart(NSVCConfiguration init_config, NSConfiguration init_g_config, charstring id := testcasename()) runs on NSVC_CT { |
| 310 | g_nsvc_config := init_config; |
| 311 | g_config := init_g_config; |
| 312 | f_init(id & "-NSVCemu" & int2str(g_nsvc_config.nsvci)); |
| 313 | f_ScanEvents(); |
Alexander Couzens | 2c12b24 | 2018-07-31 00:30:11 +0200 | [diff] [blame] | 314 | } |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 315 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 316 | private function f_init(charstring id) runs on NSVC_CT { |
| 317 | var Result res; |
| 318 | |
| 319 | if (ischosen(g_nsvc_config.provider.ip)) { |
| 320 | /* Connect the UDP socket */ |
| 321 | vc_NSP_IP := NS_Provider_IPL4_CT.create(id & "-provIP"); |
| 322 | connect(self:NSCP, vc_NSP_IP:NSE); |
| 323 | vc_NSP_IP.start(NS_Provider_IPL4.main(g_nsvc_config, g_config, id)); |
| 324 | #ifdef NS_EMULATION_FR |
| 325 | } else if (ischosen(g_nsvc_config.provider.fr)) { |
| 326 | vc_NSP_FR := NS_Provider_FR_CT.create(id & "-provFR"); |
| 327 | connect(self:NSCP, vc_NSP_FR:NSE); |
| 328 | vc_NSP_FR.start(NS_Provider_FR.main(g_nsvc_config, g_config, id)); |
| 329 | #endif |
| 330 | } |
| 331 | |
| 332 | f_change_state(NSVC_S_DEAD_BLOCKED); |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 333 | } |
| 334 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 335 | private function f_change_state(NsvcState new_state) runs on NSVC_CT { |
| 336 | var NsvcState old_state := vc_state; |
| 337 | vc_state := new_state; |
| 338 | log("NSVC ", g_nsvc_config.nsvci, " State Transition: ", old_state, " -> ", new_state); |
| 339 | NS_SP.send(ts_NsStsInd(g_config.nsei, g_nsvc_config.nsvci, old_state, new_state)); |
| 340 | } |
| 341 | |
| 342 | private function f_sendReset() runs on NSVC_CT { |
| 343 | NSCP.send(ts_NS_RESET(NS_CAUSE_OM_INTERVENTION, g_nsvc_config.nsvci, g_config.nsei)); |
Harald Welte | 3dd8355 | 2020-09-14 11:38:01 +0200 | [diff] [blame] | 344 | Tns_reset.start; |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 345 | vc_state := NSVC_S_WAIT_RESET; |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 346 | } |
| 347 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 348 | private function f_sendAlive() runs on NSVC_CT { |
Harald Welte | 013d65a | 2020-09-13 14:41:31 +0200 | [diff] [blame] | 349 | NSCP.send(t_NS_ALIVE); |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 350 | Tns_alive.start; |
| 351 | } |
| 352 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 353 | private function f_sendUnblock() runs on NSVC_CT { |
Harald Welte | 013d65a | 2020-09-13 14:41:31 +0200 | [diff] [blame] | 354 | NSCP.send(t_NS_UNBLOCK); |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 355 | Tns_block.start; |
| 356 | } |
| 357 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 358 | private function f_sendBlock(NsCause cause) runs on NSVC_CT { |
| 359 | NSCP.send(ts_NS_BLOCK(cause, g_nsvc_config.nsvci)); |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 360 | Tns_block.start; |
| 361 | } |
| 362 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 363 | private altstep as_allstate() runs on NSVC_CT { |
Harald Welte | 013d65a | 2020-09-13 14:41:31 +0200 | [diff] [blame] | 364 | var PDU_NS rf; |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 365 | var ASP_Event evt; |
| 366 | |
| 367 | /* transition to DEAD if t_alive times out */ |
Harald Welte | 9a7c512 | 2020-09-14 11:35:57 +0200 | [diff] [blame] | 368 | [] Tns_alive.timeout { |
| 369 | log("Tns-alive expired: changing to DEAD_BLOCKED + starting Tns-test"); |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 370 | f_change_state(NSVC_S_DEAD_BLOCKED); |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 371 | Tns_test.start; |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 372 | } |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 373 | |
Harald Welte | 9a7c512 | 2020-09-14 11:35:57 +0200 | [diff] [blame] | 374 | [] Tns_test.timeout { |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 375 | log("Tns-test expired: sending NS-ALIVE"); |
| 376 | f_sendAlive(); |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 377 | } |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 378 | |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 379 | /* Stop t_alive when receiving ALIVE-ACK */ |
Harald Welte | 9a7c512 | 2020-09-14 11:35:57 +0200 | [diff] [blame] | 380 | [Tns_alive.running] NSCP.receive(t_NS_ALIVE_ACK) { |
Daniel Willmann | 654f85e | 2020-10-12 18:10:06 +0200 | [diff] [blame] | 381 | log("Rx NS-ALIVE-ACK: stopping Tns-alive; starting Tns-test"); |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 382 | Tns_alive.stop; |
| 383 | Tns_test.start; |
| 384 | } |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 385 | |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 386 | /* respond to NS-ALIVE with NS-ALIVE-ACK */ |
Harald Welte | 013d65a | 2020-09-13 14:41:31 +0200 | [diff] [blame] | 387 | [] NSCP.receive(t_NS_ALIVE) { |
| 388 | NSCP.send(t_NS_ALIVE_ACK); |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 389 | } |
| 390 | |
| 391 | /* Respond to BLOCK for wrong NSVCI */ |
Harald Welte | 013d65a | 2020-09-13 14:41:31 +0200 | [diff] [blame] | 392 | [] NSCP.receive(tr_NS_BLOCK(?, ?)) -> value rf { |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 393 | log("Rx NS-BLOCK for unknown NSVCI"); |
| 394 | /* FIXME */ |
| 395 | } |
| 396 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 397 | [not g_config.handle_sns] as_handle_reset(); |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 398 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 399 | [g_config.role_sgsn and g_config.handle_sns and ischosen(g_nsvc_config.provider.ip)] as_sns_sgsn(); |
Harald Welte | 5e514fa | 2018-07-05 00:01:45 +0200 | [diff] [blame] | 400 | |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 401 | /* default case of handling unknown PDUs */ |
Harald Welte | 013d65a | 2020-09-13 14:41:31 +0200 | [diff] [blame] | 402 | [] NSCP.receive(PDU_NS: ?) -> value rf { |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 403 | log("Rx Unexpected NS PDU ", rf," in state ", vc_state); |
Harald Welte | 013d65a | 2020-09-13 14:41:31 +0200 | [diff] [blame] | 404 | NSCP.send(ts_NS_STATUS(NS_CAUSE_PDU_NOT_COMPATIBLE_WITH_PROTOCOL_STATE, rf)); |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 405 | } |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 406 | } |
| 407 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 408 | private altstep as_handle_reset() runs on NSVC_CT { |
Daniel Willmann | 654f85e | 2020-10-12 18:10:06 +0200 | [diff] [blame] | 409 | var PDU_NS rf; |
| 410 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 411 | [g_config.role_sgsn] NSCP.receive(NS_Provider_Evt:{link_status:=NS_PROV_LINK_STATUS_UP}) { |
Daniel Willmann | 654f85e | 2020-10-12 18:10:06 +0200 | [diff] [blame] | 412 | log("Provider Link came up: waiting for NS-RESET"); |
| 413 | } |
| 414 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 415 | [not g_config.role_sgsn] NSCP.receive(NS_Provider_Evt:{link_status:=NS_PROV_LINK_STATUS_UP}) { |
Daniel Willmann | 654f85e | 2020-10-12 18:10:06 +0200 | [diff] [blame] | 416 | log("Provider Link came up: sending NS-RESET"); |
| 417 | f_sendReset(); |
| 418 | } |
| 419 | |
| 420 | /* Respond to RESET with correct NSEI/NSVCI */ |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 421 | [] NSCP.receive(tr_NS_RESET(?, g_nsvc_config.nsvci, g_config.nsei)) -> value rf { |
| 422 | f_change_state(NSVC_S_ALIVE_BLOCKED); |
| 423 | NSCP.send(ts_NS_RESET_ACK(g_nsvc_config.nsvci, g_config.nsei)); |
Daniel Willmann | 654f85e | 2020-10-12 18:10:06 +0200 | [diff] [blame] | 424 | log("Rx NS-RESET: Sending NS-ALIVE"); |
| 425 | f_sendAlive(); |
| 426 | Tns_test.start; |
| 427 | } |
| 428 | |
| 429 | /* Respond to RESET with wrong NSEI/NSVCI */ |
| 430 | [] NSCP.receive(tr_NS_RESET(?, ?, ?)) -> value rf { |
| 431 | log("Rx NS-RESET for unknown NSEI/NSVCI"); |
| 432 | /* FIXME */ |
| 433 | } |
| 434 | } |
| 435 | |
Harald Welte | 5e514fa | 2018-07-05 00:01:45 +0200 | [diff] [blame] | 436 | /* simple IP Sub-Network Service responder for the SGSN side. This is not a full implementation |
| 437 | * of the protocol, merely sufficient to make the PCU/BSS side happy to proceed */ |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 438 | private altstep as_sns_sgsn() runs on NSVC_CT { |
Harald Welte | 013d65a | 2020-09-13 14:41:31 +0200 | [diff] [blame] | 439 | var PDU_NS rf; |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 440 | [g_config.role_sgsn] NSCP.receive(NS_Provider_Evt:{link_status:=NS_PROV_LINK_STATUS_UP}) { |
Daniel Willmann | 654f85e | 2020-10-12 18:10:06 +0200 | [diff] [blame] | 441 | log("Provider Link came up: sending NS-ALIVE"); |
| 442 | f_sendAlive(); |
| 443 | } |
| 444 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 445 | [not g_config.role_sgsn] NSCP.receive(NS_Provider_Evt:{link_status:=NS_PROV_LINK_STATUS_UP}) { |
Daniel Willmann | 654f85e | 2020-10-12 18:10:06 +0200 | [diff] [blame] | 446 | log("Provider Link came up: sending NS-ALIVE"); |
| 447 | f_sendAlive(); |
| 448 | } |
| 449 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 450 | [] NSCP.receive(tr_SNS_SIZE(g_config.nsei)) -> value rf { |
Harald Welte | 5e514fa | 2018-07-05 00:01:45 +0200 | [diff] [blame] | 451 | /* blindly acknowledge whatever the PCU sends */ |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 452 | NSCP.send(ts_SNS_SIZE_ACK(g_config.nsei, omit)); |
Harald Welte | 5e514fa | 2018-07-05 00:01:45 +0200 | [diff] [blame] | 453 | } |
Harald Welte | 013d65a | 2020-09-13 14:41:31 +0200 | [diff] [blame] | 454 | [] NSCP.receive(tr_SNS_SIZE(?)) { |
Harald Welte | 5e514fa | 2018-07-05 00:01:45 +0200 | [diff] [blame] | 455 | setverdict(fail, "SNS-SIZE from unexpected NSEI"); |
| 456 | self.stop; |
| 457 | } |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 458 | [] NSCP.receive(tr_SNS_CONFIG(g_config.nsei, true, |
| 459 | {tr_SNS_IPv4(g_nsvc_config.provider.ip.remote_ip, |
| 460 | g_nsvc_config.provider.ip.remote_udp_port)})) -> value rf { |
Harald Welte | 5e514fa | 2018-07-05 00:01:45 +0200 | [diff] [blame] | 461 | /* blindly acknowledge whatever the PCU sends */ |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 462 | NSCP.send(ts_SNS_CONFIG_ACK(g_config.nsei, omit)); |
Harald Welte | 5e514fa | 2018-07-05 00:01:45 +0200 | [diff] [blame] | 463 | /* send a SNS-CONFIG in response and expect a SNS-CONFIG-ACK */ |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 464 | var IP4_Elements v4 := { valueof(ts_SNS_IPv4(g_nsvc_config.provider.ip.local_ip, |
| 465 | g_nsvc_config.provider.ip.local_udp_port)) }; |
| 466 | NSCP.send(ts_SNS_CONFIG(g_config.nsei, true, v4)); |
Harald Welte | 5e514fa | 2018-07-05 00:01:45 +0200 | [diff] [blame] | 467 | alt { |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 468 | [] NSCP.receive(tr_SNS_CONFIG_ACK(g_config.nsei, omit)) { |
Harald Welte | 5e514fa | 2018-07-05 00:01:45 +0200 | [diff] [blame] | 469 | /* success */ |
| 470 | } |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 471 | [] NSCP.receive(tr_SNS_CONFIG_ACK(g_config.nsei, ?)) { |
Harald Welte | 5e514fa | 2018-07-05 00:01:45 +0200 | [diff] [blame] | 472 | setverdict(fail, "Unexpected SNS-CONFIG-NACK"); |
| 473 | self.stop; |
| 474 | } |
| 475 | } |
| 476 | } |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 477 | [] NSCP.receive(tr_SNS_CONFIG(g_config.nsei, false, ?)) { /* ignore */} |
| 478 | [] NSCP.receive(tr_SNS_CONFIG(g_config.nsei, true, ?)) { |
Harald Welte | 5e514fa | 2018-07-05 00:01:45 +0200 | [diff] [blame] | 479 | setverdict(fail, "Unexpected SNS-CONFIG content"); |
| 480 | self.stop; |
| 481 | } |
Harald Welte | 013d65a | 2020-09-13 14:41:31 +0200 | [diff] [blame] | 482 | [] NSCP.receive(tr_SNS_CONFIG(?, ?, ?)) { |
Harald Welte | 5e514fa | 2018-07-05 00:01:45 +0200 | [diff] [blame] | 483 | setverdict(fail, "SNS-CONFIG from unexpected NSEI"); |
| 484 | self.stop; |
| 485 | } |
| 486 | } |
| 487 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 488 | private altstep as_alive_blocked() runs on NSVC_CT { |
Harald Welte | 4a6a663 | 2020-09-14 09:58:53 +0200 | [diff] [blame] | 489 | var PDU_NS rf; |
| 490 | /* bogus block, just respond with ACK */ |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 491 | [] NSCP.receive(tr_NS_BLOCK(?, g_nsvc_config.nsvci)) -> value rf { |
| 492 | NSCP.send(ts_NS_BLOCK_ACK(g_nsvc_config.nsvci)); |
Harald Welte | 4a6a663 | 2020-09-14 09:58:53 +0200 | [diff] [blame] | 493 | } |
| 494 | /* Respond to UNBLOCK with UNBLOCK-ACK + change state */ |
| 495 | [] NSCP.receive(t_NS_UNBLOCK) -> value rf { |
| 496 | NSCP.send(t_NS_UNBLOCK_ACK); |
| 497 | Tns_block.stop; |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 498 | f_change_state(NSVC_S_ALIVE_UNBLOCKED); |
Harald Welte | 4a6a663 | 2020-09-14 09:58:53 +0200 | [diff] [blame] | 499 | } |
| 500 | [] NSCP.receive(t_NS_UNBLOCK_ACK) -> value rf { |
| 501 | Tns_block.stop; |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 502 | f_change_state(NSVC_S_ALIVE_UNBLOCKED); |
Harald Welte | 4a6a663 | 2020-09-14 09:58:53 +0200 | [diff] [blame] | 503 | } |
| 504 | [] Tns_block.timeout { |
| 505 | /* repeat unblock transmission */ |
| 506 | f_sendUnblock(); |
| 507 | } |
| 508 | } |
| 509 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 510 | private altstep as_alive_unblocked() runs on NSVC_CT { |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 511 | var NsUnitdataRequest ud_req; |
Harald Welte | 013d65a | 2020-09-13 14:41:31 +0200 | [diff] [blame] | 512 | var PDU_NS rf; |
Harald Welte | 4a6a663 | 2020-09-14 09:58:53 +0200 | [diff] [blame] | 513 | /* bogus unblock, just respond with ACK */ |
| 514 | [] NSCP.receive(t_NS_UNBLOCK) -> value rf { |
| 515 | NSCP.send(t_NS_UNBLOCK_ACK); |
| 516 | } |
| 517 | /* Respond to BLOCK with BLOCK-ACK + change state */ |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 518 | [] NSCP.receive(tr_NS_BLOCK(?, g_nsvc_config.nsvci)) -> value rf { |
| 519 | NSCP.send(ts_NS_BLOCK_ACK(g_nsvc_config.nsvci)); |
Harald Welte | 4a6a663 | 2020-09-14 09:58:53 +0200 | [diff] [blame] | 520 | Tns_block.stop; |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 521 | f_change_state(NSVC_S_ALIVE_BLOCKED); |
Harald Welte | 4a6a663 | 2020-09-14 09:58:53 +0200 | [diff] [blame] | 522 | } |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 523 | [] NSCP.receive(tr_NS_BLOCK_ACK(g_nsvc_config.nsvci)) -> value rf { |
Harald Welte | 4a6a663 | 2020-09-14 09:58:53 +0200 | [diff] [blame] | 524 | Tns_block.stop; |
| 525 | } |
| 526 | /* NS-UNITDATA PDU from network to NS-UNITDATA.ind to user */ |
| 527 | [] NSCP.receive(tr_NS_UNITDATA(?, ?, ?)) -> value rf { |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 528 | NS_SP.send(ts_NsUdInd(g_config.nsei, |
Harald Welte | 4a6a663 | 2020-09-14 09:58:53 +0200 | [diff] [blame] | 529 | oct2int(rf.pDU_NS_Unitdata.bVCI), |
| 530 | rf.pDU_NS_Unitdata.nS_SDU)); |
| 531 | } |
| 532 | /* NS-UNITDATA.req from user to NS-UNITDATA PDU on network */ |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 533 | [] NS_SP.receive(tr_NsUdReq(g_config.nsei, ?, ?, omit)) -> value ud_req { |
Harald Welte | 4a6a663 | 2020-09-14 09:58:53 +0200 | [diff] [blame] | 534 | /* using raw octetstring PDU */ |
| 535 | NSCP.send(ts_NS_UNITDATA(t_SduCtrlB, ud_req.bvci, ud_req.sdu)); |
| 536 | } |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 537 | [] NS_SP.receive(tr_NsUdReq(g_config.nsei, ?, omit, ?)) -> value ud_req { |
Harald Welte | 4a6a663 | 2020-09-14 09:58:53 +0200 | [diff] [blame] | 538 | /* using decoded BSSGP PDU that we need to encode first */ |
| 539 | var octetstring enc := enc_PDU_BSSGP(ud_req.bssgp); |
| 540 | NSCP.send(ts_NS_UNITDATA(t_SduCtrlB, ud_req.bvci, enc)); |
| 541 | } |
| 542 | } |
Harald Welte | 6e594f2 | 2017-07-23 16:19:35 +0200 | [diff] [blame] | 543 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 544 | private altstep as_wait_reset() runs on NSVC_CT { |
Harald Welte | 4a6a663 | 2020-09-14 09:58:53 +0200 | [diff] [blame] | 545 | var PDU_NS rf; |
Harald Welte | 3dd8355 | 2020-09-14 11:38:01 +0200 | [diff] [blame] | 546 | [] Tns_reset.timeout { |
| 547 | /* If the sending entity of an NS-RESET PDU receives no NS-RESET-ACK PDU before timer |
| 548 | * Tns-reset expires the corresponding NS-VCs shall remain blocked and dead and the |
| 549 | * entire reset procedure shall be repeated */ |
| 550 | f_sendReset(); |
| 551 | } |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 552 | [] NSCP.receive(tr_NS_RESET_ACK(g_nsvc_config.nsvci, g_config.nsei)) -> value rf { |
Harald Welte | 3dd8355 | 2020-09-14 11:38:01 +0200 | [diff] [blame] | 553 | Tns_reset.stop; |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 554 | f_change_state(NSVC_S_ALIVE_BLOCKED); |
Harald Welte | 4a6a663 | 2020-09-14 09:58:53 +0200 | [diff] [blame] | 555 | f_sendAlive(); |
| 556 | f_sendUnblock(); |
| 557 | } |
| 558 | } |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 559 | |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 560 | private function f_ScanEvents() runs on NSVC_CT { |
Harald Welte | 4a6a663 | 2020-09-14 09:58:53 +0200 | [diff] [blame] | 561 | var PDU_NS rf; |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 562 | while (true) { |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 563 | alt { |
Harald Welte | 90f1974 | 2020-11-06 19:34:40 +0100 | [diff] [blame] | 564 | [vc_state == NSVC_S_WAIT_RESET] as_wait_reset(); |
| 565 | [vc_state == NSVC_S_ALIVE_BLOCKED] as_alive_blocked(); |
| 566 | [vc_state == NSVC_S_ALIVE_UNBLOCKED] as_alive_unblocked(); |
Harald Welte | 4a6a663 | 2020-09-14 09:58:53 +0200 | [diff] [blame] | 567 | [] as_allstate(); |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 568 | } |
| 569 | } |
Harald Welte | 6fff364 | 2017-07-22 21:36:13 +0200 | [diff] [blame] | 570 | } |
| 571 | } |