Harald Welte | 6811d10 | 2019-04-14 22:23:14 +0200 | [diff] [blame] | 1 | module RAN_Adapter { |
Harald Welte | 28d943e | 2017-11-25 15:00:50 +0100 | [diff] [blame] | 2 | |
Harald Welte | 6811d10 | 2019-04-14 22:23:14 +0200 | [diff] [blame] | 3 | /* This module implements a 'dumb' RAN adapter. It creates the M3UA and SCCP components and stacks a |
| 4 | * BSSAP/RANAP codec port on top. As a result, it provides the ability to transceive SCCP-User-SAP primitives |
| 5 | * with deoded BSSAP/RANAP payload. Use this if you want to have full control about what you transmit or |
| 6 | * receive, without any automatisms in place. Allows you to refuse connections or other abnormal behavior. */ |
Harald Welte | 28d943e | 2017-11-25 15:00:50 +0100 | [diff] [blame] | 7 | |
Harald Welte | 34b5a95 | 2019-05-27 11:54:11 +0200 | [diff] [blame] | 8 | /* (C) 2017-2019 Harald Welte <laforge@gnumonks.org> |
| 9 | * contributions by sysmocom - s.f.m.c. GmbH |
| 10 | * All rights reserved. |
| 11 | * |
| 12 | * Released under the terms of GNU General Public License, Version 2 or |
| 13 | * (at your option) any later version. |
| 14 | * |
| 15 | * SPDX-License-Identifier: GPL-2.0-or-later |
| 16 | */ |
| 17 | |
Harald Welte | ae02669 | 2017-12-09 01:03:01 +0100 | [diff] [blame] | 18 | import from General_Types all; |
| 19 | import from Osmocom_Types all; |
| 20 | |
Harald Welte | ae02669 | 2017-12-09 01:03:01 +0100 | [diff] [blame] | 21 | import from M3UA_Emulation all; |
| 22 | import from MTP3asp_Types all; |
| 23 | import from MTP3asp_PortType all; |
Harald Welte | 28d943e | 2017-11-25 15:00:50 +0100 | [diff] [blame] | 24 | |
Harald Welte | 7ef51aa | 2018-04-16 19:16:01 +0200 | [diff] [blame] | 25 | import from IPA_Emulation all; |
| 26 | |
Harald Welte | 28d943e | 2017-11-25 15:00:50 +0100 | [diff] [blame] | 27 | import from SCCP_Types all; |
| 28 | import from SCCPasp_Types all; |
| 29 | import from SCCP_Emulation all; |
Stefan Sperling | c307e68 | 2018-06-14 15:15:46 +0200 | [diff] [blame] | 30 | import from SCCP_Templates all; |
Harald Welte | 28d943e | 2017-11-25 15:00:50 +0100 | [diff] [blame] | 31 | |
Harald Welte | ae02669 | 2017-12-09 01:03:01 +0100 | [diff] [blame] | 32 | import from SCTPasp_Types all; |
| 33 | import from SCTPasp_PortType all; |
Harald Welte | 28d943e | 2017-11-25 15:00:50 +0100 | [diff] [blame] | 34 | |
Harald Welte | 3e16b4d | 2019-04-23 17:41:46 +0200 | [diff] [blame] | 35 | #ifdef RAN_EMULATION_BSSAP |
Harald Welte | 28d943e | 2017-11-25 15:00:50 +0100 | [diff] [blame] | 36 | import from BSSMAP_Templates all; |
Harald Welte | 3e16b4d | 2019-04-23 17:41:46 +0200 | [diff] [blame] | 37 | #endif |
Harald Welte | 6811d10 | 2019-04-14 22:23:14 +0200 | [diff] [blame] | 38 | import from RAN_Emulation all; |
Harald Welte | 624f963 | 2017-12-16 19:26:04 +0100 | [diff] [blame] | 39 | |
Harald Welte | 6811d10 | 2019-04-14 22:23:14 +0200 | [diff] [blame] | 40 | type record RAN_Adapter { |
Harald Welte | 28d943e | 2017-11-25 15:00:50 +0100 | [diff] [blame] | 41 | /* component references */ |
Harald Welte | 2e32e43 | 2018-05-24 20:00:00 +0200 | [diff] [blame] | 42 | M3UA_CT vc_M3UA, /* only in 3GPP AoIP */ |
| 43 | IPA_Emulation_CT vc_IPA, /* only in SCCPlite */ |
| 44 | IPA_EventWaiter_CT vc_WAIT, /* only in SCCPlite */ |
Harald Welte | a4ca446 | 2018-02-09 00:17:14 +0100 | [diff] [blame] | 45 | SCCP_CT vc_SCCP, |
Harald Welte | ae02669 | 2017-12-09 01:03:01 +0100 | [diff] [blame] | 46 | |
Harald Welte | a4ca446 | 2018-02-09 00:17:14 +0100 | [diff] [blame] | 47 | MSC_SCCP_MTP3_parameters sccp_pars, |
| 48 | SCCP_PAR_Address sccp_addr_own, |
| 49 | SCCP_PAR_Address sccp_addr_peer, |
Pau Espin Pedrol | ce0d615 | 2019-08-27 19:07:27 +0200 | [diff] [blame] | 50 | RAN_Transport transport, |
Harald Welte | 624f963 | 2017-12-16 19:26:04 +0100 | [diff] [blame] | 51 | |
| 52 | /* handler mode */ |
Harald Welte | 6811d10 | 2019-04-14 22:23:14 +0200 | [diff] [blame] | 53 | RAN_Emulation_CT vc_RAN |
Harald Welte | 28d943e | 2017-11-25 15:00:50 +0100 | [diff] [blame] | 54 | } |
| 55 | |
Harald Welte | 6811d10 | 2019-04-14 22:23:14 +0200 | [diff] [blame] | 56 | type record RAN_Configuration { |
| 57 | RAN_Transport transport, |
Harald Welte | a4ca446 | 2018-02-09 00:17:14 +0100 | [diff] [blame] | 58 | charstring sccp_service_type, |
| 59 | SCTP_Association_Address sctp_addr, |
| 60 | integer own_pc, |
| 61 | integer own_ssn, |
| 62 | integer peer_pc, |
| 63 | integer peer_ssn, |
Philipp Maier | 7593298 | 2018-03-27 14:52:35 +0200 | [diff] [blame] | 64 | octetstring sio, |
| 65 | integer rctx |
Harald Welte | a4ca446 | 2018-02-09 00:17:14 +0100 | [diff] [blame] | 66 | }; |
Neels Hofmeyr | 7985aeb | 2020-05-12 16:07:55 +0200 | [diff] [blame] | 67 | type record of RAN_Configuration RAN_Configurations; |
Harald Welte | 28d943e | 2017-11-25 15:00:50 +0100 | [diff] [blame] | 68 | |
Harald Welte | 6811d10 | 2019-04-14 22:23:14 +0200 | [diff] [blame] | 69 | private function init_pars(inout RAN_Adapter ba, in RAN_Configuration cfg) { |
Harald Welte | a4ca446 | 2018-02-09 00:17:14 +0100 | [diff] [blame] | 70 | ba.sccp_pars := { |
Harald Welte | ae02669 | 2017-12-09 01:03:01 +0100 | [diff] [blame] | 71 | sio := { |
Harald Welte | a4ca446 | 2018-02-09 00:17:14 +0100 | [diff] [blame] | 72 | ni := substr(oct2bit(cfg.sio),0,2), |
| 73 | prio := substr(oct2bit(cfg.sio),2,2), |
| 74 | si := substr(oct2bit(cfg.sio),4,4) |
Harald Welte | ae02669 | 2017-12-09 01:03:01 +0100 | [diff] [blame] | 75 | }, |
Harald Welte | a4ca446 | 2018-02-09 00:17:14 +0100 | [diff] [blame] | 76 | opc := cfg.own_pc, |
| 77 | dpc := cfg.peer_pc, |
Harald Welte | ae02669 | 2017-12-09 01:03:01 +0100 | [diff] [blame] | 78 | sls := 0, |
Harald Welte | a4ca446 | 2018-02-09 00:17:14 +0100 | [diff] [blame] | 79 | sccp_serviceType := cfg.sccp_service_type, |
| 80 | ssn := cfg.own_ssn |
Harald Welte | ae02669 | 2017-12-09 01:03:01 +0100 | [diff] [blame] | 81 | }; |
Harald Welte | a4ca446 | 2018-02-09 00:17:14 +0100 | [diff] [blame] | 82 | ba.sccp_addr_own := valueof(ts_SccpAddr_PC_SSN(cfg.own_pc, cfg.own_ssn, cfg.sio, cfg.sccp_service_type)); |
| 83 | ba.sccp_addr_peer := valueof(ts_SccpAddr_PC_SSN(cfg.peer_pc, cfg.peer_ssn, cfg.sio, cfg.sccp_service_type)); |
Pau Espin Pedrol | ce0d615 | 2019-08-27 19:07:27 +0200 | [diff] [blame] | 84 | ba.transport := cfg.transport; |
Harald Welte | ae02669 | 2017-12-09 01:03:01 +0100 | [diff] [blame] | 85 | } |
| 86 | |
| 87 | |
Harald Welte | 3ca0ce1 | 2019-04-23 17:18:48 +0200 | [diff] [blame] | 88 | function f_ran_adapter_init(inout RAN_Adapter ba, in RAN_Configuration cfg, charstring id, |
Harald Welte | 6811d10 | 2019-04-14 22:23:14 +0200 | [diff] [blame] | 89 | template RanOps ops) { |
Harald Welte | a4ca446 | 2018-02-09 00:17:14 +0100 | [diff] [blame] | 90 | init_pars(ba, cfg); |
| 91 | ops.sccp_addr_local := ba.sccp_addr_own; |
| 92 | ops.sccp_addr_peer := ba.sccp_addr_peer; |
Harald Welte | ae02669 | 2017-12-09 01:03:01 +0100 | [diff] [blame] | 93 | |
Harald Welte | 28d943e | 2017-11-25 15:00:50 +0100 | [diff] [blame] | 94 | /* create components */ |
Harald Welte | a4ca446 | 2018-02-09 00:17:14 +0100 | [diff] [blame] | 95 | ba.vc_SCCP := SCCP_CT.create(id & "-SCCP"); |
Oliver Smith | 0d7b7ab | 2019-08-19 13:04:18 +0200 | [diff] [blame] | 96 | if (isvalue(ops)) { |
Harald Welte | 6811d10 | 2019-04-14 22:23:14 +0200 | [diff] [blame] | 97 | ba.vc_RAN := RAN_Emulation_CT.create(id & "-RAN"); |
Pau Espin Pedrol | ce0d615 | 2019-08-27 19:07:27 +0200 | [diff] [blame] | 98 | } else { |
| 99 | ba.vc_RAN := null; |
Harald Welte | 624f963 | 2017-12-16 19:26:04 +0100 | [diff] [blame] | 100 | } |
Harald Welte | 7ef51aa | 2018-04-16 19:16:01 +0200 | [diff] [blame] | 101 | select (cfg.transport) { |
Harald Welte | 5b02762 | 2019-04-14 23:40:17 +0200 | [diff] [blame] | 102 | case (BSSAP_TRANSPORT_AoIP, RANAP_TRANSPORT_IuCS) { |
Harald Welte | 843917e | 2023-04-15 02:54:34 +0800 | [diff] [blame] | 103 | var template (omit) integer rctx; |
| 104 | if (not ispresent(cfg.rctx)) { |
| 105 | rctx := omit; |
| 106 | } else { |
| 107 | rctx := cfg.rctx; |
| 108 | } |
Harald Welte | 7ef51aa | 2018-04-16 19:16:01 +0200 | [diff] [blame] | 109 | ba.vc_M3UA := M3UA_CT.create(id & "-M3UA"); |
| 110 | map(ba.vc_M3UA:SCTP_PORT, system:sctp); |
| 111 | /* connect MTP3 service provider (M3UA) to lower side of SCCP */ |
| 112 | connect(ba.vc_M3UA:MTP3_SP_PORT, ba.vc_SCCP:MTP3_SCCP_PORT); |
Harald Welte | 843917e | 2023-04-15 02:54:34 +0800 | [diff] [blame] | 113 | ba.vc_M3UA.start(f_M3UA_Emulation(cfg.sctp_addr, rctx)); |
Harald Welte | 7ef51aa | 2018-04-16 19:16:01 +0200 | [diff] [blame] | 114 | } |
Harald Welte | 3e16b4d | 2019-04-23 17:41:46 +0200 | [diff] [blame] | 115 | #ifdef IPA_EMULATION_SCCP |
Harald Welte | 7ef51aa | 2018-04-16 19:16:01 +0200 | [diff] [blame] | 116 | case (BSSAP_TRANSPORT_SCCPlite_SERVER) { |
| 117 | ba.vc_IPA := IPA_Emulation_CT.create(id & "-IPA"); |
| 118 | map(ba.vc_IPA:IPA_PORT, system:IPA_CODEC_PT); |
| 119 | /* connect MTP3 service provider (IPA) to lower side of SCCP */ |
| 120 | connect(ba.vc_IPA:MTP3_SP_PORT, ba.vc_SCCP:MTP3_SCCP_PORT); |
Harald Welte | 2e32e43 | 2018-05-24 20:00:00 +0200 | [diff] [blame] | 121 | /* connect waiter to general IPA port (for ASP_IPA_Event) */ |
| 122 | ba.vc_WAIT := IPA_EventWaiter_CT.create(id & "-IPA-WAIT"); |
| 123 | connect(ba.vc_IPA:IPA_SP_PORT, ba.vc_WAIT:IPA_SP_PORT); |
| 124 | ba.vc_WAIT.start(IPA_Emulation.waiter_main()); |
Harald Welte | 7ef51aa | 2018-04-16 19:16:01 +0200 | [diff] [blame] | 125 | ba.vc_IPA.start(IPA_Emulation.main_server(cfg.sctp_addr.local_ip_addr, |
Neels Hofmeyr | 3bf31d2 | 2018-08-24 14:44:32 +0200 | [diff] [blame] | 126 | cfg.sctp_addr.local_sctp_port, |
| 127 | true, IPA_INIT_SEND_IPA_ID_ACK)); |
Harald Welte | 2e32e43 | 2018-05-24 20:00:00 +0200 | [diff] [blame] | 128 | /* wait until we received an IPA CCM ID_ACK */ |
| 129 | ba.vc_WAIT.done; |
| 130 | disconnect(ba.vc_IPA:IPA_SP_PORT, ba.vc_WAIT:IPA_SP_PORT); |
Harald Welte | 7ef51aa | 2018-04-16 19:16:01 +0200 | [diff] [blame] | 131 | } |
| 132 | case (BSSAP_TRANSPORT_SCCPlite_CLIENT) { |
| 133 | ba.vc_IPA := IPA_Emulation_CT.create(id & "-IPA"); |
| 134 | map(ba.vc_IPA:IPA_PORT, system:IPA_CODEC_PT); |
| 135 | /* connect MTP3 service provider (IPA) to lower side of SCCP */ |
| 136 | connect(ba.vc_IPA:MTP3_SP_PORT, ba.vc_SCCP:MTP3_SCCP_PORT); |
Harald Welte | 2e32e43 | 2018-05-24 20:00:00 +0200 | [diff] [blame] | 137 | /* connect waiter to general IPA port (for ASP_IPA_Event) */ |
| 138 | ba.vc_WAIT := IPA_EventWaiter_CT.create(id & "-IPA-WAIT"); |
| 139 | connect(ba.vc_IPA:IPA_SP_PORT, ba.vc_WAIT:IPA_SP_PORT); |
| 140 | ba.vc_WAIT.start(IPA_Emulation.waiter_main()); |
Harald Welte | 7ef51aa | 2018-04-16 19:16:01 +0200 | [diff] [blame] | 141 | ba.vc_IPA.start(IPA_Emulation.main_client(cfg.sctp_addr.remote_ip_addr, |
| 142 | cfg.sctp_addr.remote_sctp_port, |
| 143 | cfg.sctp_addr.local_ip_addr, |
| 144 | cfg.sctp_addr.local_sctp_port)); |
Harald Welte | 2e32e43 | 2018-05-24 20:00:00 +0200 | [diff] [blame] | 145 | /* wait until we received an IPA CCM ID_ACK */ |
| 146 | ba.vc_WAIT.done; |
| 147 | disconnect(ba.vc_IPA:IPA_SP_PORT, ba.vc_WAIT:IPA_SP_PORT); |
Harald Welte | 7ef51aa | 2018-04-16 19:16:01 +0200 | [diff] [blame] | 148 | } |
Harald Welte | 3e16b4d | 2019-04-23 17:41:46 +0200 | [diff] [blame] | 149 | #endif /* SCCP */ |
Harald Welte | 7ef51aa | 2018-04-16 19:16:01 +0200 | [diff] [blame] | 150 | case else { |
Harald Welte | 6811d10 | 2019-04-14 22:23:14 +0200 | [diff] [blame] | 151 | setverdict(fail, "Unsuppored RAN_Transport"); |
Daniel Willmann | e4ff537 | 2018-07-05 17:35:03 +0200 | [diff] [blame] | 152 | mtc.stop; |
Harald Welte | 7ef51aa | 2018-04-16 19:16:01 +0200 | [diff] [blame] | 153 | } |
| 154 | } |
Harald Welte | 28d943e | 2017-11-25 15:00:50 +0100 | [diff] [blame] | 155 | |
Oliver Smith | 0d7b7ab | 2019-08-19 13:04:18 +0200 | [diff] [blame] | 156 | if (isvalue(ops)) { |
Harald Welte | b0ec4ee | 2018-01-21 13:53:17 +0100 | [diff] [blame] | 157 | timer T := 5.0; |
| 158 | T.start; |
Harald Welte | a4ca446 | 2018-02-09 00:17:14 +0100 | [diff] [blame] | 159 | //T.timeout; |
Pau Espin Pedrol | c6b78ff | 2019-06-06 15:58:17 +0200 | [diff] [blame] | 160 | ops.transport := cfg.transport; |
Harald Welte | 710ec21 | 2018-05-27 15:07:32 +0200 | [diff] [blame] | 161 | /* connect BSSNAP component to upper side of SCCP */ |
Harald Welte | 5b02762 | 2019-04-14 23:40:17 +0200 | [diff] [blame] | 162 | if (cfg.transport == RANAP_TRANSPORT_IuCS) { |
| 163 | #ifdef RAN_EMULATION_RANAP |
Harald Welte | bc04327 | 2019-05-02 12:00:16 +0200 | [diff] [blame] | 164 | log("Connecting RANAP RAN_Emulation to SCCP_SP_PORT"); |
Harald Welte | 5b02762 | 2019-04-14 23:40:17 +0200 | [diff] [blame] | 165 | ops.protocol := RAN_PROTOCOL_RANAP |
| 166 | connect(ba.vc_RAN:RANAP, ba.vc_SCCP:SCCP_SP_PORT); |
Harald Welte | 2fce788 | 2019-04-15 11:48:05 +0200 | [diff] [blame] | 167 | #endif |
Harald Welte | 5b02762 | 2019-04-14 23:40:17 +0200 | [diff] [blame] | 168 | } else { |
| 169 | #ifdef RAN_EMULATION_BSSAP |
Harald Welte | bc04327 | 2019-05-02 12:00:16 +0200 | [diff] [blame] | 170 | log("Connecting BSSAP RAN_Emulation to SCCP_SP_PORT"); |
Harald Welte | 5b02762 | 2019-04-14 23:40:17 +0200 | [diff] [blame] | 171 | connect(ba.vc_RAN:BSSAP, ba.vc_SCCP:SCCP_SP_PORT); |
| 172 | #endif |
| 173 | } |
Harald Welte | 4239918 | 2018-05-27 15:07:14 +0200 | [diff] [blame] | 174 | if (cfg.transport == BSSAP_TRANSPORT_SCCPlite_SERVER or |
| 175 | cfg.transport == BSSAP_TRANSPORT_SCCPlite_CLIENT) { |
Harald Welte | 3e16b4d | 2019-04-23 17:41:46 +0200 | [diff] [blame] | 176 | #ifdef IPA_EMULATION_MGCP |
Harald Welte | 4239918 | 2018-05-27 15:07:14 +0200 | [diff] [blame] | 177 | /* connect IPA MGCP port with BSSMAP MGCP port */ |
Harald Welte | bc04327 | 2019-05-02 12:00:16 +0200 | [diff] [blame] | 178 | log("Connecting MGCP RAN Emulation to IPA MGCP PORT"); |
Harald Welte | 6811d10 | 2019-04-14 22:23:14 +0200 | [diff] [blame] | 179 | connect(ba.vc_IPA:IPA_MGCP_PORT, ba.vc_RAN:MGCP); |
Harald Welte | 3e16b4d | 2019-04-23 17:41:46 +0200 | [diff] [blame] | 180 | #endif |
Pau Espin Pedrol | 4d0e5e5 | 2019-06-07 19:38:28 +0200 | [diff] [blame] | 181 | #ifdef IPA_EMULATION_CTRL |
Alexander Couzens | d7b2950 | 2019-07-22 21:08:59 +0200 | [diff] [blame] | 182 | #ifdef RAN_EMULATION_CTRL |
Pau Espin Pedrol | 4d0e5e5 | 2019-06-07 19:38:28 +0200 | [diff] [blame] | 183 | /* connect IPA CTRL port with BSSMAP CTRL port */ |
| 184 | log("Connecting CTRL RAN Emulation to IPA CTRL PORT"); |
| 185 | connect(ba.vc_IPA:IPA_CTRL_PORT, ba.vc_RAN:CTRL); |
| 186 | #endif |
Alexander Couzens | d7b2950 | 2019-07-22 21:08:59 +0200 | [diff] [blame] | 187 | #endif |
Harald Welte | 4239918 | 2018-05-27 15:07:14 +0200 | [diff] [blame] | 188 | } |
Harald Welte | bc04327 | 2019-05-02 12:00:16 +0200 | [diff] [blame] | 189 | log("Starting RAN_Emulation"); |
Harald Welte | 6811d10 | 2019-04-14 22:23:14 +0200 | [diff] [blame] | 190 | ba.vc_RAN.start(RAN_Emulation.main(valueof(ops), "")); |
Harald Welte | ae02669 | 2017-12-09 01:03:01 +0100 | [diff] [blame] | 191 | } |
Harald Welte | 2e32e43 | 2018-05-24 20:00:00 +0200 | [diff] [blame] | 192 | |
Harald Welte | 2e32e43 | 2018-05-24 20:00:00 +0200 | [diff] [blame] | 193 | |
Harald Welte | ae02669 | 2017-12-09 01:03:01 +0100 | [diff] [blame] | 194 | } |
| 195 | |
Harald Welte | 3ca0ce1 | 2019-04-23 17:18:48 +0200 | [diff] [blame] | 196 | function f_ran_adapter_start(inout RAN_Adapter ba) { |
Harald Welte | d5833a8 | 2018-05-27 16:52:56 +0200 | [diff] [blame] | 197 | ba.vc_SCCP.start(SCCPStart(ba.sccp_pars)); |
| 198 | } |
| 199 | |
Pau Espin Pedrol | ce0d615 | 2019-08-27 19:07:27 +0200 | [diff] [blame] | 200 | function f_ran_adapter_cleanup(inout RAN_Adapter ba) { |
| 201 | if (ba.vc_RAN != null) { |
| 202 | if (ba.transport == RANAP_TRANSPORT_IuCS) { |
| 203 | #ifdef RAN_EMULATION_RANAP |
| 204 | disconnect(ba.vc_RAN:RANAP, ba.vc_SCCP:SCCP_SP_PORT); |
| 205 | #endif |
| 206 | } else { |
| 207 | #ifdef RAN_EMULATION_BSSAP |
| 208 | disconnect(ba.vc_RAN:BSSAP, ba.vc_SCCP:SCCP_SP_PORT); |
| 209 | #endif |
| 210 | } |
| 211 | ba.vc_RAN.stop; |
| 212 | } |
| 213 | if (ba.transport == BSSAP_TRANSPORT_AoIP or |
| 214 | ba.transport == RANAP_TRANSPORT_IuCS) { |
| 215 | unmap(ba.vc_M3UA:SCTP_PORT, system:sctp); |
| 216 | disconnect(ba.vc_M3UA:MTP3_SP_PORT, ba.vc_SCCP:MTP3_SCCP_PORT); |
| 217 | ba.vc_M3UA.stop; |
| 218 | } |
| 219 | ba.vc_SCCP.stop; |
| 220 | } |
| 221 | |
Harald Welte | ae02669 | 2017-12-09 01:03:01 +0100 | [diff] [blame] | 222 | |
Harald Welte | 28d943e | 2017-11-25 15:00:50 +0100 | [diff] [blame] | 223 | } |