Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 1 | module IPA_Emulation { |
| 2 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 3 | /* This module implements the IPA multiplex protocol on top of TCP, using the IPL4asp |
| 4 | * test-port as provider. It implements both client and server roles, as well was the CCM |
Pau Espin Pedrol | 76ba541 | 2019-06-10 11:00:33 +0200 | [diff] [blame] | 5 | * handshake for establishing the identity of the client to the server. |
Harald Welte | 35bb716 | 2018-01-03 21:07:52 +0100 | [diff] [blame] | 6 | * |
| 7 | * It already knows certain well-known sub-protocols such as A-bis RSL, MGCP and SCCP and |
| 8 | * GSUP. IT hence transcodes messages so the user can work with abstract data types rather |
| 9 | * than binary messages. It handles multiple packets inside one TCP segment. |
| 10 | * |
Harald Welte | 34b5a95 | 2019-05-27 11:54:11 +0200 | [diff] [blame] | 11 | * (C) 2017-2019 by Harald Welte <laforge@gnumonks.org> |
| 12 | * contributions by sysmocom - s.f.m.c. GmbH |
Harald Welte | 35bb716 | 2018-01-03 21:07:52 +0100 | [diff] [blame] | 13 | * All rights reserved. |
| 14 | * |
| 15 | * Released under the terms of GNU General Public License, Version 2 or |
| 16 | * (at your option) any later version. |
Harald Welte | 34b5a95 | 2019-05-27 11:54:11 +0200 | [diff] [blame] | 17 | * |
| 18 | * SPDX-License-Identifier: GPL-2.0-or-later |
Harald Welte | 35bb716 | 2018-01-03 21:07:52 +0100 | [diff] [blame] | 19 | */ |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 20 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 21 | import from IPA_Types all; |
| 22 | import from IPA_CodecPort all; |
| 23 | import from IPA_CodecPort_CtrlFunct all; |
| 24 | import from IPL4asp_Types all; |
Harald Welte | 1218883 | 2017-11-29 11:47:13 +0100 | [diff] [blame] | 25 | import from IPL4asp_PortType all; |
Stefan Sperling | 830dc9d | 2018-02-12 21:08:28 +0100 | [diff] [blame] | 26 | import from Socket_API_Definitions all; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 27 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 28 | #ifdef IPA_EMULATION_SCCP |
| 29 | import from MTP3asp_Types all; |
| 30 | import from MTP3asp_PortType all; |
| 31 | #endif |
| 32 | |
| 33 | #ifdef IPA_EMULATION_RSL |
| 34 | import from RSL_Types all; |
| 35 | #endif |
| 36 | |
Harald Welte | c682666 | 2019-02-06 22:26:46 +0100 | [diff] [blame] | 37 | #ifdef IPA_EMULATION_OML |
| 38 | import from AbisOML_Types all; |
| 39 | #endif |
| 40 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 41 | #ifdef IPA_EMULATION_MGCP |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 42 | import from MGCP_Types all; |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 43 | #endif |
| 44 | |
| 45 | #ifdef IPA_EMULATION_GSUP |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 46 | import from GSUP_Types all; |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 47 | #endif |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 48 | |
Harald Welte | 7460a72 | 2018-10-10 12:28:27 +0200 | [diff] [blame] | 49 | #ifdef IPA_EMULATION_RSPRO |
| 50 | import from RSPRO all; |
| 51 | import from RSPRO_Types all; |
| 52 | #endif |
| 53 | |
Harald Welte | 3286eb3 | 2019-08-18 19:36:10 +0200 | [diff] [blame] | 54 | #ifdef IPA_EMULATION_CTRL |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 55 | import from Osmocom_CTRL_Types all; |
Harald Welte | 3286eb3 | 2019-08-18 19:36:10 +0200 | [diff] [blame] | 56 | #endif |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 57 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 58 | modulepar { |
Harald Welte | 92632e1 | 2017-11-25 02:31:20 +0100 | [diff] [blame] | 59 | /* Use Osmocom extended IPA mux header */ |
| 60 | boolean mp_ipa_mgcp_uses_osmo_ext := true; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 61 | } |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 62 | |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 63 | type enumerated IpaMode { |
| 64 | IPA_MODE_CLIENT, |
| 65 | IPA_MODE_SERVER |
| 66 | } |
| 67 | |
Neels Hofmeyr | 3bf31d2 | 2018-08-24 14:44:32 +0200 | [diff] [blame] | 68 | type enumerated IpaInitBehavior { |
| 69 | IPA_INIT_SEND_IPA_ID_GET, |
| 70 | IPA_INIT_SEND_IPA_ID_ACK |
| 71 | } |
| 72 | |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 73 | type record ASP_IPA_Unitdata { |
| 74 | IpaStreamId streamId, |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 75 | IpaExtStreamId streamIdExt optional, |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 76 | octetstring payload |
| 77 | } |
| 78 | |
Vadim Yanitskiy | 8701b27 | 2020-05-18 20:17:25 +0700 | [diff] [blame] | 79 | type enumerated ASP_IPA_EventType { |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 80 | ASP_IPA_EVENT_DOWN, |
| 81 | ASP_IPA_EVENT_UP, |
| 82 | ASP_IPA_EVENT_ID_ACK |
| 83 | } |
| 84 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 85 | /* an event indicating us whether or not a connection is physically up or down, |
| 86 | * and whether we have received an ID_ACK */ |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 87 | type union ASP_IPA_Event { |
Vadim Yanitskiy | 8701b27 | 2020-05-18 20:17:25 +0700 | [diff] [blame] | 88 | ASP_IPA_EventType up_down |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 89 | } |
| 90 | |
Vadim Yanitskiy | 61564be | 2020-05-18 20:44:14 +0700 | [diff] [blame] | 91 | template (value) ASP_IPA_Event ts_ASP_IPA_EV(ASP_IPA_EventType ud) := { |
| 92 | up_down := ud |
| 93 | } |
| 94 | |
| 95 | template ASP_IPA_Event tr_ASP_IPA_EV(template ASP_IPA_EventType ud) := { |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 96 | up_down := ud |
| 97 | } |
| 98 | |
Harald Welte | 1dd8f37 | 2017-11-25 02:25:27 +0100 | [diff] [blame] | 99 | template ASP_IPA_Unitdata t_ASP_IPA_UD(IpaStreamId sid, octetstring pl, |
| 100 | template IpaExtStreamId esid := omit) := { |
| 101 | streamId := sid, |
| 102 | streamIdExt := esid, |
| 103 | payload := pl |
| 104 | } |
| 105 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 106 | #ifdef IPA_EMULATION_RSL |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 107 | /* like ASP_IPA_Unitdata, but with RSL_Message abstract type instead of octetstring */ |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 108 | type record ASP_RSL_Unitdata { |
| 109 | IpaStreamId streamId, |
| 110 | RSL_Message rsl |
| 111 | }; |
| 112 | |
Vadim Yanitskiy | 6b4856d | 2020-05-25 21:23:46 +0700 | [diff] [blame^] | 113 | template (value) ASP_RSL_Unitdata ts_ASP_RSL_UD(IpaStreamId sid, template (value) RSL_Message rsl) := { |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 114 | streamId := sid, |
Vadim Yanitskiy | 6b4856d | 2020-05-25 21:23:46 +0700 | [diff] [blame^] | 115 | rsl := rsl |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 116 | } |
| 117 | |
Vadim Yanitskiy | 6b4856d | 2020-05-25 21:23:46 +0700 | [diff] [blame^] | 118 | template ASP_RSL_Unitdata tr_ASP_RSL_UD(template IpaStreamId sid, template RSL_Message rsl) := { |
Harald Welte | 7ae019e | 2017-12-09 00:54:15 +0100 | [diff] [blame] | 119 | streamId := sid, |
| 120 | rsl := rsl |
| 121 | } |
| 122 | |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 123 | template IpaStreamId t_IpaSidRSL := ( IPAC_PROTO_RSL_TRX0, IPAC_PROTO_RSL_TRX1, |
| 124 | IPAC_PROTO_RSL_TRX2, IPAC_PROTO_RSL_TRX3 ); |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 125 | #endif |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 126 | |
Harald Welte | c682666 | 2019-02-06 22:26:46 +0100 | [diff] [blame] | 127 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 128 | /* Client port for general IPA messages, not further decoded */ |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 129 | type port IPA_SP_PT message { |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 130 | inout ASP_IPA_Unitdata, ASP_IPA_Event; |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 131 | } with { extension "internal" } |
| 132 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 133 | #ifdef IPA_EMULATION_MGCP |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 134 | /* Client port for MGCP inside IPA */ |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 135 | type port IPA_MGCP_PT message { |
| 136 | inout MgcpCommand, MgcpResponse; |
| 137 | } with { extension "internal" } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 138 | #endif |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 139 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 140 | #ifdef IPA_EMULATION_RSL |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 141 | /* Client port for A-bis RSL inside IPA */ |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 142 | type port IPA_RSL_PT message { |
| 143 | inout ASP_RSL_Unitdata, ASP_IPA_Event; |
| 144 | } with { extension "internal" } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 145 | #endif |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 146 | |
Harald Welte | c682666 | 2019-02-06 22:26:46 +0100 | [diff] [blame] | 147 | #ifdef IPA_EMULATION_OML |
| 148 | /* Client port for A-bis OML inside IPA */ |
| 149 | type port IPA_OML_PT message { |
| 150 | inout OML_PDU, octetstring, ASP_IPA_Event; |
| 151 | } with { extension "internal" } |
| 152 | #endif |
| 153 | |
Harald Welte | 3286eb3 | 2019-08-18 19:36:10 +0200 | [diff] [blame] | 154 | #ifdef IPA_EMULATION_CTRL |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 155 | /* Client port for CTRL inside IPA */ |
| 156 | type port IPA_CTRL_PT message { |
| 157 | inout CtrlMessage, ASP_IPA_Event; |
| 158 | } with { extension "internal" } |
Harald Welte | 3286eb3 | 2019-08-18 19:36:10 +0200 | [diff] [blame] | 159 | #endif |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 160 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 161 | #ifdef IPA_EMULATION_GSUP |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 162 | /* Client port for CTRL inside IPA */ |
| 163 | type port IPA_GSUP_PT message { |
| 164 | inout GSUP_PDU, ASP_IPA_Event; |
| 165 | } with { extension "internal" } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 166 | #endif |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 167 | |
Harald Welte | 7460a72 | 2018-10-10 12:28:27 +0200 | [diff] [blame] | 168 | #ifdef IPA_EMULATION_RSPRO |
| 169 | type port IPA_RSPRO_PT message { |
| 170 | inout RsproPDU, ASP_IPA_Event; |
| 171 | } with { extension "internal" } |
| 172 | #endif |
| 173 | |
| 174 | |
| 175 | |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 176 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 177 | type component IPA_Emulation_CT { |
| 178 | /* down-facing port to IPA codec port */ |
| 179 | port IPA_CODEC_PT IPA_PORT; |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 180 | #ifdef IPA_EMULATION_SCCP |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 181 | /* up-facing port to SCCP */ |
| 182 | port MTP3asp_SP_PT MTP3_SP_PORT; |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 183 | #endif |
| 184 | #ifdef IPA_EMULATION_MGCP |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 185 | /* up-facing port for MGCP */ |
| 186 | port IPA_MGCP_PT IPA_MGCP_PORT; |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 187 | #endif |
| 188 | #ifdef IPA_EMULATION_RSL |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 189 | /* up-facing port for RSL */ |
| 190 | port IPA_RSL_PT IPA_RSL_PORT; |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 191 | #endif |
Harald Welte | c682666 | 2019-02-06 22:26:46 +0100 | [diff] [blame] | 192 | #ifdef IPA_EMULATION_OML |
| 193 | /* up-facing port for OML */ |
| 194 | port IPA_OML_PT IPA_OML_PORT; |
| 195 | #endif |
Pau Espin Pedrol | acc5119 | 2019-06-11 15:35:19 +0200 | [diff] [blame] | 196 | #ifdef IPA_EMULATION_CTRL |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 197 | /* up-facing port for CTRL */ |
| 198 | port IPA_CTRL_PT IPA_CTRL_PORT; |
Pau Espin Pedrol | acc5119 | 2019-06-11 15:35:19 +0200 | [diff] [blame] | 199 | #endif |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 200 | #ifdef IPA_EMULATION_GSUP |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 201 | /* up-facing port for GSUP */ |
| 202 | port IPA_GSUP_PT IPA_GSUP_PORT; |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 203 | #endif |
Harald Welte | 7460a72 | 2018-10-10 12:28:27 +0200 | [diff] [blame] | 204 | #ifdef IPA_EMULATION_RSPRO |
| 205 | /* up-facing port for RSPRO */ |
| 206 | port IPA_RSPRO_PT IPA_RSPRO_PORT; |
| 207 | #endif |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 208 | |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 209 | /* up-facing port for other streams */ |
| 210 | port IPA_SP_PT IPA_SP_PORT; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 211 | |
| 212 | var boolean g_initialized := false; |
Stefan Sperling | 830dc9d | 2018-02-12 21:08:28 +0100 | [diff] [blame] | 213 | var IPL4asp_Types.ConnectionId g_ipa_conn_id := -1; |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 214 | /* Are we a BSC/MGW (truel) or MSC (false) */ |
| 215 | var boolean g_is_bsc_mgw; |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 216 | |
| 217 | var IpaMode g_mode; |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 218 | var boolean g_ccm_enabled; |
Neels Hofmeyr | 3bf31d2 | 2018-08-24 14:44:32 +0200 | [diff] [blame] | 219 | var IpaInitBehavior g_init_behavior; |
Harald Welte | e09921f | 2017-12-07 17:49:00 +0100 | [diff] [blame] | 220 | var IPA_CCM_Parameters g_ccm_pars := c_IPA_default_ccm_pars; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 221 | } |
| 222 | |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 223 | type record IPA_CCM_Parameters { |
| 224 | charstring ser_nr optional, |
| 225 | charstring name optional, |
| 226 | charstring location1 optional, |
| 227 | charstring location2 optional, |
| 228 | charstring equip_version optional, |
| 229 | charstring sw_version optional, |
| 230 | charstring ip_addr optional, |
| 231 | charstring mac_addr optional, |
| 232 | charstring unit_id optional, |
| 233 | charstring osmo_rand optional |
| 234 | } |
| 235 | |
Harald Welte | e09921f | 2017-12-07 17:49:00 +0100 | [diff] [blame] | 236 | const IPA_CCM_Parameters c_IPA_default_ccm_pars := { |
| 237 | ser_nr := "", |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 238 | name := "mahlzeit", |
Harald Welte | e09921f | 2017-12-07 17:49:00 +0100 | [diff] [blame] | 239 | location1 := "", |
| 240 | location2 := "", |
| 241 | equip_version := "", |
| 242 | sw_version := "", |
| 243 | ip_addr := "", |
| 244 | mac_addr := "", |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 245 | unit_id := "0/1/2", |
Harald Welte | e09921f | 2017-12-07 17:49:00 +0100 | [diff] [blame] | 246 | osmo_rand := "" |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 247 | }; |
| 248 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 249 | /* Function to use to connect as client to a remote IPA Server */ |
Stefan Sperling | 830dc9d | 2018-02-12 21:08:28 +0100 | [diff] [blame] | 250 | function f_connect(charstring remote_host, IPL4asp_Types.PortNumber remote_port, |
| 251 | charstring local_host, IPL4asp_Types.PortNumber local_port, |
Harald Welte | e09921f | 2017-12-07 17:49:00 +0100 | [diff] [blame] | 252 | IPA_CCM_Parameters ccm_pars := c_IPA_default_ccm_pars) runs on IPA_Emulation_CT { |
Stefan Sperling | 830dc9d | 2018-02-12 21:08:28 +0100 | [diff] [blame] | 253 | var IPL4asp_Types.Result res; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 254 | res := IPA_CodecPort_CtrlFunct.f_IPL4_connect(IPA_PORT, remote_host, remote_port, |
| 255 | local_host, local_port, 0, { tcp:={} }); |
Harald Welte | 9220f63 | 2018-05-23 20:27:02 +0200 | [diff] [blame] | 256 | if (not ispresent(res.connId)) { |
Stefan Sperling | 6a90be4 | 2018-08-31 15:05:39 +0200 | [diff] [blame] | 257 | setverdict(fail, "Could not connect IPA socket from ", local_host, " port ", local_port, |
| 258 | " to ", remote_host, " port ", remote_port, "; check your configuration"); |
Daniel Willmann | e4ff537 | 2018-07-05 17:35:03 +0200 | [diff] [blame] | 259 | mtc.stop; |
Harald Welte | 9220f63 | 2018-05-23 20:27:02 +0200 | [diff] [blame] | 260 | } |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 261 | g_ipa_conn_id := res.connId; |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 262 | g_ccm_pars := ccm_pars; |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 263 | g_is_bsc_mgw := true; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 264 | } |
| 265 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 266 | /* Function to use to bind to a local port as IPA server, accepting remote clients */ |
Stefan Sperling | 830dc9d | 2018-02-12 21:08:28 +0100 | [diff] [blame] | 267 | function f_bind(charstring local_host, IPL4asp_Types.PortNumber local_port, |
Harald Welte | e09921f | 2017-12-07 17:49:00 +0100 | [diff] [blame] | 268 | IPA_CCM_Parameters ccm_pars := c_IPA_default_ccm_pars) runs on IPA_Emulation_CT { |
Stefan Sperling | 830dc9d | 2018-02-12 21:08:28 +0100 | [diff] [blame] | 269 | var IPL4asp_Types.Result res; |
Pau Espin Pedrol | 76ba541 | 2019-06-10 11:00:33 +0200 | [diff] [blame] | 270 | res := IPA_CodecPort_CtrlFunct.f_IPL4_listen(IPA_PORT, |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 271 | local_host, local_port, { tcp:={} }); |
Harald Welte | 9220f63 | 2018-05-23 20:27:02 +0200 | [diff] [blame] | 272 | if (not ispresent(res.connId)) { |
Max | b7aae8b | 2019-03-11 15:22:02 +0100 | [diff] [blame] | 273 | setverdict(fail, "Could not listen IPA socket ", local_host, ":", local_port, ", check your configuration"); |
Daniel Willmann | e4ff537 | 2018-07-05 17:35:03 +0200 | [diff] [blame] | 274 | mtc.stop; |
Harald Welte | 9220f63 | 2018-05-23 20:27:02 +0200 | [diff] [blame] | 275 | } |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 276 | g_ipa_conn_id := res.connId; |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 277 | g_ccm_pars := ccm_pars; |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 278 | g_is_bsc_mgw := false; |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 279 | } |
| 280 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 281 | #ifdef IPA_EMULATION_SCCP |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 282 | template ASP_MTP3_TRANSFERind ts_MTP3_XFER_ind(integer opc, octetstring data) := { |
| 283 | sio := { '10'B, '00'B, '0011'B }, |
| 284 | opc := opc, |
| 285 | dpc := 0, |
| 286 | sls := 0, |
| 287 | data := data |
| 288 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 289 | #endif |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 290 | |
| 291 | |
| 292 | private template IpaCcmRespPart t_IdRespPart(IpaCcmIdTag tag, charstring payload) := { |
| 293 | len := 0, /* overwritten by codec */ |
| 294 | tag := tag, |
Harald Welte | 95686e0 | 2018-08-02 15:05:43 +0200 | [diff] [blame] | 295 | data := char2oct(payload) & '00'O |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 296 | } |
| 297 | |
Vadim Yanitskiy | 61564be | 2020-05-18 20:44:14 +0700 | [diff] [blame] | 298 | private function f_send_IPA_EVT(template (value) ASP_IPA_Event evt) runs on IPA_Emulation_CT { |
Harald Welte | 2e32e43 | 2018-05-24 20:00:00 +0200 | [diff] [blame] | 299 | if (IPA_SP_PORT.checkstate("Connected")) { |
| 300 | IPA_SP_PORT.send(evt); |
| 301 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 302 | #ifdef IPA_EMULATION_RSL |
Harald Welte | 5819b55 | 2017-12-09 02:55:46 +0100 | [diff] [blame] | 303 | if (IPA_RSL_PORT.checkstate("Connected")) { |
| 304 | IPA_RSL_PORT.send(evt); |
| 305 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 306 | #endif |
Harald Welte | c682666 | 2019-02-06 22:26:46 +0100 | [diff] [blame] | 307 | #ifdef IPA_EMULATION_OML |
| 308 | if (IPA_OML_PORT.checkstate("Connected")) { |
| 309 | IPA_OML_PORT.send(evt); |
| 310 | } |
| 311 | #endif |
Pau Espin Pedrol | acc5119 | 2019-06-11 15:35:19 +0200 | [diff] [blame] | 312 | #ifdef IPA_EMULATION_CTRL |
Harald Welte | 5819b55 | 2017-12-09 02:55:46 +0100 | [diff] [blame] | 313 | if (IPA_CTRL_PORT.checkstate("Connected")) { |
| 314 | IPA_CTRL_PORT.send(evt); |
| 315 | } |
Pau Espin Pedrol | acc5119 | 2019-06-11 15:35:19 +0200 | [diff] [blame] | 316 | #endif |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 317 | #ifdef IPA_EMULATION_GSUP |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 318 | if (IPA_GSUP_PORT.checkstate("Connected")) { |
| 319 | IPA_GSUP_PORT.send(evt); |
| 320 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 321 | #endif |
Harald Welte | 7460a72 | 2018-10-10 12:28:27 +0200 | [diff] [blame] | 322 | #ifdef IPA_EMULATION_RSPRO |
| 323 | if (IPA_RSPRO_PORT.checkstate("Connected")) { |
| 324 | IPA_RSPRO_PORT.send(evt); |
| 325 | } |
| 326 | #endif |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 327 | /* FIXME: to other ports */ |
| 328 | } |
| 329 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 330 | /* build IPA CCM ID RESP response from IPA CCM GET */ |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 331 | private function f_ccm_make_id_resp(PDU_IPA_CCM get) runs on IPA_Emulation_CT return PDU_IPA_CCM { |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 332 | var integer i; |
| 333 | var PDU_IPA_CCM resp := { |
| 334 | msg_type := IPAC_MSGT_ID_RESP, |
| 335 | u := { |
| 336 | resp := {} |
| 337 | } |
| 338 | } |
| 339 | |
| 340 | for (i := 0; i < sizeof(get.u.get); i := i + 1) { |
| 341 | var IpaCcmIdTag tag := get.u.get[i].tag; |
| 342 | var charstring foo; |
| 343 | select (tag) { |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 344 | case (IPAC_IDTAG_SERNR) { |
| 345 | foo := g_ccm_pars.ser_nr; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 346 | } |
| 347 | case (IPAC_IDTAG_UNITNAME) { |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 348 | foo := g_ccm_pars.name; |
| 349 | } |
| 350 | case (IPAC_IDTAG_LOCATION1) { |
| 351 | foo := g_ccm_pars.location1; |
| 352 | } |
| 353 | case (IPAC_IDTAG_LOCATION2) { |
| 354 | foo := g_ccm_pars.location2; |
| 355 | } |
| 356 | case (IPAC_IDTAG_EQUIPVERS) { |
| 357 | foo := g_ccm_pars.equip_version; |
| 358 | } |
| 359 | case (IPAC_IDTAG_SWVERSION) { |
| 360 | foo := g_ccm_pars.sw_version; |
| 361 | } |
| 362 | case (IPAC_IDTAG_IPADDR) { |
| 363 | foo := g_ccm_pars.ip_addr; |
| 364 | } |
| 365 | case (IPAC_IDTAG_MACADDR) { |
| 366 | foo := g_ccm_pars.mac_addr; |
| 367 | } |
Vadim Yanitskiy | 44f0c48 | 2020-05-24 20:49:29 +0700 | [diff] [blame] | 368 | case (IPAC_IDTAG_UNITID) { |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 369 | foo := g_ccm_pars.unit_id; |
| 370 | } |
| 371 | case (IPAC_IDTAG_OSMO_RAND) { |
| 372 | foo := g_ccm_pars.osmo_rand; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 373 | } |
| 374 | case else { |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 375 | foo := "unknown"; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 376 | } |
| 377 | } |
| 378 | resp.u.resp[sizeof(resp.u.resp)] := valueof(t_IdRespPart(tag, foo)); |
| 379 | } |
| 380 | |
| 381 | return resp; |
| 382 | } |
| 383 | |
| 384 | /* transmit IPA CCM message */ |
| 385 | private function f_ccm_tx(PDU_IPA_CCM ccm) runs on IPA_Emulation_CT { |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 386 | var IPA_Send ipa_tx := valueof(t_IPA_Send(g_ipa_conn_id, IPAC_PROTO_CCM, enc_PDU_IPA_CCM(ccm))); |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 387 | log("CCM Tx:", ccm); |
| 388 | IPA_PORT.send(ipa_tx); |
| 389 | } |
| 390 | |
| 391 | template PDU_IPA_CCM ts_IPA_PONG := { |
| 392 | msg_type := IPAC_MSGT_PONG, |
| 393 | u := omit |
| 394 | } |
| 395 | |
| 396 | template PDU_IPA_CCM ts_IPA_ACK := { |
| 397 | msg_type := IPAC_MSGT_ID_ACK, |
| 398 | u := omit |
| 399 | } |
| 400 | |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 401 | template PDU_IPA_CCM ts_IPA_ID_GET := { |
| 402 | msg_type := IPAC_MSGT_ID_GET, |
| 403 | u := { |
| 404 | get := { |
| 405 | { 1, IPAC_IDTAG_UNITNAME } |
| 406 | } |
| 407 | } |
| 408 | } |
| 409 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 410 | /* receive IPA CCM message */ |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 411 | private function f_ccm_rx_client(PDU_IPA_CCM ccm) runs on IPA_Emulation_CT { |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 412 | select (ccm.msg_type) { |
| 413 | case (IPAC_MSGT_PING) { |
| 414 | f_ccm_tx(valueof(ts_IPA_PONG)); |
| 415 | } |
| 416 | case (IPAC_MSGT_ID_ACK) { |
Vadim Yanitskiy | 61564be | 2020-05-18 20:44:14 +0700 | [diff] [blame] | 417 | f_send_IPA_EVT(ts_ASP_IPA_EV(ASP_IPA_EVENT_ID_ACK)); |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 418 | } |
| 419 | case (IPAC_MSGT_ID_GET) { |
| 420 | f_ccm_tx(f_ccm_make_id_resp(ccm)); |
| 421 | } |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 422 | case else { |
| 423 | log("Unknown/unsupported IPA CCM message type", ccm); |
| 424 | } |
| 425 | } |
| 426 | } |
| 427 | |
| 428 | private function f_ccm_rx_server(PDU_IPA_CCM ccm) runs on IPA_Emulation_CT { |
| 429 | select (ccm.msg_type) { |
| 430 | case (IPAC_MSGT_PING) { |
| 431 | f_ccm_tx(valueof(ts_IPA_PONG)); |
| 432 | } |
| 433 | case (IPAC_MSGT_ID_ACK) { |
| 434 | /* the IPA server should at some point receive an ID_ACK from the client, |
| 435 | * in case of RSL/OML from nanoBTS, this is actually the first message after |
| 436 | * the TCP connection is established. Other implementations may differ. |
| 437 | * We currently ignore it completely - but actually we should make sure that |
| 438 | * one ID_ACK is received by the server at some point */ |
Vadim Yanitskiy | 61564be | 2020-05-18 20:44:14 +0700 | [diff] [blame] | 439 | f_send_IPA_EVT(ts_ASP_IPA_EV(ASP_IPA_EVENT_ID_ACK)); |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 440 | } |
Harald Welte | 3bc387f | 2018-02-21 12:18:46 +0100 | [diff] [blame] | 441 | case (IPAC_MSGT_ID_RESP) { |
| 442 | log("IPA ID RESP: ", ccm.u.resp); |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 443 | /* acknowledge any identity that the client may have sent */ |
| 444 | f_ccm_tx(valueof(ts_IPA_ACK)); |
Harald Welte | 3bc387f | 2018-02-21 12:18:46 +0100 | [diff] [blame] | 445 | } |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 446 | case else { |
| 447 | log("Unknown/unsupported IPA CCM message type", ccm); |
| 448 | } |
| 449 | } |
| 450 | } |
| 451 | |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 452 | private function f_to_asp(IPA_RecvFrom ipa_rx) return ASP_IPA_Unitdata { |
| 453 | var ASP_IPA_Unitdata ret := { |
| 454 | streamId := ipa_rx.streamId, |
Harald Welte | 2a8f847 | 2017-11-23 21:11:34 +0100 | [diff] [blame] | 455 | streamIdExt := ipa_rx.streamIdExt, |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 456 | payload := ipa_rx.msg |
| 457 | } |
| 458 | return ret; |
| 459 | } |
| 460 | |
Stefan Sperling | 830dc9d | 2018-02-12 21:08:28 +0100 | [diff] [blame] | 461 | private function f_from_asp(IPL4asp_Types.ConnectionId connId, ASP_IPA_Unitdata ipa_tx) return IPA_Send { |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 462 | var IPA_Send ret := valueof(t_IPA_Send(connId, ipa_tx.streamId, ipa_tx.payload, |
| 463 | ipa_tx.streamIdExt)); |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 464 | return ret; |
| 465 | } |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 466 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 467 | #ifdef IPA_EMULATION_RSL |
Stefan Sperling | 830dc9d | 2018-02-12 21:08:28 +0100 | [diff] [blame] | 468 | private function f_from_rsl(IPL4asp_Types.ConnectionId connId, ASP_RSL_Unitdata rsl_tx) return IPA_Send { |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 469 | var octetstring payload := enc_RSL_Message(rsl_tx.rsl); |
| 470 | var IPA_Send ret := valueof(t_IPA_Send(connId, rsl_tx.streamId, payload)); |
| 471 | return ret; |
| 472 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 473 | #endif |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 474 | |
Harald Welte | c682666 | 2019-02-06 22:26:46 +0100 | [diff] [blame] | 475 | #ifdef IPA_EMULATION_OML |
| 476 | private function f_from_oml(IPL4asp_Types.ConnectionId connId, OML_PDU oml_tx) return IPA_Send { |
| 477 | var octetstring payload := enc_OML_PDU(oml_tx); |
| 478 | var IPA_Send ret := valueof(t_IPA_Send(connId, IPAC_PROTO_OML, payload)); |
| 479 | return ret; |
| 480 | } |
| 481 | #endif |
| 482 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 483 | /* main function to use for a client-side IPA implementation */ |
Stefan Sperling | 830dc9d | 2018-02-12 21:08:28 +0100 | [diff] [blame] | 484 | function main_client(charstring remote_host, IPL4asp_Types.PortNumber remote_port, |
| 485 | charstring local_host, IPL4asp_Types.PortNumber local_port, |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 486 | IPA_CCM_Parameters ccm_pars := c_IPA_default_ccm_pars, |
| 487 | boolean ccm_enabled := true) runs on IPA_Emulation_CT { |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 488 | g_mode := IPA_MODE_CLIENT; |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 489 | g_ccm_enabled := ccm_enabled; |
Harald Welte | e09921f | 2017-12-07 17:49:00 +0100 | [diff] [blame] | 490 | f_connect(remote_host, remote_port, local_host, local_port, ccm_pars); |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 491 | if (g_ccm_enabled) { |
| 492 | /* we're a client: Send ID_ACK immediately after connect */ |
| 493 | f_ccm_tx(valueof(ts_IPA_ACK)); |
| 494 | } |
Vadim Yanitskiy | 61564be | 2020-05-18 20:44:14 +0700 | [diff] [blame] | 495 | f_send_IPA_EVT(ts_ASP_IPA_EV(ASP_IPA_EVENT_UP)); |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 496 | ScanEvents(); |
| 497 | } |
| 498 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 499 | /* main function to use for a server-side IPA implementation */ |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 500 | function main_server(charstring local_host, IPL4asp_Types.PortNumber local_port, |
Neels Hofmeyr | 3bf31d2 | 2018-08-24 14:44:32 +0200 | [diff] [blame] | 501 | boolean ccm_enabled := true, |
| 502 | IpaInitBehavior init_behavior := IPA_INIT_SEND_IPA_ID_GET) |
| 503 | runs on IPA_Emulation_CT { |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 504 | g_mode := IPA_MODE_SERVER; |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 505 | g_ccm_enabled := ccm_enabled; |
Neels Hofmeyr | 3bf31d2 | 2018-08-24 14:44:32 +0200 | [diff] [blame] | 506 | g_init_behavior := init_behavior; |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 507 | f_bind(local_host, local_port); |
| 508 | ScanEvents(); |
| 509 | } |
| 510 | |
Pau Espin Pedrol | acc5119 | 2019-06-11 15:35:19 +0200 | [diff] [blame] | 511 | #ifdef IPA_EMULATION_CTRL |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 512 | private function f_ctrl_to_user(octetstring msg) runs on IPA_Emulation_CT { |
| 513 | var charstring msg_ch := oct2char(msg); |
| 514 | IPA_CTRL_PORT.send(dec_CtrlMessage(msg_ch)); |
| 515 | } |
Pau Espin Pedrol | acc5119 | 2019-06-11 15:35:19 +0200 | [diff] [blame] | 516 | #endif |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 517 | |
| 518 | #ifdef IPA_EMULATION_GSUP |
| 519 | private function f_gsup_to_user(octetstring msg) runs on IPA_Emulation_CT { |
| 520 | var GSUP_PDU gsup := dec_GSUP_PDU(msg); |
| 521 | f_gsup_postprocess_decoded(gsup); |
| 522 | IPA_GSUP_PORT.send(gsup); |
| 523 | } |
| 524 | #endif |
| 525 | |
Harald Welte | 7460a72 | 2018-10-10 12:28:27 +0200 | [diff] [blame] | 526 | #ifdef IPA_EMULATION_RSPRO |
| 527 | private function f_rspro_to_user(octetstring msg) runs on IPA_Emulation_CT { |
| 528 | var RsproPDU rspro := dec_RsproPDU(msg); |
| 529 | IPA_RSPRO_PORT.send(rspro); |
| 530 | } |
| 531 | #endif |
| 532 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 533 | #ifdef IPA_EMULATION_MGCP |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 534 | private function f_mgcp_to_user(octetstring msg) runs on IPA_Emulation_CT { |
| 535 | var charstring msg_ch := oct2char(msg); |
| 536 | if (g_is_bsc_mgw) { |
| 537 | log("============"); |
| 538 | log(msg_ch); |
| 539 | IPA_MGCP_PORT.send(dec_MgcpCommand(msg_ch)); |
| 540 | } else { |
| 541 | IPA_MGCP_PORT.send(dec_MgcpResponse(msg_ch)); |
| 542 | } |
| 543 | } |
| 544 | |
Harald Welte | 92632e1 | 2017-11-25 02:31:20 +0100 | [diff] [blame] | 545 | private function f_mgcp_to_ud(octetstring payload) runs on IPA_Emulation_CT return ASP_IPA_Unitdata { |
| 546 | if (mp_ipa_mgcp_uses_osmo_ext) { |
| 547 | return valueof(t_ASP_IPA_UD(IPAC_PROTO_MGCP_OLD, payload)); |
| 548 | } else { |
| 549 | return valueof(t_ASP_IPA_UD(IPAC_PROTO_OSMO, payload, IPAC_PROTO_EXT_MGCP)); |
| 550 | } |
| 551 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 552 | #endif |
Harald Welte | 92632e1 | 2017-11-25 02:31:20 +0100 | [diff] [blame] | 553 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 554 | /* main loop function for both client and server. 'thread' of the component */ |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 555 | private function ScanEvents() runs on IPA_Emulation_CT { |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 556 | var IPA_RecvFrom ipa_rx; |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 557 | var ASP_Event asp_evt; |
Stefan Sperling | 830dc9d | 2018-02-12 21:08:28 +0100 | [diff] [blame] | 558 | var Socket_API_Definitions.PortEvent port_evt; |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 559 | var octetstring payload; |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 560 | var ASP_IPA_Unitdata ipa_ud; |
Harald Welte | 3286eb3 | 2019-08-18 19:36:10 +0200 | [diff] [blame] | 561 | #ifdef IPA_EMULATION_CTRL |
| 562 | var CtrlMessage ctrl_msg; |
| 563 | #endif |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 564 | #ifdef IPA_EMULATION_SCCP |
| 565 | var ASP_MTP3_TRANSFERreq mtp_req; |
| 566 | #endif |
| 567 | #ifdef IPA_EMULATION_MGCP |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 568 | var MgcpCommand mgcp_cmd; |
| 569 | var MgcpResponse mgcp_rsp; |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 570 | #endif |
| 571 | #ifdef IPA_EMULATION_GSUP |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 572 | var GSUP_PDU gsup_msg; |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 573 | #endif |
| 574 | #ifdef IPA_EMULATION_RSL |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 575 | var ASP_RSL_Unitdata rsl; |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 576 | #endif |
Harald Welte | c682666 | 2019-02-06 22:26:46 +0100 | [diff] [blame] | 577 | #ifdef IPA_EMULATION_OML |
| 578 | var OML_PDU oml; |
| 579 | #endif |
Harald Welte | 7460a72 | 2018-10-10 12:28:27 +0200 | [diff] [blame] | 580 | #ifdef IPA_EMULATION_RSPRO |
| 581 | var RsproPDU rspro; |
| 582 | #endif |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 583 | |
Harald Welte | 3e6ad89 | 2017-12-12 14:39:46 +0100 | [diff] [blame] | 584 | /* Set function for dissecting the binary */ |
| 585 | var f_IPL4_getMsgLen vl_f := refers(f_IPL4_fixedMsgLen); |
| 586 | IPA_CodecPort_CtrlFunct.f_IPL4_setGetMsgLen(IPA_PORT, g_ipa_conn_id, vl_f, {0, 2, 3, 1, 0}); |
| 587 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 588 | while (true) { |
| 589 | alt { |
| 590 | /* Received IPA -> up into SCCP stack */ |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 591 | [g_ccm_enabled] IPA_PORT.receive(IPA_RecvFrom:{?,IPAC_PROTO_CCM,omit,?}) -> value ipa_rx { |
| 592 | var PDU_IPA_CCM ccm := dec_PDU_IPA_CCM(ipa_rx.msg); |
| 593 | log("CCM Rx:", ccm); |
| 594 | select (g_mode) { |
| 595 | case (IPA_MODE_CLIENT) { |
| 596 | f_ccm_rx_client(ccm); |
| 597 | } |
| 598 | case (IPA_MODE_SERVER) { |
| 599 | f_ccm_rx_server(ccm); |
| 600 | } |
| 601 | case else { |
| 602 | setverdict(fail, "Unknown mode"); |
Daniel Willmann | e4ff537 | 2018-07-05 17:35:03 +0200 | [diff] [blame] | 603 | mtc.stop; |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 604 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 605 | } |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 606 | } |
| 607 | [] IPA_PORT.receive(IPA_RecvFrom:?) -> value ipa_rx { |
| 608 | select (ipa_rx.streamId) { |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 609 | #ifdef IPA_EMULATION_SCCP |
| 610 | case (IPAC_PROTO_SCCP) { |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 611 | var ASP_MTP3_TRANSFERind mtp; |
| 612 | mtp := valueof(ts_MTP3_XFER_ind(0, ipa_rx.msg)); |
| 613 | MTP3_SP_PORT.send(mtp); |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 614 | } |
| 615 | #endif |
| 616 | #ifdef IPA_EMULATION_MGCP |
| 617 | case (IPAC_PROTO_MGCP_OLD) { |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 618 | f_mgcp_to_user(ipa_rx.msg); |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 619 | } |
| 620 | #endif |
| 621 | #ifdef IPA_EMULATION_RSL |
| 622 | case (t_IpaSidRSL) { |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 623 | rsl := { |
| 624 | streamId := ipa_rx.streamId, |
| 625 | rsl := dec_RSL_Message(ipa_rx.msg) |
| 626 | }; |
| 627 | IPA_RSL_PORT.send(rsl); |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 628 | } |
| 629 | #endif |
Harald Welte | c682666 | 2019-02-06 22:26:46 +0100 | [diff] [blame] | 630 | #ifdef IPA_EMULATION_OML |
| 631 | case (IPAC_PROTO_OML) { |
| 632 | oml := dec_OML_PDU(ipa_rx.msg) |
| 633 | IPA_OML_PORT.send(oml); |
| 634 | } |
| 635 | #endif |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 636 | case (IPAC_PROTO_OSMO) { |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 637 | select (ipa_rx.streamIdExt) { |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 638 | #ifdef IPA_EMULATION_MGCP |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 639 | case (IPAC_PROTO_EXT_MGCP) { |
| 640 | f_mgcp_to_user(ipa_rx.msg); |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 641 | } |
| 642 | #endif |
Harald Welte | 3286eb3 | 2019-08-18 19:36:10 +0200 | [diff] [blame] | 643 | #ifdef IPA_EMULATION_CTRL |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 644 | case (IPAC_PROTO_EXT_CTRL) { |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 645 | f_ctrl_to_user(ipa_rx.msg); |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 646 | } |
Harald Welte | 3286eb3 | 2019-08-18 19:36:10 +0200 | [diff] [blame] | 647 | #endif |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 648 | #ifdef IPA_EMULATION_GSUP |
| 649 | case (IPAC_PROTO_EXT_GSUP) { |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 650 | f_gsup_to_user(ipa_rx.msg); |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 651 | } |
| 652 | #endif |
Harald Welte | 7460a72 | 2018-10-10 12:28:27 +0200 | [diff] [blame] | 653 | #ifdef IPA_EMULATION_RSPRO |
| 654 | case (IPAC_PROTO_EXT_RSPRO) { |
| 655 | f_rspro_to_user(ipa_rx.msg); |
| 656 | } |
| 657 | #endif |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 658 | case else { |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 659 | IPA_SP_PORT.send(f_to_asp(ipa_rx)); |
| 660 | } |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 661 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 662 | } |
| 663 | case else { |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 664 | IPA_SP_PORT.send(f_to_asp(ipa_rx)); |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 665 | } |
| 666 | } |
| 667 | } |
| 668 | |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 669 | /* server only */ |
| 670 | [] IPA_PORT.receive(ASP_Event:{connOpened:=?}) -> value asp_evt { |
| 671 | log("IPA: Connected"); |
| 672 | g_ipa_conn_id := asp_evt.connOpened.connId; |
Vadim Yanitskiy | 61564be | 2020-05-18 20:44:14 +0700 | [diff] [blame] | 673 | f_send_IPA_EVT(ts_ASP_IPA_EV(ASP_IPA_EVENT_UP)); |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 674 | if (g_mode == IPA_MODE_SERVER and g_ccm_enabled) { |
Neels Hofmeyr | 3bf31d2 | 2018-08-24 14:44:32 +0200 | [diff] [blame] | 675 | select (g_init_behavior) { |
| 676 | case (IPA_INIT_SEND_IPA_ID_GET) { |
| 677 | f_ccm_tx(valueof(ts_IPA_ID_GET)); |
| 678 | } |
| 679 | case (IPA_INIT_SEND_IPA_ID_ACK) { |
| 680 | f_ccm_tx(valueof(ts_IPA_ACK)); |
| 681 | } |
| 682 | } |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 683 | } |
| 684 | } |
| 685 | |
| 686 | [] IPA_PORT.receive(ASP_Event:{connClosed:=?}) -> value asp_evt { |
| 687 | log("IPA: Closed"); |
| 688 | g_ipa_conn_id := -1; |
Vadim Yanitskiy | 61564be | 2020-05-18 20:44:14 +0700 | [diff] [blame] | 689 | f_send_IPA_EVT(ts_ASP_IPA_EV(ASP_IPA_EVENT_DOWN)); |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 690 | self.stop; |
| 691 | } |
| 692 | |
Stefan Sperling | 830dc9d | 2018-02-12 21:08:28 +0100 | [diff] [blame] | 693 | [] IPA_PORT.receive(Socket_API_Definitions.PortEvent:{result:={errorCode:=ERROR_SOCKET, connId:=?, os_error_code:=?, os_error_text:=?}}) -> value port_evt { |
| 694 | log("PortEvent: ERROR_SOCKET: ", port_evt); |
| 695 | g_ipa_conn_id := -1; |
Vadim Yanitskiy | 61564be | 2020-05-18 20:44:14 +0700 | [diff] [blame] | 696 | f_send_IPA_EVT(ts_ASP_IPA_EV(ASP_IPA_EVENT_DOWN)); |
Stefan Sperling | 830dc9d | 2018-02-12 21:08:28 +0100 | [diff] [blame] | 697 | self.stop; |
| 698 | } |
| 699 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 700 | #ifdef IPA_EMULATION_SCCP |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 701 | /* Received SCCP -> down into IPA */ |
| 702 | [] MTP3_SP_PORT.receive(ASP_MTP3_TRANSFERreq: ?) -> value mtp_req { |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 703 | var IPA_Send ipa_tx := valueof(t_IPA_Send(g_ipa_conn_id, IPAC_PROTO_SCCP, |
| 704 | mtp_req.data)); |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 705 | IPA_PORT.send(ipa_tx); |
| 706 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 707 | #endif |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 708 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 709 | #ifdef IPA_EMULATION_MGCP |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 710 | /* Received MGCP -> down into IPA */ |
| 711 | [] IPA_MGCP_PORT.receive(MgcpCommand:?) -> value mgcp_cmd { |
Harald Welte | 92632e1 | 2017-11-25 02:31:20 +0100 | [diff] [blame] | 712 | payload := char2oct(enc_MgcpCommand(mgcp_cmd)); |
| 713 | ipa_ud := f_mgcp_to_ud(payload); |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 714 | IPA_PORT.send(f_from_asp(g_ipa_conn_id, ipa_ud)); |
| 715 | } |
| 716 | [] IPA_MGCP_PORT.receive(MgcpResponse:?) -> value mgcp_rsp { |
Harald Welte | 1dd8f37 | 2017-11-25 02:25:27 +0100 | [diff] [blame] | 717 | payload := char2oct(enc_MgcpResponse(mgcp_rsp)); |
Harald Welte | 92632e1 | 2017-11-25 02:31:20 +0100 | [diff] [blame] | 718 | ipa_ud := f_mgcp_to_ud(payload); |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 719 | IPA_PORT.send(f_from_asp(g_ipa_conn_id, ipa_ud)); |
| 720 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 721 | #endif |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 722 | |
Pau Espin Pedrol | acc5119 | 2019-06-11 15:35:19 +0200 | [diff] [blame] | 723 | #ifdef IPA_EMULATION_CTRL |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 724 | [] IPA_CTRL_PORT.receive(CtrlMessage:?) -> value ctrl_msg { |
| 725 | payload := char2oct(enc_CtrlMessage(ctrl_msg)); |
| 726 | ipa_ud := valueof(t_ASP_IPA_UD(IPAC_PROTO_OSMO, payload, IPAC_PROTO_EXT_CTRL)); |
| 727 | IPA_PORT.send(f_from_asp(g_ipa_conn_id, ipa_ud)); |
| 728 | } |
Pau Espin Pedrol | acc5119 | 2019-06-11 15:35:19 +0200 | [diff] [blame] | 729 | #endif |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 730 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 731 | #ifdef IPA_EMULATION_GSUP |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 732 | [] IPA_GSUP_PORT.receive(GSUP_PDU:?) -> value gsup_msg { |
Harald Welte | 2f562b1 | 2018-01-24 20:52:38 +0100 | [diff] [blame] | 733 | f_gsup_preprocess_encoded(gsup_msg); |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 734 | payload := enc_GSUP_PDU(gsup_msg); |
| 735 | ipa_ud := valueof(t_ASP_IPA_UD(IPAC_PROTO_OSMO, payload, IPAC_PROTO_EXT_GSUP)); |
| 736 | IPA_PORT.send(f_from_asp(g_ipa_conn_id, ipa_ud)); |
| 737 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 738 | #endif |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 739 | |
Harald Welte | 7460a72 | 2018-10-10 12:28:27 +0200 | [diff] [blame] | 740 | #ifdef IPA_EMULATION_RSPRO |
| 741 | [] IPA_RSPRO_PORT.receive(RsproPDU:?) -> value rspro { |
| 742 | payload := enc_RsproPDU(rspro); |
| 743 | ipa_ud := valueof(t_ASP_IPA_UD(IPAC_PROTO_OSMO, payload, IPAC_PROTO_EXT_RSPRO)); |
| 744 | IPA_PORT.send(f_from_asp(g_ipa_conn_id, ipa_ud)); |
| 745 | } |
| 746 | #endif |
| 747 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 748 | #ifdef IPA_EMULATION_RSL |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 749 | /* Received RSL -> down into IPA */ |
| 750 | [] IPA_RSL_PORT.receive(ASP_RSL_Unitdata:?) -> value rsl { |
| 751 | IPA_PORT.send(f_from_rsl(g_ipa_conn_id, rsl)); |
| 752 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 753 | #endif |
Harald Welte | c682666 | 2019-02-06 22:26:46 +0100 | [diff] [blame] | 754 | #ifdef IPA_EMULATION_OML |
| 755 | /* Received OML -> down into IPA */ |
| 756 | [] IPA_OML_PORT.receive(OML_PDU:?) -> value oml { |
| 757 | IPA_PORT.send(f_from_oml(g_ipa_conn_id, oml)); |
| 758 | } |
| 759 | [] IPA_OML_PORT.receive(octetstring:?) -> value payload { |
| 760 | IPA_PORT.send(t_IPA_Send(g_ipa_conn_id, IPAC_PROTO_OML, payload)); |
| 761 | } |
| 762 | #endif |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 763 | /* Received MISC (OML/CTRL) -> down into IPA */ |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 764 | [] IPA_SP_PORT.receive(ASP_IPA_Unitdata: ?) -> value ipa_ud { |
| 765 | IPA_PORT.send(f_from_asp(g_ipa_conn_id, ipa_ud)); |
| 766 | } |
| 767 | |
| 768 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 769 | } |
| 770 | } |
| 771 | } |
| 772 | |
Harald Welte | 2e32e43 | 2018-05-24 20:00:00 +0200 | [diff] [blame] | 773 | /*********************************************************************** |
| 774 | * IPA Event waiter component. Wait for ASP_IPA_EVENT_ID_ACK |
| 775 | ***********************************************************************/ |
| 776 | |
| 777 | type component IPA_EventWaiter_CT { |
| 778 | port IPA_SP_PT IPA_SP_PORT; |
| 779 | } |
| 780 | |
Vadim Yanitskiy | 61564be | 2020-05-18 20:44:14 +0700 | [diff] [blame] | 781 | function waiter_main(template ASP_IPA_Event wait_for := tr_ASP_IPA_EV(ASP_IPA_EVENT_ID_ACK)) |
Harald Welte | 2e32e43 | 2018-05-24 20:00:00 +0200 | [diff] [blame] | 782 | runs on IPA_EventWaiter_CT { |
| 783 | |
| 784 | alt { |
| 785 | [] IPA_SP_PORT.receive(wait_for) { |
| 786 | setverdict(pass); |
| 787 | } |
| 788 | [] IPA_SP_PORT.receive { repeat; } |
| 789 | } |
| 790 | } |
| 791 | |
| 792 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 793 | } |