Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 1 | module BSSMAP_Emulation { |
| 2 | |
Harald Welte | 35bb716 | 2018-01-03 21:07:52 +0100 | [diff] [blame] | 3 | /* BSSMAP Emulation, runs on top of BSSAP_CodecPort. It multiplexes/demultiplexes |
| 4 | * the individual connections, so there can be separate TTCN-3 components handling |
| 5 | * each of the connections. |
| 6 | * |
| 7 | * The BSSMAP_Emulation.main() function processes SCCP primitives from the SCCP |
| 8 | * stack via the BSSAP_CodecPort, and dispatches them to the per-connection components. |
| 9 | * |
| 10 | * Outbound BSSAP/SCCP connections are initiated by sending a BSSAP_Conn_Req primitive |
| 11 | * to the component running the BSSMAP_Emulation.main() function. |
| 12 | * |
| 13 | * For each new inbound connections, the BssmapOps.create_cb() is called. It can create |
| 14 | * or resolve a TTCN-3 component, and returns a component reference to which that inbound |
| 15 | * connection is routed/dispatched. |
| 16 | * |
| 17 | * If a pre-existing component wants to register to handle a future inbound connection, it can |
| 18 | * do so by registering an "expect" with the expected Layer 3 (DTAP) payload. This is e.g. useful |
| 19 | * if you are simulating BTS + MSC, and first trigger a connection from BTS/RSL side in a |
| 20 | * component which then subsequently should also handle the MSC emulation. |
| 21 | * |
| 22 | * Inbound Unit Data messages (such as are dispatched to the BssmapOps.unitdata_cb() callback, |
| 23 | * which is registered with an argument to the main() function below. |
| 24 | * |
Harald Welte | 0b47606 | 2018-01-21 19:07:32 +0100 | [diff] [blame] | 25 | * (C) 2017-2018 by Harald Welte <laforge@gnumonks.org> |
Harald Welte | 35bb716 | 2018-01-03 21:07:52 +0100 | [diff] [blame] | 26 | * All rights reserved. |
| 27 | * |
| 28 | * Released under the terms of GNU General Public License, Version 2 or |
| 29 | * (at your option) any later version. |
| 30 | */ |
| 31 | |
| 32 | |
Harald Welte | 0b47606 | 2018-01-21 19:07:32 +0100 | [diff] [blame] | 33 | import from General_Types all; |
Harald Welte | 9dadc52 | 2018-02-06 13:56:04 +0100 | [diff] [blame] | 34 | import from Osmocom_Types all; |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 35 | import from SCCP_Emulation all; |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 36 | import from SCCPasp_Types all; |
| 37 | import from BSSAP_Types all; |
Harald Welte | 004f5fb | 2017-12-16 17:54:40 +0100 | [diff] [blame] | 38 | import from BSSAP_CodecPort all; |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 39 | import from BSSMAP_Templates all; |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 40 | import from MGCP_Types all; |
| 41 | import from MGCP_Templates all; |
| 42 | import from IPA_Emulation all; |
Harald Welte | 0b47606 | 2018-01-21 19:07:32 +0100 | [diff] [blame] | 43 | import from MobileL3_Types all; |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 44 | |
| 45 | /* General "base class" component definition, of which specific implementations |
| 46 | * derive themselves by means of the "extends" feature */ |
| 47 | type component BSSAP_ConnHdlr { |
| 48 | /* port towards MSC Emulator core / SCCP connection dispatchar */ |
| 49 | port BSSAP_Conn_PT BSSAP; |
Harald Welte | ca51998 | 2018-01-21 19:28:26 +0100 | [diff] [blame] | 50 | /* procedure based port to register for incoming connections */ |
| 51 | port BSSMAPEM_PROC_PT BSSAP_PROC; |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 52 | } |
| 53 | |
| 54 | /* Auxiliary primitive that can happen on the port between per-connection client and this dispatcher */ |
| 55 | type enumerated BSSAP_Conn_Prim { |
| 56 | /* SCCP tell us that connection was released */ |
| 57 | MSC_CONN_PRIM_DISC_IND, |
| 58 | /* we tell SCCP to release connection */ |
Harald Welte | 71b6933 | 2018-01-21 20:43:53 +0100 | [diff] [blame] | 59 | MSC_CONN_PRIM_DISC_REQ, |
| 60 | /* Connection confirmed indication */ |
| 61 | MSC_CONN_PRIM_CONF_IND |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 62 | } |
| 63 | |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 64 | type record BSSAP_Conn_Req { |
| 65 | SCCP_PAR_Address addr_peer, |
| 66 | SCCP_PAR_Address addr_own, |
| 67 | PDU_BSSAP bssap |
| 68 | } |
| 69 | |
Harald Welte | 0b47606 | 2018-01-21 19:07:32 +0100 | [diff] [blame] | 70 | /* similar to PDU_BSSAP with DTAP, but DTAP is already decoded! */ |
| 71 | type record PDU_DTAP_MO { |
| 72 | OCT1 dlci optional, |
| 73 | PDU_ML3_MS_NW dtap |
| 74 | } |
| 75 | |
| 76 | /* similar to PDU_BSSAP with DTAP, but DTAP is already decoded! */ |
| 77 | type record PDU_DTAP_MT { |
| 78 | OCT1 dlci optional, |
| 79 | PDU_ML3_NW_MS dtap |
| 80 | } |
| 81 | |
| 82 | template PDU_DTAP_MT ts_PDU_DTAP_MT(template PDU_ML3_NW_MS dtap, template OCT1 dlci := omit) := { |
| 83 | dlci := dlci, |
| 84 | dtap := dtap |
| 85 | } |
| 86 | |
| 87 | template PDU_DTAP_MO ts_PDU_DTAP_MO(template PDU_ML3_MS_NW dtap, template OCT1 dlci := '00'O) := { |
| 88 | dlci := dlci, |
| 89 | dtap := dtap |
| 90 | } |
| 91 | |
| 92 | template PDU_DTAP_MT tr_PDU_DTAP_MT(template PDU_ML3_NW_MS dtap, template OCT1 dlci := *) := { |
| 93 | dlci := dlci, |
| 94 | dtap := dtap |
| 95 | } |
| 96 | |
| 97 | template PDU_DTAP_MO tr_PDU_DTAP_MO(template PDU_ML3_MS_NW dtap, template OCT1 dlci := *) := { |
| 98 | dlci := dlci, |
| 99 | dtap := dtap |
| 100 | } |
| 101 | |
| 102 | |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 103 | /* port between individual per-connection components and this dispatcher */ |
| 104 | type port BSSAP_Conn_PT message { |
Harald Welte | a4ca446 | 2018-02-09 00:17:14 +0100 | [diff] [blame] | 105 | /* BSSAP or direct DTAP messages from/to clients */ |
| 106 | inout PDU_BSSAP, PDU_DTAP_MO, PDU_DTAP_MT, |
| 107 | /* misc indications / requests between SCCP and client */ |
| 108 | BSSAP_Conn_Prim, |
| 109 | /* Client requests us to create SCCP Connection */ |
| 110 | BSSAP_Conn_Req, |
| 111 | /* MGCP, only used for IPA SCCPlite (MGCP in IPA mux) */ |
| 112 | MgcpCommand, MgcpResponse; |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 113 | } with { extension "internal" }; |
| 114 | |
| 115 | |
| 116 | /* represents a single BSSAP connection over SCCP */ |
| 117 | type record ConnectionData { |
| 118 | /* reference to the instance of the per-connection component */ |
| 119 | BSSAP_ConnHdlr comp_ref, |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 120 | integer sccp_conn_id, |
| 121 | /* most recent MGCP transaction ID (Used on MSC side) */ |
| 122 | MgcpTransId mgcp_trans_id optional, |
| 123 | /* CIC that has been used for voice of this channel (BSC side) */ |
Harald Welte | 9dadc52 | 2018-02-06 13:56:04 +0100 | [diff] [blame] | 124 | integer cic optional, |
| 125 | /* array of N(SD) values for MO DTAP messages, indexed by discriminator */ |
| 126 | uint2_t n_sd[4] |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 127 | } |
| 128 | |
Harald Welte | 17d2115 | 2018-01-27 00:47:11 +0100 | [diff] [blame] | 129 | type record ImsiMapping { |
| 130 | BSSAP_ConnHdlr comp_ref, |
| 131 | hexstring imsi optional, |
| 132 | OCT4 tmsi |
| 133 | } |
| 134 | |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 135 | type component BSSMAP_Emulation_CT { |
| 136 | /* SCCP port on the bottom side, using ASP primitives */ |
Harald Welte | 004f5fb | 2017-12-16 17:54:40 +0100 | [diff] [blame] | 137 | port BSSAP_CODEC_PT BSSAP; |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 138 | /* BSSAP port to the per-connection clients */ |
| 139 | port BSSAP_Conn_PT CLIENT; |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 140 | /* MGCP port */ |
| 141 | port IPA_MGCP_PT MGCP; |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 142 | |
| 143 | /* use 16 as this is also the number of SCCP connections that SCCP_Emulation can handle */ |
| 144 | var ConnectionData ConnectionTable[16]; |
Harald Welte | 66fecd4 | 2017-11-24 23:53:23 +0100 | [diff] [blame] | 145 | |
Harald Welte | 624f963 | 2017-12-16 19:26:04 +0100 | [diff] [blame] | 146 | /* pending expected incoming connections */ |
| 147 | var ExpectData ExpectTable[8]; |
Harald Welte | 17d2115 | 2018-01-27 00:47:11 +0100 | [diff] [blame] | 148 | |
| 149 | /* tables for mapping inbound unitdata (like paging) */ |
| 150 | var ImsiMapping ImsiTable[16]; |
| 151 | |
Harald Welte | 624f963 | 2017-12-16 19:26:04 +0100 | [diff] [blame] | 152 | /* procedure based port to register for incoming connections */ |
| 153 | port BSSMAPEM_PROC_PT PROC; |
| 154 | |
Harald Welte | be620f6 | 2017-11-25 00:23:54 +0100 | [diff] [blame] | 155 | var charstring g_bssmap_id; |
Harald Welte | 66fecd4 | 2017-11-24 23:53:23 +0100 | [diff] [blame] | 156 | var integer g_next_e1_ts := 1; |
Harald Welte | 0b47606 | 2018-01-21 19:07:32 +0100 | [diff] [blame] | 157 | var BssmapOps g_bssmap_ops; |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 158 | }; |
| 159 | |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 160 | private function f_conn_id_known(integer sccp_conn_id) |
| 161 | runs on BSSMAP_Emulation_CT return boolean { |
| 162 | var integer i; |
| 163 | for (i := 0; i < sizeof(ConnectionTable); i := i+1) { |
| 164 | if (ConnectionTable[i].sccp_conn_id == sccp_conn_id){ |
| 165 | return true; |
| 166 | } |
| 167 | } |
| 168 | return false; |
| 169 | } |
| 170 | |
| 171 | private function f_comp_known(BSSAP_ConnHdlr client) |
| 172 | runs on BSSMAP_Emulation_CT return boolean { |
| 173 | var integer i; |
| 174 | for (i := 0; i < sizeof(ConnectionTable); i := i+1) { |
| 175 | if (ConnectionTable[i].comp_ref == client) { |
| 176 | return true; |
| 177 | } |
| 178 | } |
| 179 | return false; |
| 180 | } |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 181 | |
Harald Welte | e98bb2e | 2017-11-29 12:09:48 +0100 | [diff] [blame] | 182 | private function f_cic_known(integer cic) |
| 183 | runs on BSSMAP_Emulation_CT return boolean { |
| 184 | var integer i; |
| 185 | for (i := 0; i < sizeof(ConnectionTable); i := i+1) { |
| 186 | if (ConnectionTable[i].cic == cic) { |
| 187 | return true; |
| 188 | } |
| 189 | } |
| 190 | return false; |
| 191 | } |
| 192 | |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 193 | /* resolve component reference by connection ID */ |
| 194 | private function f_comp_by_conn_id(integer sccp_conn_id) |
| 195 | runs on BSSMAP_Emulation_CT return BSSAP_ConnHdlr { |
| 196 | var integer i; |
| 197 | for (i := 0; i < sizeof(ConnectionTable); i := i+1) { |
| 198 | if (ConnectionTable[i].sccp_conn_id == sccp_conn_id) { |
| 199 | return ConnectionTable[i].comp_ref; |
| 200 | } |
| 201 | } |
| 202 | log("BSSMAP Connection table not found by SCCP Connection ID ", sccp_conn_id); |
Harald Welte | 9ca9eb1 | 2017-11-25 00:50:43 +0100 | [diff] [blame] | 203 | setverdict(fail); |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 204 | self.stop; |
| 205 | } |
| 206 | |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 207 | /* resolve component reference by CIC */ |
| 208 | private function f_comp_by_mgcp_tid(MgcpTransId tid) |
| 209 | runs on BSSMAP_Emulation_CT return BSSAP_ConnHdlr { |
| 210 | var integer i; |
| 211 | for (i := 0; i < sizeof(ConnectionTable); i := i+1) { |
| 212 | if (ConnectionTable[i].mgcp_trans_id == tid) { |
| 213 | return ConnectionTable[i].comp_ref; |
| 214 | } |
| 215 | } |
| 216 | log("BSSMAP Connection table not found by MGCP Transaction ID ", tid); |
Harald Welte | 9ca9eb1 | 2017-11-25 00:50:43 +0100 | [diff] [blame] | 217 | setverdict(fail); |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 218 | self.stop; |
| 219 | } |
| 220 | |
| 221 | private function f_comp_store_mgcp_tid(BSSAP_ConnHdlr client, MgcpTransId tid) |
| 222 | runs on BSSMAP_Emulation_CT { |
| 223 | var integer i; |
| 224 | for (i := 0; i < sizeof(ConnectionTable); i := i+1) { |
| 225 | if (ConnectionTable[i].comp_ref == client) { |
| 226 | ConnectionTable[i].mgcp_trans_id := tid; |
| 227 | return; |
| 228 | } |
| 229 | } |
| 230 | log("BSSMAP Connection table not found by component ", client); |
Harald Welte | 9ca9eb1 | 2017-11-25 00:50:43 +0100 | [diff] [blame] | 231 | setverdict(fail); |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 232 | self.stop; |
| 233 | } |
| 234 | |
| 235 | private function f_comp_by_cic(integer cic) |
| 236 | runs on BSSMAP_Emulation_CT return BSSAP_ConnHdlr { |
| 237 | var integer i; |
| 238 | for (i := 0; i < sizeof(ConnectionTable); i := i+1) { |
| 239 | if (ConnectionTable[i].cic == cic) { |
| 240 | return ConnectionTable[i].comp_ref; |
| 241 | } |
| 242 | } |
| 243 | log("BSSMAP Connection table not found by CIC ", cic); |
Harald Welte | 9ca9eb1 | 2017-11-25 00:50:43 +0100 | [diff] [blame] | 244 | setverdict(fail); |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 245 | self.stop; |
| 246 | } |
| 247 | |
| 248 | private function f_comp_store_cic(BSSAP_ConnHdlr client, integer cic) |
| 249 | runs on BSSMAP_Emulation_CT { |
| 250 | var integer i; |
| 251 | for (i := 0; i < sizeof(ConnectionTable); i := i+1) { |
| 252 | if (ConnectionTable[i].comp_ref == client) { |
| 253 | ConnectionTable[i].cic := cic; |
| 254 | return; |
| 255 | } |
| 256 | } |
| 257 | log("BSSMAP Connection table not found by component ", client); |
Harald Welte | 9ca9eb1 | 2017-11-25 00:50:43 +0100 | [diff] [blame] | 258 | setverdict(fail); |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 259 | } |
| 260 | |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 261 | /* resolve connection ID by component reference */ |
| 262 | private function f_conn_id_by_comp(BSSAP_ConnHdlr client) |
| 263 | runs on BSSMAP_Emulation_CT return integer { |
| 264 | for (var integer i := 0; i < sizeof(ConnectionTable); i := i+1) { |
| 265 | if (ConnectionTable[i].comp_ref == client) { |
| 266 | return ConnectionTable[i].sccp_conn_id; |
| 267 | } |
| 268 | } |
| 269 | log("BSSMAP Connection table not found by component ", client); |
Harald Welte | 9ca9eb1 | 2017-11-25 00:50:43 +0100 | [diff] [blame] | 270 | setverdict(fail); |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 271 | self.stop; |
| 272 | } |
| 273 | |
Harald Welte | 9dadc52 | 2018-02-06 13:56:04 +0100 | [diff] [blame] | 274 | /* resolve ConnectionTable index component reference */ |
| 275 | private function f_idx_by_comp(BSSAP_ConnHdlr client) |
| 276 | runs on BSSMAP_Emulation_CT return integer { |
| 277 | for (var integer i := 0; i < sizeof(ConnectionTable); i := i+1) { |
| 278 | if (ConnectionTable[i].comp_ref == client) { |
| 279 | return i; |
| 280 | } |
| 281 | } |
| 282 | log("BSSMAP Connection table not found by component ", client); |
| 283 | setverdict(fail); |
| 284 | self.stop; |
| 285 | } |
| 286 | |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 287 | private function f_gen_conn_id() |
| 288 | runs on BSSMAP_Emulation_CT return integer { |
| 289 | var integer conn_id; |
| 290 | |
| 291 | do { |
| 292 | conn_id := float2int(rnd()*SCCP_Emulation.tsp_max_ConnectionId); |
| 293 | } while (f_conn_id_known(conn_id) == true); |
| 294 | |
| 295 | return conn_id; |
| 296 | } |
| 297 | |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 298 | private function f_conn_table_init() |
| 299 | runs on BSSMAP_Emulation_CT { |
| 300 | for (var integer i := 0; i < sizeof(ConnectionTable); i := i+1) { |
| 301 | ConnectionTable[i].comp_ref := null; |
| 302 | ConnectionTable[i].sccp_conn_id := -1; |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 303 | ConnectionTable[i].mgcp_trans_id := omit; |
| 304 | ConnectionTable[i].cic := omit; |
Harald Welte | 9dadc52 | 2018-02-06 13:56:04 +0100 | [diff] [blame] | 305 | ConnectionTable[i].n_sd := { 0, 0, 0, 0 }; |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 306 | } |
Harald Welte | 17d2115 | 2018-01-27 00:47:11 +0100 | [diff] [blame] | 307 | for (var integer i := 0; i < sizeof(ImsiTable); i := i+1) { |
| 308 | ImsiTable[i].comp_ref := null; |
| 309 | ImsiTable[i].imsi := omit; |
| 310 | ImsiTable[i].tmsi := 'FFFFFFFF'O; |
| 311 | } |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 312 | } |
| 313 | |
| 314 | private function f_conn_table_add(BSSAP_ConnHdlr comp_ref, integer sccp_conn_id) |
| 315 | runs on BSSMAP_Emulation_CT { |
| 316 | for (var integer i := 0; i < sizeof(ConnectionTable); i := i+1) { |
| 317 | if (ConnectionTable[i].sccp_conn_id == -1) { |
| 318 | ConnectionTable[i].comp_ref := comp_ref; |
| 319 | ConnectionTable[i].sccp_conn_id := sccp_conn_id; |
Harald Welte | 9dadc52 | 2018-02-06 13:56:04 +0100 | [diff] [blame] | 320 | ConnectionTable[i].n_sd := { 0, 0, 0, 0 }; |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 321 | log("Added conn table entry ", i, comp_ref, sccp_conn_id); |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 322 | return; |
| 323 | } |
| 324 | } |
| 325 | log("BSSMAP Connection table full!"); |
Harald Welte | 9ca9eb1 | 2017-11-25 00:50:43 +0100 | [diff] [blame] | 326 | setverdict(fail); |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 327 | self.stop; |
| 328 | } |
| 329 | |
| 330 | private function f_conn_table_del(integer sccp_conn_id) |
| 331 | runs on BSSMAP_Emulation_CT { |
| 332 | for (var integer i := 0; i < sizeof(ConnectionTable); i := i+1) { |
| 333 | if (ConnectionTable[i].sccp_conn_id == sccp_conn_id) { |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 334 | log("Deleted conn table entry ", i, |
| 335 | ConnectionTable[i].comp_ref, sccp_conn_id); |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 336 | ConnectionTable[i].sccp_conn_id := -1; |
| 337 | ConnectionTable[i].comp_ref := null; |
Harald Welte | 0a4317a | 2017-11-25 00:32:46 +0100 | [diff] [blame] | 338 | return |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 339 | } |
| 340 | } |
| 341 | log("BSSMAP Connection table attempt to delete non-existant ", sccp_conn_id); |
Harald Welte | 9ca9eb1 | 2017-11-25 00:50:43 +0100 | [diff] [blame] | 342 | setverdict(fail); |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 343 | self.stop; |
| 344 | } |
| 345 | |
Harald Welte | 17d2115 | 2018-01-27 00:47:11 +0100 | [diff] [blame] | 346 | private function f_imsi_table_find(hexstring imsi, template OCT4 tmsi) |
| 347 | runs on BSSMAP_Emulation_CT return BSSAP_ConnHdlr { |
| 348 | for (var integer i := 0; i < sizeof(ImsiTable); i := i+1) { |
| 349 | if (ImsiTable[i].imsi == imsi or |
| 350 | isvalue(tmsi) and match(ImsiTable[i].tmsi, tmsi)) { |
| 351 | return ImsiTable[i].comp_ref; |
| 352 | } |
| 353 | } |
| 354 | return null; |
| 355 | } |
| 356 | |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 357 | /* handle (optional) userData portion of various primitives and dispatch it to the client */ |
Harald Welte | 004f5fb | 2017-12-16 17:54:40 +0100 | [diff] [blame] | 358 | private function f_handle_userData(BSSAP_ConnHdlr client, PDU_BSSAP bssap) |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 359 | runs on BSSMAP_Emulation_CT { |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 360 | /* decode + send decoded BSSAP to client */ |
Harald Welte | 1b2748e | 2017-11-24 23:40:16 +0100 | [diff] [blame] | 361 | |
Harald Welte | 473676b | 2018-01-27 20:38:01 +0100 | [diff] [blame] | 362 | if (ischosen(bssap.pdu.bssmap)) { |
| 363 | /* BSC Side: If this is an assignment command, store CIC */ |
| 364 | if (ischosen(bssap.pdu.bssmap.assignmentRequest) and |
| 365 | ispresent(bssap.pdu.bssmap.assignmentRequest.circuitIdentityCode)) { |
| 366 | var BSSMAP_IE_CircuitIdentityCode cic_ie := |
| 367 | bssap.pdu.bssmap.assignmentRequest.circuitIdentityCode; |
| 368 | var integer cic := (oct2int(cic_ie.cicHigh) * 256) + oct2int(cic_ie.cicLow); |
| 369 | f_comp_store_cic(client, cic); |
| 370 | } |
Harald Welte | 1b2748e | 2017-11-24 23:40:16 +0100 | [diff] [blame] | 371 | } |
| 372 | |
Harald Welte | 0b47606 | 2018-01-21 19:07:32 +0100 | [diff] [blame] | 373 | if (ischosen(bssap.pdu.dtap) and g_bssmap_ops.decode_dtap) { |
| 374 | if (g_bssmap_ops.role_ms) { |
| 375 | /* we are the MS, so any message to us must be MT */ |
| 376 | var PDU_DTAP_MT mt := { |
| 377 | dlci := bssap.dlci, |
| 378 | dtap := dec_PDU_ML3_NW_MS(bssap.pdu.dtap) |
| 379 | }; |
| 380 | CLIENT.send(mt) to client; |
| 381 | } else { |
| 382 | /* we are the Network, so any message to us must be MO */ |
| 383 | var PDU_DTAP_MO mo := { |
| 384 | dlci := bssap.dlci, |
| 385 | dtap := dec_PDU_ML3_MS_NW(bssap.pdu.dtap) |
| 386 | }; |
| 387 | CLIENT.send(mo) to client; |
| 388 | } |
| 389 | } else { |
| 390 | CLIENT.send(bssap) to client; |
| 391 | } |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 392 | } |
| 393 | |
| 394 | /* call-back type, to be provided by specific implementation; called when new SCCP connection |
| 395 | * arrives */ |
Harald Welte | 004f5fb | 2017-12-16 17:54:40 +0100 | [diff] [blame] | 396 | type function BssmapCreateCallback(BSSAP_N_CONNECT_ind conn_ind, charstring id) |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 397 | runs on BSSMAP_Emulation_CT return BSSAP_ConnHdlr; |
| 398 | |
| 399 | type function BssmapUnitdataCallback(PDU_BSSAP bssap) |
| 400 | runs on BSSMAP_Emulation_CT return template PDU_BSSAP; |
| 401 | |
Harald Welte | 17d2115 | 2018-01-27 00:47:11 +0100 | [diff] [blame] | 402 | /* handle common Unitdata such as Paging */ |
| 403 | private function CommonBssmapUnitdataCallback(PDU_BSSAP bssap) |
| 404 | runs on BSSMAP_Emulation_CT return template PDU_BSSAP { |
| 405 | if (match(bssap, tr_BSSMAP_Paging)) { |
| 406 | var BSSAP_ConnHdlr client := null; |
| 407 | client := f_imsi_table_find(bssap.pdu.bssmap.paging.iMSI.digits, |
| 408 | bssap.pdu.bssmap.paging.tMSI.tmsiOctets); |
| 409 | if (isvalue(client)) { |
| 410 | log("CommonBssmapUnitdataCallback: IMSI/TMSI found in table, dispatching to ", |
| 411 | client); |
| 412 | CLIENT.send(bssap) to client; |
| 413 | return omit; |
| 414 | } |
| 415 | log("CommonBssmapUnitdataCallback: IMSI/TMSI not found in table"); |
| 416 | } else { |
| 417 | log("CommonBssmapUnitdataCallback: Not a paging message"); |
| 418 | } |
| 419 | /* ELSE: handle in user callback */ |
| 420 | return g_bssmap_ops.unitdata_cb.apply(bssap); |
| 421 | } |
| 422 | |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 423 | type record BssmapOps { |
| 424 | BssmapCreateCallback create_cb, |
Harald Welte | 0b47606 | 2018-01-21 19:07:32 +0100 | [diff] [blame] | 425 | BssmapUnitdataCallback unitdata_cb, |
| 426 | boolean decode_dtap, |
Harald Welte | a4ca446 | 2018-02-09 00:17:14 +0100 | [diff] [blame] | 427 | boolean role_ms, |
| 428 | /* needed for performing BSSMAP RESET */ |
| 429 | SCCP_PAR_Address sccp_addr_local optional, |
| 430 | SCCP_PAR_Address sccp_addr_peer optional |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 431 | } |
| 432 | |
Harald Welte | 9dadc52 | 2018-02-06 13:56:04 +0100 | [diff] [blame] | 433 | template BIT4 t_ML3_DISC_CC_MM_SS := ('0011'B, '0101'B, '1011'B); |
| 434 | |
| 435 | /* patch N(SD) into enc_l3, according to 24.007 11.2.3.2 */ |
| 436 | function f_ML3_patch_seq(inout ConnectionData cd, in PDU_ML3_MS_NW dtap, inout octetstring enc_l3) { |
| 437 | var uint2_t seq_nr; |
| 438 | if (ischosen(dtap.msgs.cc) or ischosen(dtap.msgs.mm) or ischosen(dtap.msgs.ss)) { |
| 439 | seq_nr := cd.n_sd[0]; |
| 440 | cd.n_sd[0] := (cd.n_sd[0] + 1) mod 4; |
| 441 | } else if (ischosen(dtap.msgs.gcc)) { |
| 442 | seq_nr := cd.n_sd[1]; |
| 443 | cd.n_sd[1] := (cd.n_sd[1] + 1) mod 2; |
| 444 | } else if (ischosen(dtap.msgs.bcc)) { |
| 445 | seq_nr := cd.n_sd[2]; |
| 446 | cd.n_sd[2] := (cd.n_sd[2] + 1) mod 2; |
| 447 | } else if (ischosen(dtap.msgs.loc)) { |
| 448 | seq_nr := cd.n_sd[3]; |
| 449 | cd.n_sd[3] := (cd.n_sd[3] + 1) mod 2; |
| 450 | } else { |
| 451 | /* no sequence number to patch */ |
| 452 | return; |
| 453 | } |
| 454 | log("patching N(SD)=", seq_nr, " into dtap ", enc_l3); |
| 455 | enc_l3[1] := (enc_l3[1] and4b '3f'O) or4b bit2oct(int2bit(seq_nr, 8) << 6); |
| 456 | log("patched enc_l3: ", enc_l3); |
| 457 | } |
| 458 | |
Harald Welte | 49518bf | 2018-02-10 11:39:19 +0100 | [diff] [blame] | 459 | private function f_bssap_l3_is_rr(PDU_BSSAP bssap) return boolean { |
| 460 | var template octetstring l3 := f_bssap_extract_l3(bssap); |
| 461 | if (not isvalue(l3)) { |
| 462 | return false; |
| 463 | } |
| 464 | var octetstring l3v := valueof(l3); |
| 465 | /* lower 4 bits of first octet are protocol discriminator */ |
| 466 | if ((oct2bit(l3v[0]) and4b '00001111'B) == '00000110'B) { |
| 467 | return true; |
| 468 | } |
| 469 | return false; |
| 470 | } |
| 471 | |
Harald Welte | a4ca446 | 2018-02-09 00:17:14 +0100 | [diff] [blame] | 472 | private altstep as_reset_ack() runs on BSSMAP_Emulation_CT { |
| 473 | var BSSAP_N_UNITDATA_ind ud_ind; |
| 474 | [] BSSAP.receive(tr_BSSAP_UNITDATA_ind(?, ?, tr_BSSMAP_Reset)) -> value ud_ind { |
| 475 | log("Respoding to inbound RESET with RESET-ACK"); |
| 476 | BSSAP.send(ts_BSSAP_UNITDATA_req(ud_ind.callingAddress, ud_ind.calledAddress, |
| 477 | ts_BSSMAP_ResetAck)); |
| 478 | repeat; |
| 479 | } |
| 480 | } |
| 481 | |
| 482 | |
| 483 | private function f_bssap_wait_for_reset() runs on BSSMAP_Emulation_CT { |
| 484 | var BSSAP_N_UNITDATA_ind ud_ind; |
| 485 | timer T := 20.0; |
| 486 | |
| 487 | T.start; |
| 488 | alt { |
| 489 | [] BSSAP.receive(tr_BSSAP_UNITDATA_ind(?, ?, tr_BSSMAP_Reset)) -> value ud_ind { |
| 490 | BSSAP.send(ts_BSSAP_UNITDATA_req(ud_ind.callingAddress, ud_ind.calledAddress, |
| 491 | ts_BSSMAP_ResetAck)); |
| 492 | } |
| 493 | [] as_reset_ack(); |
| 494 | [] BSSAP.receive { |
| 495 | repeat; |
| 496 | } |
| 497 | [] T.timeout { |
| 498 | setverdict(fail); |
| 499 | } |
| 500 | } |
| 501 | } |
| 502 | |
| 503 | function f_bssap_reset(SCCP_PAR_Address peer, SCCP_PAR_Address own) runs on BSSMAP_Emulation_CT { |
| 504 | timer T := 5.0; |
| 505 | |
| 506 | BSSAP.send(ts_BSSAP_UNITDATA_req(peer, own, ts_BSSMAP_Reset(0))); |
| 507 | T.start; |
| 508 | alt { |
| 509 | [] BSSAP.receive(tr_BSSAP_UNITDATA_ind(own, peer, tr_BSSMAP_ResetAck)) { |
| 510 | log("Received RESET-ACK in response to RESET, we're ready to go!"); |
| 511 | } |
| 512 | [] as_reset_ack(); |
| 513 | [] BSSAP.receive { repeat }; |
| 514 | [] T.timeout { setverdict(fail, "Waiting for RESET-ACK after sending RESET"); } |
| 515 | } |
| 516 | } |
| 517 | |
Harald Welte | be620f6 | 2017-11-25 00:23:54 +0100 | [diff] [blame] | 518 | function main(BssmapOps ops, charstring id) runs on BSSMAP_Emulation_CT { |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 519 | |
Harald Welte | be620f6 | 2017-11-25 00:23:54 +0100 | [diff] [blame] | 520 | g_bssmap_id := id; |
Harald Welte | 0b47606 | 2018-01-21 19:07:32 +0100 | [diff] [blame] | 521 | g_bssmap_ops := ops; |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 522 | f_conn_table_init(); |
Daniel Willmann | d47106b | 2018-01-17 12:20:56 +0100 | [diff] [blame] | 523 | f_expect_table_init(); |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 524 | |
Harald Welte | a4ca446 | 2018-02-09 00:17:14 +0100 | [diff] [blame] | 525 | if (isvalue(ops.sccp_addr_peer) and isvalue(ops.sccp_addr_local)) { |
Harald Welte | 7f58258 | 2018-02-14 20:20:11 +0100 | [diff] [blame^] | 526 | f_sleep(1.0); /* HACK to wait for M3UA/ASP to be ACTIVE */ |
Harald Welte | a4ca446 | 2018-02-09 00:17:14 +0100 | [diff] [blame] | 527 | f_bssap_reset(ops.sccp_addr_peer, ops.sccp_addr_local); |
| 528 | } |
| 529 | |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 530 | while (true) { |
Harald Welte | 004f5fb | 2017-12-16 17:54:40 +0100 | [diff] [blame] | 531 | var BSSAP_N_UNITDATA_ind ud_ind; |
| 532 | var BSSAP_N_CONNECT_ind conn_ind; |
| 533 | var BSSAP_N_CONNECT_cfm conn_cfm; |
| 534 | var BSSAP_N_DATA_ind data_ind; |
| 535 | var BSSAP_N_DISCONNECT_ind disc_ind; |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 536 | var BSSAP_Conn_Req creq; |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 537 | var BSSAP_ConnHdlr vc_conn; |
| 538 | var PDU_BSSAP bssap; |
Harald Welte | 0b47606 | 2018-01-21 19:07:32 +0100 | [diff] [blame] | 539 | var PDU_DTAP_MO dtap_mo; |
| 540 | var PDU_DTAP_MT dtap_mt; |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 541 | var MgcpCommand mgcp_req; |
| 542 | var MgcpResponse mgcp_resp; |
Harald Welte | 624f963 | 2017-12-16 19:26:04 +0100 | [diff] [blame] | 543 | var BSSAP_ConnHdlr vc_hdlr; |
| 544 | var octetstring l3_info; |
Harald Welte | 17d2115 | 2018-01-27 00:47:11 +0100 | [diff] [blame] | 545 | var hexstring imsi; |
| 546 | var OCT4 tmsi; |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 547 | |
| 548 | alt { |
| 549 | /* SCCP -> Client: UNIT-DATA (connectionless SCCP) from a BSC */ |
Harald Welte | 004f5fb | 2017-12-16 17:54:40 +0100 | [diff] [blame] | 550 | [] BSSAP.receive(BSSAP_N_UNITDATA_ind:?) -> value ud_ind { |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 551 | /* Connectionless Procedures like RESET */ |
| 552 | var template PDU_BSSAP resp; |
Harald Welte | 17d2115 | 2018-01-27 00:47:11 +0100 | [diff] [blame] | 553 | resp := CommonBssmapUnitdataCallback(ud_ind.userData); |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 554 | if (isvalue(resp)) { |
Harald Welte | 004f5fb | 2017-12-16 17:54:40 +0100 | [diff] [blame] | 555 | BSSAP.send(ts_BSSAP_UNITDATA_req(ud_ind.callingAddress, |
| 556 | ud_ind.calledAddress, resp)); |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 557 | } |
| 558 | } |
| 559 | |
| 560 | /* SCCP -> Client: new connection from BSC */ |
Harald Welte | 004f5fb | 2017-12-16 17:54:40 +0100 | [diff] [blame] | 561 | [] BSSAP.receive(BSSAP_N_CONNECT_ind:?) -> value conn_ind { |
Harald Welte | be620f6 | 2017-11-25 00:23:54 +0100 | [diff] [blame] | 562 | vc_conn := ops.create_cb.apply(conn_ind, id); |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 563 | /* store mapping between client components and SCCP connectionId */ |
| 564 | f_conn_table_add(vc_conn, conn_ind.connectionId); |
| 565 | /* handle user payload */ |
| 566 | f_handle_userData(vc_conn, conn_ind.userData); |
| 567 | /* confirm connection establishment */ |
Harald Welte | 004f5fb | 2017-12-16 17:54:40 +0100 | [diff] [blame] | 568 | BSSAP.send(ts_BSSAP_CONNECT_res(conn_ind.connectionId, omit)); |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 569 | } |
| 570 | |
| 571 | /* SCCP -> Client: connection-oriented data in existing connection */ |
Harald Welte | 004f5fb | 2017-12-16 17:54:40 +0100 | [diff] [blame] | 572 | [] BSSAP.receive(BSSAP_N_DATA_ind:?) -> value data_ind { |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 573 | vc_conn := f_comp_by_conn_id(data_ind.connectionId); |
Harald Welte | 5cc4aa2 | 2017-11-23 18:51:28 +0100 | [diff] [blame] | 574 | if (ispresent(data_ind.userData)) { |
| 575 | f_handle_userData(vc_conn, data_ind.userData); |
| 576 | } |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 577 | } |
| 578 | |
| 579 | /* SCCP -> Client: disconnect of an existing connection */ |
Harald Welte | 004f5fb | 2017-12-16 17:54:40 +0100 | [diff] [blame] | 580 | [] BSSAP.receive(BSSAP_N_DISCONNECT_ind:?) -> value disc_ind { |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 581 | vc_conn := f_comp_by_conn_id(disc_ind.connectionId); |
Harald Welte | 5cc4aa2 | 2017-11-23 18:51:28 +0100 | [diff] [blame] | 582 | if (ispresent(disc_ind.userData)) { |
| 583 | f_handle_userData(vc_conn, disc_ind.userData); |
| 584 | } |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 585 | /* notify client about termination */ |
| 586 | var BSSAP_Conn_Prim prim := MSC_CONN_PRIM_DISC_IND; |
| 587 | CLIENT.send(prim) to vc_conn; |
| 588 | f_conn_table_del(disc_ind.connectionId); |
| 589 | /* TOOD: return confirm to other side? */ |
| 590 | } |
| 591 | |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 592 | /* SCCP -> Client: connection confirm for outbound connection */ |
Harald Welte | 004f5fb | 2017-12-16 17:54:40 +0100 | [diff] [blame] | 593 | [] BSSAP.receive(BSSAP_N_CONNECT_cfm:?) -> value conn_cfm { |
Harald Welte | 71b6933 | 2018-01-21 20:43:53 +0100 | [diff] [blame] | 594 | vc_conn := f_comp_by_conn_id(conn_cfm.connectionId); |
| 595 | var BSSAP_Conn_Prim prim := MSC_CONN_PRIM_CONF_IND; |
| 596 | CLIENT.send(prim) to vc_conn; |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 597 | /* handle user payload */ |
Harald Welte | 5cc4aa2 | 2017-11-23 18:51:28 +0100 | [diff] [blame] | 598 | if (ispresent(conn_cfm.userData)) { |
| 599 | f_handle_userData(vc_conn, conn_cfm.userData); |
| 600 | } |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 601 | } |
| 602 | |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 603 | /* Disconnect request client -> SCCP */ |
| 604 | [] CLIENT.receive(BSSAP_Conn_Prim:MSC_CONN_PRIM_DISC_REQ) -> sender vc_conn { |
| 605 | var integer conn_id := f_conn_id_by_comp(vc_conn); |
Harald Welte | 004f5fb | 2017-12-16 17:54:40 +0100 | [diff] [blame] | 606 | BSSAP.send(ts_BSSAP_DISC_req(conn_id, 0)); |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 607 | f_conn_table_del(conn_id); |
| 608 | } |
| 609 | |
| 610 | /* BSSAP from client -> SCCP */ |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 611 | [] CLIENT.receive(BSSAP_Conn_Req:?) -> value creq sender vc_conn { |
| 612 | var integer conn_id; |
Harald Welte | 004f5fb | 2017-12-16 17:54:40 +0100 | [diff] [blame] | 613 | /* send to dispatcher */ |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 614 | |
| 615 | if (f_comp_known(vc_conn) == false) { |
| 616 | /* unknown client, create new connection */ |
| 617 | conn_id := f_gen_conn_id(); |
| 618 | |
| 619 | /* store mapping between client components and SCCP connectionId */ |
| 620 | f_conn_table_add(vc_conn, conn_id); |
| 621 | |
Harald Welte | 004f5fb | 2017-12-16 17:54:40 +0100 | [diff] [blame] | 622 | BSSAP.send(ts_BSSAP_CONNECT_req(creq.addr_peer, creq.addr_own, conn_id, |
| 623 | creq.bssap)); |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 624 | } else { |
| 625 | /* known client, send via existing connection */ |
| 626 | conn_id := f_conn_id_by_comp(vc_conn); |
Harald Welte | 004f5fb | 2017-12-16 17:54:40 +0100 | [diff] [blame] | 627 | BSSAP.send(ts_BSSAP_DATA_req(conn_id, creq.bssap)); |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 628 | } |
| 629 | |
Harald Welte | 49518bf | 2018-02-10 11:39:19 +0100 | [diff] [blame] | 630 | /* InitialL3 contains RR (PAG RESP) or MM (CM SRV REQ), we must increment |
| 631 | * counter only on MM/CC/SS, but not on RR */ |
| 632 | if (g_bssmap_ops.role_ms and not f_bssap_l3_is_rr(creq.bssap)) { |
Harald Welte | 9dadc52 | 2018-02-06 13:56:04 +0100 | [diff] [blame] | 633 | /* we have just sent the first MM message, increment the counter */ |
| 634 | var integer idx := f_idx_by_comp(vc_conn); |
| 635 | ConnectionTable[idx].n_sd[0] := 1; |
| 636 | log("patch: N(SD) for ConnIdx ", idx, " set to 1"); |
| 637 | } |
| 638 | |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 639 | } |
| 640 | |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 641 | [] CLIENT.receive(PDU_BSSAP:?) -> value bssap sender vc_conn { |
| 642 | var integer conn_id := f_conn_id_by_comp(vc_conn); |
Harald Welte | 004f5fb | 2017-12-16 17:54:40 +0100 | [diff] [blame] | 643 | /* send it to dispatcher */ |
| 644 | BSSAP.send(ts_BSSAP_DATA_req(conn_id, bssap)); |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 645 | } |
| 646 | |
Harald Welte | 0b47606 | 2018-01-21 19:07:32 +0100 | [diff] [blame] | 647 | [g_bssmap_ops.role_ms] CLIENT.receive(PDU_DTAP_MO:?) -> value dtap_mo sender vc_conn { |
Harald Welte | 9dadc52 | 2018-02-06 13:56:04 +0100 | [diff] [blame] | 648 | var integer idx := f_idx_by_comp(vc_conn); |
Harald Welte | 0b47606 | 2018-01-21 19:07:32 +0100 | [diff] [blame] | 649 | /* convert from decoded DTAP to encoded DTAP */ |
| 650 | var octetstring l3_enc := enc_PDU_ML3_MS_NW(dtap_mo.dtap); |
Harald Welte | 9dadc52 | 2018-02-06 13:56:04 +0100 | [diff] [blame] | 651 | /* patch correct L3 send sequence number N(SD) into l3_enc */ |
| 652 | f_ML3_patch_seq(ConnectionTable[idx], dtap_mo.dtap, l3_enc); |
Harald Welte | 0b47606 | 2018-01-21 19:07:32 +0100 | [diff] [blame] | 653 | bssap := valueof(ts_BSSAP_DTAP(l3_enc, dtap_mo.dlci)); |
Harald Welte | 9dadc52 | 2018-02-06 13:56:04 +0100 | [diff] [blame] | 654 | BSSAP.send(ts_BSSAP_DATA_req(ConnectionTable[idx].sccp_conn_id, bssap)); |
Harald Welte | 0b47606 | 2018-01-21 19:07:32 +0100 | [diff] [blame] | 655 | } |
| 656 | |
| 657 | [not g_bssmap_ops.role_ms] CLIENT.receive(PDU_DTAP_MT:?) -> value dtap_mt sender vc_conn { |
| 658 | var integer conn_id := f_conn_id_by_comp(vc_conn); |
| 659 | /* convert from decoded DTAP to encoded DTAP */ |
| 660 | var octetstring l3_enc := enc_PDU_ML3_NW_MS(dtap_mt.dtap); |
| 661 | bssap := valueof(ts_BSSAP_DTAP(l3_enc, dtap_mo.dlci)); |
| 662 | BSSAP.send(ts_BSSAP_DATA_req(conn_id, bssap)); |
| 663 | } |
| 664 | |
| 665 | |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 666 | /* Handling of MGCP in IPA SCCPLite case. This predates 3GPP AoIP |
| 667 | * and uses a MGCP session in parallel to BSSAP. BSSAP uses CIC |
| 668 | * as usual, and MGCP uses "CIC@mgw" endpoint naming, where CIC |
| 669 | * is printed as hex string, e.g. a@mgw for CIC 10 */ |
| 670 | |
| 671 | /* CLIENT -> MGCP */ |
| 672 | [] CLIENT.receive(MgcpCommand:?) -> value mgcp_req sender vc_conn { |
| 673 | /* MGCP request from Handler (we're MSC) */ |
| 674 | /* store the transaction ID we've seen */ |
| 675 | f_comp_store_mgcp_tid(vc_conn, mgcp_req.line.trans_id); |
| 676 | /* simply forward any MGCP from the client to the port */ |
| 677 | MGCP.send(mgcp_req); |
| 678 | } |
| 679 | [] CLIENT.receive(MgcpResponse:?) -> value mgcp_resp sender vc_conn { |
| 680 | /* MGCP response from Handler (we're BSC/MGW) */ |
| 681 | /* simply forward any MGCP from the client to the port */ |
| 682 | MGCP.send(mgcp_resp); |
| 683 | } |
| 684 | |
| 685 | /* MGCP -> CLIENT */ |
| 686 | [] MGCP.receive(MgcpCommand:?) -> value mgcp_req { |
| 687 | /* MGCP request from network side (we're BSC/MGW) */ |
| 688 | /* Extract CIC from local part of endpoint name */ |
| 689 | var integer cic := f_mgcp_ep_extract_cic(mgcp_req.line.ep); |
Harald Welte | e98bb2e | 2017-11-29 12:09:48 +0100 | [diff] [blame] | 690 | if (match(mgcp_req, tr_RSIP) and f_cic_known(cic) == false) { |
| 691 | /* ignore RSIP for unknown CIC */ |
| 692 | } else { |
| 693 | /* Resolve the vc_conn by the CIC */ |
| 694 | vc_conn := f_comp_by_cic(cic); |
| 695 | CLIENT.send(mgcp_req) to vc_conn; |
| 696 | } |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 697 | } |
| 698 | [] MGCP.receive(MgcpResponse:?) -> value mgcp_resp { |
| 699 | /* MGCP response from network side (we're MSC) */ |
| 700 | /* Resolve the vc_conn by the transaction ID */ |
| 701 | vc_conn := f_comp_by_mgcp_tid(mgcp_resp.line.trans_id); |
| 702 | CLIENT.send(mgcp_resp) to vc_conn; |
| 703 | } |
| 704 | |
Harald Welte | 624f963 | 2017-12-16 19:26:04 +0100 | [diff] [blame] | 705 | |
| 706 | [] PROC.getcall(BSSMAPEM_register:{?,?}) -> param(l3_info, vc_hdlr) { |
| 707 | f_create_expect(l3_info, vc_hdlr); |
| 708 | PROC.reply(BSSMAPEM_register:{l3_info, vc_hdlr}); |
| 709 | } |
| 710 | |
Harald Welte | 17d2115 | 2018-01-27 00:47:11 +0100 | [diff] [blame] | 711 | [] PROC.getcall(BSSMAPEM_register_imsi:{?,?,?}) -> param(imsi, tmsi, vc_hdlr) { |
| 712 | f_create_imsi(imsi, tmsi, vc_hdlr); |
| 713 | PROC.reply(BSSMAPEM_register_imsi:{imsi, tmsi, vc_hdlr}); |
| 714 | } |
| 715 | |
| 716 | |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 717 | } |
| 718 | } |
| 719 | } |
| 720 | |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 721 | private function f_mgcp_ep_extract_cic(charstring inp) return integer { |
Harald Welte | 525a9c1 | 2017-11-24 23:40:41 +0100 | [diff] [blame] | 722 | var charstring local_part := regexp(inp, "(*)@*", 0); |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 723 | return hex2int(str2hex(local_part)); |
| 724 | |
| 725 | } |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 726 | |
Harald Welte | 624f963 | 2017-12-16 19:26:04 +0100 | [diff] [blame] | 727 | /*********************************************************************** |
| 728 | * "Expect" Handling (mapping for expected incoming SCCP connections) |
| 729 | ***********************************************************************/ |
| 730 | |
| 731 | /* data about an expected future incoming connection */ |
| 732 | type record ExpectData { |
| 733 | /* L3 payload based on which we can match it */ |
| 734 | octetstring l3_payload optional, |
| 735 | /* component reference for this connection */ |
| 736 | BSSAP_ConnHdlr vc_conn |
| 737 | } |
| 738 | |
| 739 | /* procedure based port to register for incoming connections */ |
| 740 | signature BSSMAPEM_register(in octetstring l3, in BSSAP_ConnHdlr hdlr); |
| 741 | |
Harald Welte | 17d2115 | 2018-01-27 00:47:11 +0100 | [diff] [blame] | 742 | /* procedure based port to register for incoming IMSI/TMSI */ |
| 743 | signature BSSMAPEM_register_imsi(in hexstring imsi, in OCT4 tmsi, in BSSAP_ConnHdlr hdlr); |
| 744 | |
Harald Welte | 624f963 | 2017-12-16 19:26:04 +0100 | [diff] [blame] | 745 | type port BSSMAPEM_PROC_PT procedure { |
Harald Welte | 17d2115 | 2018-01-27 00:47:11 +0100 | [diff] [blame] | 746 | inout BSSMAPEM_register, BSSMAPEM_register_imsi; |
Harald Welte | 624f963 | 2017-12-16 19:26:04 +0100 | [diff] [blame] | 747 | } with { extension "internal" }; |
| 748 | |
| 749 | /* CreateCallback that can be used as create_cb and will use the expectation table */ |
| 750 | function ExpectedCreateCallback(BSSAP_N_CONNECT_ind conn_ind, charstring id) |
| 751 | runs on BSSMAP_Emulation_CT return BSSAP_ConnHdlr { |
| 752 | var BSSAP_ConnHdlr ret := null; |
| 753 | var octetstring l3_info; |
| 754 | var integer i; |
| 755 | |
| 756 | if (not ischosen(conn_ind.userData.pdu.bssmap.completeLayer3Information)) { |
| 757 | setverdict(fail, "N-CONNECT.ind with L3 != COMPLETE L3"); |
| 758 | return ret; |
| 759 | } |
| 760 | l3_info := conn_ind.userData.pdu.bssmap.completeLayer3Information.layer3Information.layer3info; |
| 761 | |
| 762 | for (i := 0; i < sizeof(ExpectTable); i:= i+1) { |
| 763 | if (not ispresent(ExpectTable[i].l3_payload)) { |
| 764 | continue; |
| 765 | } |
| 766 | if (l3_info == ExpectTable[i].l3_payload) { |
| 767 | ret := ExpectTable[i].vc_conn; |
| 768 | /* release this entry to be used again */ |
| 769 | ExpectTable[i].l3_payload := omit; |
| 770 | ExpectTable[i].vc_conn := null; |
| 771 | log("Found Expect[", i, "] for ", l3_info, " handled at ", ret); |
| 772 | /* return the component reference */ |
| 773 | return ret; |
| 774 | } |
| 775 | } |
| 776 | setverdict(fail, "Couldn't find Expect for incoming connection ", conn_ind); |
| 777 | return ret; |
| 778 | } |
| 779 | |
| 780 | private function f_create_expect(octetstring l3, BSSAP_ConnHdlr hdlr) |
| 781 | runs on BSSMAP_Emulation_CT { |
| 782 | var integer i; |
| 783 | for (i := 0; i < sizeof(ExpectTable); i := i+1) { |
| 784 | if (not ispresent(ExpectTable[i].l3_payload)) { |
| 785 | ExpectTable[i].l3_payload := l3; |
| 786 | ExpectTable[i].vc_conn := hdlr; |
| 787 | log("Created Expect[", i, "] for ", l3, " to be handled at ", hdlr); |
| 788 | return; |
| 789 | } |
| 790 | } |
| 791 | setverdict(fail, "No space left in ExpectTable"); |
| 792 | } |
| 793 | |
Harald Welte | 17d2115 | 2018-01-27 00:47:11 +0100 | [diff] [blame] | 794 | private function f_create_imsi(hexstring imsi, OCT4 tmsi, BSSAP_ConnHdlr hdlr) |
| 795 | runs on BSSMAP_Emulation_CT { |
| 796 | for (var integer i := 0; i < sizeof(ImsiTable); i := i+1) { |
| 797 | if (not ispresent(ImsiTable[i].imsi)) { |
| 798 | ImsiTable[i].imsi := imsi; |
| 799 | ImsiTable[i].tmsi := tmsi; |
| 800 | ImsiTable[i].comp_ref := hdlr; |
| 801 | log("Created IMSI[", i, "] for ", imsi, tmsi, " to be handled at ", hdlr); |
| 802 | return; |
| 803 | } |
| 804 | } |
| 805 | setverdict(fail, "No space left in ImsiTable"); |
| 806 | self.stop; |
| 807 | } |
| 808 | |
| 809 | |
Daniel Willmann | d47106b | 2018-01-17 12:20:56 +0100 | [diff] [blame] | 810 | private function f_expect_table_init() |
| 811 | runs on BSSMAP_Emulation_CT { |
| 812 | for (var integer i := 0; i < sizeof(ExpectTable); i := i+1) { |
| 813 | ExpectTable[i].l3_payload := omit; |
| 814 | } |
| 815 | } |
Harald Welte | 624f963 | 2017-12-16 19:26:04 +0100 | [diff] [blame] | 816 | |
Harald Welte | 17d2115 | 2018-01-27 00:47:11 +0100 | [diff] [blame] | 817 | /* helper function for clients to register their IMSI/TMSI */ |
| 818 | function f_bssmap_register_imsi(hexstring imsi, OCT4 tmsi) |
| 819 | runs on BSSAP_ConnHdlr { |
| 820 | BSSAP_PROC.call(BSSMAPEM_register_imsi:{imsi, tmsi, self}) { |
| 821 | [] BSSAP_PROC.getreply(BSSMAPEM_register_imsi:{?,?,?}) {}; |
| 822 | } |
| 823 | } |
| 824 | |
| 825 | |
Harald Welte | 365f4ed | 2017-11-23 00:00:43 +0100 | [diff] [blame] | 826 | } |