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; |
Pau Espin Pedrol | 8f1403a | 2024-01-18 20:08:43 +0100 | [diff] [blame] | 47 | import from GSUP_Templates all; |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 48 | #endif |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 49 | |
Harald Welte | 7460a72 | 2018-10-10 12:28:27 +0200 | [diff] [blame] | 50 | #ifdef IPA_EMULATION_RSPRO |
| 51 | import from RSPRO all; |
| 52 | import from RSPRO_Types all; |
| 53 | #endif |
| 54 | |
Harald Welte | 3286eb3 | 2019-08-18 19:36:10 +0200 | [diff] [blame] | 55 | #ifdef IPA_EMULATION_CTRL |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 56 | import from Osmocom_CTRL_Types all; |
Harald Welte | 3286eb3 | 2019-08-18 19:36:10 +0200 | [diff] [blame] | 57 | #endif |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 58 | |
Pau Espin Pedrol | 6924ef7 | 2021-06-09 16:19:26 +0200 | [diff] [blame] | 59 | #ifdef IPA_EMULATION_OSMO_PCU |
| 60 | import from PCUIF_Types all; |
| 61 | #endif |
| 62 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 63 | modulepar { |
Harald Welte | 92632e1 | 2017-11-25 02:31:20 +0100 | [diff] [blame] | 64 | /* Use Osmocom extended IPA mux header */ |
| 65 | boolean mp_ipa_mgcp_uses_osmo_ext := true; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 66 | } |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 67 | |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 68 | type enumerated IpaMode { |
| 69 | IPA_MODE_CLIENT, |
| 70 | IPA_MODE_SERVER |
| 71 | } |
| 72 | |
Neels Hofmeyr | 3bf31d2 | 2018-08-24 14:44:32 +0200 | [diff] [blame] | 73 | type enumerated IpaInitBehavior { |
| 74 | IPA_INIT_SEND_IPA_ID_GET, |
| 75 | IPA_INIT_SEND_IPA_ID_ACK |
| 76 | } |
| 77 | |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 78 | type record ASP_IPA_Unitdata { |
| 79 | IpaStreamId streamId, |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 80 | IpaExtStreamId streamIdExt optional, |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 81 | octetstring payload |
| 82 | } |
| 83 | |
Vadim Yanitskiy | 8701b27 | 2020-05-18 20:17:25 +0700 | [diff] [blame] | 84 | type enumerated ASP_IPA_EventType { |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 85 | ASP_IPA_EVENT_DOWN, |
| 86 | ASP_IPA_EVENT_UP, |
Vadim Yanitskiy | 11edf3c | 2020-05-24 22:26:54 +0700 | [diff] [blame] | 87 | ASP_IPA_EVENT_ID_RESP, |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 88 | ASP_IPA_EVENT_ID_ACK |
| 89 | } |
| 90 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 91 | /* an event indicating us whether or not a connection is physically up or down, |
Vadim Yanitskiy | 11edf3c | 2020-05-24 22:26:54 +0700 | [diff] [blame] | 92 | * and whether we have received an ID_RESP or ID_ACK */ |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 93 | type record ASP_IPA_Event { |
| 94 | ASP_IPA_EventType ev_type, |
Vadim Yanitskiy | 11edf3c | 2020-05-24 22:26:54 +0700 | [diff] [blame] | 95 | integer conn_id, |
| 96 | |
| 97 | /* Presence of these fields depends on event type */ |
| 98 | IpaCcmIdResp id_resp optional // ASP_IPA_EVENT_ID_RESP |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 99 | } |
| 100 | |
Vadim Yanitskiy | 11edf3c | 2020-05-24 22:26:54 +0700 | [diff] [blame] | 101 | template (value) ASP_IPA_Event ts_ASP_IPA_EV(ASP_IPA_EventType ev_type, integer conn_id, |
| 102 | template (omit) IpaCcmIdResp id_resp := omit) := { |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 103 | ev_type := ev_type, |
Vadim Yanitskiy | 11edf3c | 2020-05-24 22:26:54 +0700 | [diff] [blame] | 104 | conn_id := conn_id, |
| 105 | id_resp := id_resp |
Vadim Yanitskiy | 61564be | 2020-05-18 20:44:14 +0700 | [diff] [blame] | 106 | } |
| 107 | |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 108 | template ASP_IPA_Event tr_ASP_IPA_EV(template ASP_IPA_EventType ev_type, |
Vadim Yanitskiy | 11edf3c | 2020-05-24 22:26:54 +0700 | [diff] [blame] | 109 | template integer conn_id := ?, |
| 110 | template IpaCcmIdResp id_resp := *) := { |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 111 | ev_type := ev_type, |
Vadim Yanitskiy | 11edf3c | 2020-05-24 22:26:54 +0700 | [diff] [blame] | 112 | conn_id := conn_id, |
| 113 | id_resp := id_resp |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 114 | } |
| 115 | |
Harald Welte | 1dd8f37 | 2017-11-25 02:25:27 +0100 | [diff] [blame] | 116 | template ASP_IPA_Unitdata t_ASP_IPA_UD(IpaStreamId sid, octetstring pl, |
| 117 | template IpaExtStreamId esid := omit) := { |
| 118 | streamId := sid, |
| 119 | streamIdExt := esid, |
| 120 | payload := pl |
| 121 | } |
| 122 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 123 | #ifdef IPA_EMULATION_RSL |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 124 | /* 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] | 125 | type record ASP_RSL_Unitdata { |
Vadim Yanitskiy | ef9bcd2 | 2020-05-25 19:01:04 +0700 | [diff] [blame] | 126 | integer conn_id optional, |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 127 | IpaStreamId streamId, |
| 128 | RSL_Message rsl |
| 129 | }; |
| 130 | |
Vadim Yanitskiy | 9b4e356 | 2020-05-25 21:40:52 +0700 | [diff] [blame] | 131 | template (value) ASP_RSL_Unitdata ts_ASP_RSL_UD(template (value) RSL_Message rsl, |
Vadim Yanitskiy | ef9bcd2 | 2020-05-25 19:01:04 +0700 | [diff] [blame] | 132 | IpaStreamId sid := IPAC_PROTO_RSL_TRX0, |
| 133 | template (omit) integer conn_id := omit) := { |
| 134 | conn_id := conn_id, |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 135 | streamId := sid, |
Vadim Yanitskiy | 6b4856d | 2020-05-25 21:23:46 +0700 | [diff] [blame] | 136 | rsl := rsl |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 137 | } |
| 138 | |
Vadim Yanitskiy | 9b4e356 | 2020-05-25 21:40:52 +0700 | [diff] [blame] | 139 | template ASP_RSL_Unitdata tr_ASP_RSL_UD(template (present) RSL_Message rsl, |
Vadim Yanitskiy | ef9bcd2 | 2020-05-25 19:01:04 +0700 | [diff] [blame] | 140 | template IpaStreamId sid := IPAC_PROTO_RSL_TRX0, |
| 141 | template integer conn_id := *) := { |
| 142 | conn_id := conn_id, |
Harald Welte | 7ae019e | 2017-12-09 00:54:15 +0100 | [diff] [blame] | 143 | streamId := sid, |
| 144 | rsl := rsl |
| 145 | } |
| 146 | |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 147 | template IpaStreamId t_IpaSidRSL := ( IPAC_PROTO_RSL_TRX0, IPAC_PROTO_RSL_TRX1, |
| 148 | IPAC_PROTO_RSL_TRX2, IPAC_PROTO_RSL_TRX3 ); |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 149 | #endif |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 150 | |
Harald Welte | c682666 | 2019-02-06 22:26:46 +0100 | [diff] [blame] | 151 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 152 | /* Client port for general IPA messages, not further decoded */ |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 153 | type port IPA_SP_PT message { |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 154 | inout ASP_IPA_Unitdata, ASP_IPA_Event; |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 155 | } with { extension "internal" } |
| 156 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 157 | #ifdef IPA_EMULATION_MGCP |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 158 | /* Client port for MGCP inside IPA */ |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 159 | type port IPA_MGCP_PT message { |
| 160 | inout MgcpCommand, MgcpResponse; |
| 161 | } with { extension "internal" } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 162 | #endif |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 163 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 164 | #ifdef IPA_EMULATION_RSL |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 165 | /* Client port for A-bis RSL inside IPA */ |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 166 | type port IPA_RSL_PT message { |
| 167 | inout ASP_RSL_Unitdata, ASP_IPA_Event; |
| 168 | } with { extension "internal" } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 169 | #endif |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 170 | |
Harald Welte | c682666 | 2019-02-06 22:26:46 +0100 | [diff] [blame] | 171 | #ifdef IPA_EMULATION_OML |
| 172 | /* Client port for A-bis OML inside IPA */ |
| 173 | type port IPA_OML_PT message { |
| 174 | inout OML_PDU, octetstring, ASP_IPA_Event; |
| 175 | } with { extension "internal" } |
| 176 | #endif |
| 177 | |
Harald Welte | 3286eb3 | 2019-08-18 19:36:10 +0200 | [diff] [blame] | 178 | #ifdef IPA_EMULATION_CTRL |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 179 | /* Client port for CTRL inside IPA */ |
| 180 | type port IPA_CTRL_PT message { |
| 181 | inout CtrlMessage, ASP_IPA_Event; |
| 182 | } with { extension "internal" } |
Harald Welte | 3286eb3 | 2019-08-18 19:36:10 +0200 | [diff] [blame] | 183 | #endif |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 184 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 185 | #ifdef IPA_EMULATION_GSUP |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 186 | /* Client port for CTRL inside IPA */ |
| 187 | type port IPA_GSUP_PT message { |
| 188 | inout GSUP_PDU, ASP_IPA_Event; |
| 189 | } with { extension "internal" } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 190 | #endif |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 191 | |
Harald Welte | 7460a72 | 2018-10-10 12:28:27 +0200 | [diff] [blame] | 192 | #ifdef IPA_EMULATION_RSPRO |
| 193 | type port IPA_RSPRO_PT message { |
| 194 | inout RsproPDU, ASP_IPA_Event; |
| 195 | } with { extension "internal" } |
| 196 | #endif |
| 197 | |
Pau Espin Pedrol | 6924ef7 | 2021-06-09 16:19:26 +0200 | [diff] [blame] | 198 | #ifdef IPA_EMULATION_OSMO_PCU |
| 199 | /* Client port for Osmocom PCU extension inside IPA */ |
| 200 | type port IPA_OSMO_PCU_PT message { |
| 201 | inout PCUIF_Message, ASP_IPA_Event; |
| 202 | } with { extension "internal" } |
| 203 | #endif |
Harald Welte | 7460a72 | 2018-10-10 12:28:27 +0200 | [diff] [blame] | 204 | |
| 205 | |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 206 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 207 | type component IPA_Emulation_CT { |
| 208 | /* down-facing port to IPA codec port */ |
| 209 | port IPA_CODEC_PT IPA_PORT; |
Pau Espin Pedrol | af0c61e | 2022-01-11 12:48:34 +0100 | [diff] [blame] | 210 | /* Down facing port to configure the component */ |
| 211 | port IPA_CFG_PT CFG_PORT; |
| 212 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 213 | #ifdef IPA_EMULATION_SCCP |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 214 | /* up-facing port to SCCP */ |
| 215 | port MTP3asp_SP_PT MTP3_SP_PORT; |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 216 | #endif |
| 217 | #ifdef IPA_EMULATION_MGCP |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 218 | /* up-facing port for MGCP */ |
| 219 | port IPA_MGCP_PT IPA_MGCP_PORT; |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 220 | #endif |
| 221 | #ifdef IPA_EMULATION_RSL |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 222 | /* up-facing port for RSL */ |
| 223 | port IPA_RSL_PT IPA_RSL_PORT; |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 224 | #endif |
Harald Welte | c682666 | 2019-02-06 22:26:46 +0100 | [diff] [blame] | 225 | #ifdef IPA_EMULATION_OML |
| 226 | /* up-facing port for OML */ |
| 227 | port IPA_OML_PT IPA_OML_PORT; |
| 228 | #endif |
Pau Espin Pedrol | acc5119 | 2019-06-11 15:35:19 +0200 | [diff] [blame] | 229 | #ifdef IPA_EMULATION_CTRL |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 230 | /* up-facing port for CTRL */ |
| 231 | port IPA_CTRL_PT IPA_CTRL_PORT; |
Pau Espin Pedrol | acc5119 | 2019-06-11 15:35:19 +0200 | [diff] [blame] | 232 | #endif |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 233 | #ifdef IPA_EMULATION_GSUP |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 234 | /* up-facing port for GSUP */ |
| 235 | port IPA_GSUP_PT IPA_GSUP_PORT; |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 236 | #endif |
Harald Welte | 7460a72 | 2018-10-10 12:28:27 +0200 | [diff] [blame] | 237 | #ifdef IPA_EMULATION_RSPRO |
| 238 | /* up-facing port for RSPRO */ |
| 239 | port IPA_RSPRO_PT IPA_RSPRO_PORT; |
| 240 | #endif |
Pau Espin Pedrol | 6924ef7 | 2021-06-09 16:19:26 +0200 | [diff] [blame] | 241 | #ifdef IPA_EMULATION_OSMO_PCU |
| 242 | /* up-facing port for RSPRO */ |
| 243 | port IPA_OSMO_PCU_PT IPA_OSMO_PCU_PORT; |
| 244 | #endif |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 245 | |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 246 | /* up-facing port for other streams */ |
| 247 | port IPA_SP_PT IPA_SP_PORT; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 248 | |
| 249 | var boolean g_initialized := false; |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 250 | /* Are we a BSC/MGW (truel) or MSC (false) */ |
| 251 | var boolean g_is_bsc_mgw; |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 252 | |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 253 | /* Connection identifier of the client / server itself */ |
| 254 | var IPL4asp_Types.ConnectionId g_self_conn_id := -1; |
| 255 | /* Connection identifier of the last connected client (server only) */ |
| 256 | var IPL4asp_Types.ConnectionId g_last_conn_id := -1; |
| 257 | |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 258 | var IpaMode g_mode; |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 259 | var boolean g_ccm_enabled; |
Neels Hofmeyr | 3bf31d2 | 2018-08-24 14:44:32 +0200 | [diff] [blame] | 260 | var IpaInitBehavior g_init_behavior; |
Pau Espin Pedrol | 2dc137c | 2021-01-28 19:53:21 +0100 | [diff] [blame] | 261 | /* Shall we stop the component once the client disconnects, or keep |
| 262 | * running to let next user in ? */ |
| 263 | var boolean g_server_stop_on_ipa_ev_down := true; |
Harald Welte | e09921f | 2017-12-07 17:49:00 +0100 | [diff] [blame] | 264 | var IPA_CCM_Parameters g_ccm_pars := c_IPA_default_ccm_pars; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 265 | } |
| 266 | |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 267 | type record IPA_CCM_Parameters { |
| 268 | charstring ser_nr optional, |
| 269 | charstring name optional, |
| 270 | charstring location1 optional, |
| 271 | charstring location2 optional, |
| 272 | charstring equip_version optional, |
| 273 | charstring sw_version optional, |
| 274 | charstring ip_addr optional, |
| 275 | charstring mac_addr optional, |
| 276 | charstring unit_id optional, |
| 277 | charstring osmo_rand optional |
| 278 | } |
| 279 | |
Harald Welte | e09921f | 2017-12-07 17:49:00 +0100 | [diff] [blame] | 280 | const IPA_CCM_Parameters c_IPA_default_ccm_pars := { |
| 281 | ser_nr := "", |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 282 | name := "mahlzeit", |
Harald Welte | e09921f | 2017-12-07 17:49:00 +0100 | [diff] [blame] | 283 | location1 := "", |
| 284 | location2 := "", |
| 285 | equip_version := "", |
| 286 | sw_version := "", |
| 287 | ip_addr := "", |
| 288 | mac_addr := "", |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 289 | unit_id := "0/1/2", |
Harald Welte | e09921f | 2017-12-07 17:49:00 +0100 | [diff] [blame] | 290 | osmo_rand := "" |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 291 | }; |
| 292 | |
Pau Espin Pedrol | af0c61e | 2022-01-11 12:48:34 +0100 | [diff] [blame] | 293 | signature IPA_CFG_disconnect(inout IPL4asp_Types.Result res); |
| 294 | type port IPA_CFG_PT procedure { |
| 295 | inout IPA_CFG_disconnect; |
| 296 | } with { extension "internal" }; |
| 297 | |
| 298 | function f_ipa_cfg_disconnect(IPA_CFG_PT pt, inout IPL4asp_Types.Result res) { |
| 299 | pt.call(IPA_CFG_disconnect:{res}) { |
| 300 | [] pt.getreply(IPA_CFG_disconnect:{?}) -> param (res) {}; |
| 301 | } |
| 302 | } |
| 303 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 304 | /* Function to use to connect as client to a remote IPA Server */ |
Stefan Sperling | 830dc9d | 2018-02-12 21:08:28 +0100 | [diff] [blame] | 305 | function f_connect(charstring remote_host, IPL4asp_Types.PortNumber remote_port, |
| 306 | charstring local_host, IPL4asp_Types.PortNumber local_port, |
Harald Welte | e09921f | 2017-12-07 17:49:00 +0100 | [diff] [blame] | 307 | 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] | 308 | var IPL4asp_Types.Result res; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 309 | res := IPA_CodecPort_CtrlFunct.f_IPL4_connect(IPA_PORT, remote_host, remote_port, |
| 310 | local_host, local_port, 0, { tcp:={} }); |
Harald Welte | 9220f63 | 2018-05-23 20:27:02 +0200 | [diff] [blame] | 311 | if (not ispresent(res.connId)) { |
Stefan Sperling | 6a90be4 | 2018-08-31 15:05:39 +0200 | [diff] [blame] | 312 | setverdict(fail, "Could not connect IPA socket from ", local_host, " port ", local_port, |
| 313 | " to ", remote_host, " port ", remote_port, "; check your configuration"); |
Daniel Willmann | e4ff537 | 2018-07-05 17:35:03 +0200 | [diff] [blame] | 314 | mtc.stop; |
Harald Welte | 9220f63 | 2018-05-23 20:27:02 +0200 | [diff] [blame] | 315 | } |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 316 | g_self_conn_id := res.connId; |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 317 | g_ccm_pars := ccm_pars; |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 318 | g_is_bsc_mgw := true; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 319 | } |
| 320 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 321 | /* 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] | 322 | function f_bind(charstring local_host, IPL4asp_Types.PortNumber local_port, |
Harald Welte | e09921f | 2017-12-07 17:49:00 +0100 | [diff] [blame] | 323 | 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] | 324 | var IPL4asp_Types.Result res; |
Pau Espin Pedrol | 76ba541 | 2019-06-10 11:00:33 +0200 | [diff] [blame] | 325 | res := IPA_CodecPort_CtrlFunct.f_IPL4_listen(IPA_PORT, |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 326 | local_host, local_port, { tcp:={} }); |
Harald Welte | 9220f63 | 2018-05-23 20:27:02 +0200 | [diff] [blame] | 327 | if (not ispresent(res.connId)) { |
Max | b7aae8b | 2019-03-11 15:22:02 +0100 | [diff] [blame] | 328 | 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] | 329 | mtc.stop; |
Harald Welte | 9220f63 | 2018-05-23 20:27:02 +0200 | [diff] [blame] | 330 | } |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 331 | g_self_conn_id := res.connId; |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 332 | g_ccm_pars := ccm_pars; |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 333 | g_is_bsc_mgw := false; |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 334 | } |
| 335 | |
Pau Espin Pedrol | af0c61e | 2022-01-11 12:48:34 +0100 | [diff] [blame] | 336 | private function f_close() runs on IPA_Emulation_CT return IPL4asp_Types.Result { |
| 337 | var IPL4asp_Types.Result res; |
| 338 | select (g_mode) { |
| 339 | case (IPA_MODE_CLIENT) { |
| 340 | res := IPA_CodecPort_CtrlFunct.f_IPL4_close(IPA_PORT, g_self_conn_id, {tcp := {}}); |
| 341 | g_self_conn_id := -1; |
| 342 | } |
| 343 | case (IPA_MODE_SERVER) { |
| 344 | res := IPA_CodecPort_CtrlFunct.f_IPL4_close(IPA_PORT, g_last_conn_id, {tcp := {}}); |
| 345 | g_last_conn_id := -1; |
| 346 | } |
| 347 | case else { |
| 348 | setverdict(fail, "Unknown mode"); |
| 349 | mtc.stop; |
| 350 | } |
| 351 | } |
| 352 | return res; |
| 353 | } |
| 354 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 355 | #ifdef IPA_EMULATION_SCCP |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 356 | template ASP_MTP3_TRANSFERind ts_MTP3_XFER_ind(integer opc, octetstring data) := { |
| 357 | sio := { '10'B, '00'B, '0011'B }, |
| 358 | opc := opc, |
| 359 | dpc := 0, |
| 360 | sls := 0, |
| 361 | data := data |
| 362 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 363 | #endif |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 364 | |
| 365 | |
| 366 | private template IpaCcmRespPart t_IdRespPart(IpaCcmIdTag tag, charstring payload) := { |
| 367 | len := 0, /* overwritten by codec */ |
| 368 | tag := tag, |
Harald Welte | 95686e0 | 2018-08-02 15:05:43 +0200 | [diff] [blame] | 369 | data := char2oct(payload) & '00'O |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 370 | } |
| 371 | |
Vadim Yanitskiy | 61564be | 2020-05-18 20:44:14 +0700 | [diff] [blame] | 372 | 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] | 373 | if (IPA_SP_PORT.checkstate("Connected")) { |
| 374 | IPA_SP_PORT.send(evt); |
| 375 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 376 | #ifdef IPA_EMULATION_RSL |
Harald Welte | 5819b55 | 2017-12-09 02:55:46 +0100 | [diff] [blame] | 377 | if (IPA_RSL_PORT.checkstate("Connected")) { |
| 378 | IPA_RSL_PORT.send(evt); |
| 379 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 380 | #endif |
Harald Welte | c682666 | 2019-02-06 22:26:46 +0100 | [diff] [blame] | 381 | #ifdef IPA_EMULATION_OML |
| 382 | if (IPA_OML_PORT.checkstate("Connected")) { |
| 383 | IPA_OML_PORT.send(evt); |
| 384 | } |
| 385 | #endif |
Pau Espin Pedrol | acc5119 | 2019-06-11 15:35:19 +0200 | [diff] [blame] | 386 | #ifdef IPA_EMULATION_CTRL |
Harald Welte | 5819b55 | 2017-12-09 02:55:46 +0100 | [diff] [blame] | 387 | if (IPA_CTRL_PORT.checkstate("Connected")) { |
| 388 | IPA_CTRL_PORT.send(evt); |
| 389 | } |
Pau Espin Pedrol | acc5119 | 2019-06-11 15:35:19 +0200 | [diff] [blame] | 390 | #endif |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 391 | #ifdef IPA_EMULATION_GSUP |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 392 | if (IPA_GSUP_PORT.checkstate("Connected")) { |
| 393 | IPA_GSUP_PORT.send(evt); |
| 394 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 395 | #endif |
Harald Welte | 7460a72 | 2018-10-10 12:28:27 +0200 | [diff] [blame] | 396 | #ifdef IPA_EMULATION_RSPRO |
| 397 | if (IPA_RSPRO_PORT.checkstate("Connected")) { |
| 398 | IPA_RSPRO_PORT.send(evt); |
| 399 | } |
| 400 | #endif |
Pau Espin Pedrol | 6924ef7 | 2021-06-09 16:19:26 +0200 | [diff] [blame] | 401 | #ifdef IPA_EMULATION_OSMO_PCU |
| 402 | if (IPA_OSMO_PCU_PORT.checkstate("Connected")) { |
| 403 | IPA_OSMO_PCU_PORT.send(evt); |
| 404 | } |
| 405 | #endif |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 406 | /* FIXME: to other ports */ |
| 407 | } |
| 408 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 409 | /* build IPA CCM ID RESP response from IPA CCM GET */ |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 410 | 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] | 411 | var integer i; |
| 412 | var PDU_IPA_CCM resp := { |
| 413 | msg_type := IPAC_MSGT_ID_RESP, |
| 414 | u := { |
| 415 | resp := {} |
| 416 | } |
| 417 | } |
| 418 | |
Pau Espin Pedrol | 8768f66 | 2023-10-12 17:55:56 +0200 | [diff] [blame] | 419 | /* If no Tags were present in the received IPA message, .u = omit */ |
| 420 | if (not ispresent(get.u)) { |
| 421 | return resp; |
| 422 | } |
| 423 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 424 | for (i := 0; i < sizeof(get.u.get); i := i + 1) { |
| 425 | var IpaCcmIdTag tag := get.u.get[i].tag; |
| 426 | var charstring foo; |
| 427 | select (tag) { |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 428 | case (IPAC_IDTAG_SERNR) { |
| 429 | foo := g_ccm_pars.ser_nr; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 430 | } |
| 431 | case (IPAC_IDTAG_UNITNAME) { |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 432 | foo := g_ccm_pars.name; |
| 433 | } |
| 434 | case (IPAC_IDTAG_LOCATION1) { |
| 435 | foo := g_ccm_pars.location1; |
| 436 | } |
| 437 | case (IPAC_IDTAG_LOCATION2) { |
| 438 | foo := g_ccm_pars.location2; |
| 439 | } |
| 440 | case (IPAC_IDTAG_EQUIPVERS) { |
| 441 | foo := g_ccm_pars.equip_version; |
| 442 | } |
| 443 | case (IPAC_IDTAG_SWVERSION) { |
| 444 | foo := g_ccm_pars.sw_version; |
| 445 | } |
| 446 | case (IPAC_IDTAG_IPADDR) { |
| 447 | foo := g_ccm_pars.ip_addr; |
| 448 | } |
| 449 | case (IPAC_IDTAG_MACADDR) { |
| 450 | foo := g_ccm_pars.mac_addr; |
| 451 | } |
Vadim Yanitskiy | 44f0c48 | 2020-05-24 20:49:29 +0700 | [diff] [blame] | 452 | case (IPAC_IDTAG_UNITID) { |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 453 | foo := g_ccm_pars.unit_id; |
| 454 | } |
| 455 | case (IPAC_IDTAG_OSMO_RAND) { |
| 456 | foo := g_ccm_pars.osmo_rand; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 457 | } |
| 458 | case else { |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 459 | foo := "unknown"; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 460 | } |
| 461 | } |
| 462 | resp.u.resp[sizeof(resp.u.resp)] := valueof(t_IdRespPart(tag, foo)); |
| 463 | } |
| 464 | |
| 465 | return resp; |
| 466 | } |
| 467 | |
| 468 | /* transmit IPA CCM message */ |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 469 | private function f_ccm_tx(PDU_IPA_CCM ccm, IPL4asp_Types.ConnectionId conn_id) |
| 470 | runs on IPA_Emulation_CT { |
| 471 | var IPA_Send ipa_tx := valueof(t_IPA_Send(conn_id, IPAC_PROTO_CCM, enc_PDU_IPA_CCM(ccm))); |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 472 | log("CCM Tx:", ccm); |
| 473 | IPA_PORT.send(ipa_tx); |
| 474 | } |
| 475 | |
| 476 | template PDU_IPA_CCM ts_IPA_PONG := { |
| 477 | msg_type := IPAC_MSGT_PONG, |
| 478 | u := omit |
| 479 | } |
| 480 | |
| 481 | template PDU_IPA_CCM ts_IPA_ACK := { |
| 482 | msg_type := IPAC_MSGT_ID_ACK, |
| 483 | u := omit |
| 484 | } |
| 485 | |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 486 | template PDU_IPA_CCM ts_IPA_ID_GET := { |
| 487 | msg_type := IPAC_MSGT_ID_GET, |
| 488 | u := { |
| 489 | get := { |
Vadim Yanitskiy | 40ee56c | 2020-05-24 20:51:24 +0700 | [diff] [blame] | 490 | { 1, IPAC_IDTAG_UNITNAME }, |
| 491 | { 1, IPAC_IDTAG_UNITID } |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 492 | } |
| 493 | } |
| 494 | } |
| 495 | |
Vadim Yanitskiy | 11edf3c | 2020-05-24 22:26:54 +0700 | [diff] [blame] | 496 | template PDU_IPA_CCM tr_IPA_ID_RESP := { |
| 497 | msg_type := IPAC_MSGT_ID_RESP, |
| 498 | u := { |
| 499 | resp := { |
| 500 | { ?, IPAC_IDTAG_UNITNAME, ? }, |
| 501 | { ?, IPAC_IDTAG_UNITID, ? } |
| 502 | } |
| 503 | } |
| 504 | } |
| 505 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 506 | /* receive IPA CCM message */ |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 507 | 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] | 508 | select (ccm.msg_type) { |
| 509 | case (IPAC_MSGT_PING) { |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 510 | f_ccm_tx(valueof(ts_IPA_PONG), g_self_conn_id); |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 511 | } |
| 512 | case (IPAC_MSGT_ID_ACK) { |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 513 | f_send_IPA_EVT(ts_ASP_IPA_EV(ASP_IPA_EVENT_ID_ACK, g_self_conn_id)); |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 514 | } |
| 515 | case (IPAC_MSGT_ID_GET) { |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 516 | f_ccm_tx(f_ccm_make_id_resp(ccm), g_self_conn_id); |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 517 | } |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 518 | case else { |
| 519 | log("Unknown/unsupported IPA CCM message type", ccm); |
| 520 | } |
| 521 | } |
| 522 | } |
| 523 | |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 524 | private function f_ccm_rx_server(PDU_IPA_CCM ccm, IPL4asp_Types.ConnectionId conn_id) |
| 525 | runs on IPA_Emulation_CT { |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 526 | select (ccm.msg_type) { |
| 527 | case (IPAC_MSGT_PING) { |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 528 | f_ccm_tx(valueof(ts_IPA_PONG), conn_id); |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 529 | } |
| 530 | case (IPAC_MSGT_ID_ACK) { |
| 531 | /* the IPA server should at some point receive an ID_ACK from the client, |
| 532 | * in case of RSL/OML from nanoBTS, this is actually the first message after |
| 533 | * the TCP connection is established. Other implementations may differ. |
| 534 | * We currently ignore it completely - but actually we should make sure that |
| 535 | * one ID_ACK is received by the server at some point */ |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 536 | f_send_IPA_EVT(ts_ASP_IPA_EV(ASP_IPA_EVENT_ID_ACK, conn_id)); |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 537 | } |
Harald Welte | 3bc387f | 2018-02-21 12:18:46 +0100 | [diff] [blame] | 538 | case (IPAC_MSGT_ID_RESP) { |
| 539 | log("IPA ID RESP: ", ccm.u.resp); |
Vadim Yanitskiy | 11edf3c | 2020-05-24 22:26:54 +0700 | [diff] [blame] | 540 | |
| 541 | /* make sure that the response contains all fields we requested */ |
| 542 | if (not match(ccm, tr_IPA_ID_RESP)) { |
| 543 | log("IPA identity response ", ccm.u.resp, " mismatch"); |
| 544 | return; |
| 545 | } |
| 546 | |
| 547 | /* forward to the upper layers, so they can map conn_id with unit_id */ |
| 548 | f_send_IPA_EVT(ts_ASP_IPA_EV(ASP_IPA_EVENT_ID_RESP, conn_id, ccm.u.resp)); |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 549 | /* acknowledge any identity that the client may have sent */ |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 550 | f_ccm_tx(valueof(ts_IPA_ACK), conn_id); |
Harald Welte | 3bc387f | 2018-02-21 12:18:46 +0100 | [diff] [blame] | 551 | } |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 552 | case else { |
| 553 | log("Unknown/unsupported IPA CCM message type", ccm); |
| 554 | } |
| 555 | } |
| 556 | } |
| 557 | |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 558 | private function f_to_asp(IPA_RecvFrom ipa_rx) return ASP_IPA_Unitdata { |
| 559 | var ASP_IPA_Unitdata ret := { |
| 560 | streamId := ipa_rx.streamId, |
Harald Welte | 2a8f847 | 2017-11-23 21:11:34 +0100 | [diff] [blame] | 561 | streamIdExt := ipa_rx.streamIdExt, |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 562 | payload := ipa_rx.msg |
| 563 | } |
| 564 | return ret; |
| 565 | } |
| 566 | |
Stefan Sperling | 830dc9d | 2018-02-12 21:08:28 +0100 | [diff] [blame] | 567 | 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] | 568 | var IPA_Send ret := valueof(t_IPA_Send(connId, ipa_tx.streamId, ipa_tx.payload, |
| 569 | ipa_tx.streamIdExt)); |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 570 | return ret; |
| 571 | } |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 572 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 573 | #ifdef IPA_EMULATION_RSL |
Stefan Sperling | 830dc9d | 2018-02-12 21:08:28 +0100 | [diff] [blame] | 574 | 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] | 575 | var octetstring payload := enc_RSL_Message(rsl_tx.rsl); |
Vadim Yanitskiy | ef9bcd2 | 2020-05-25 19:01:04 +0700 | [diff] [blame] | 576 | |
| 577 | /* ASP_RSL_Unitdata may (optionally) contain TCP/IP connection ID */ |
| 578 | if (rsl_tx.conn_id != omit) { |
| 579 | connId := rsl_tx.conn_id; |
| 580 | } |
| 581 | |
| 582 | return valueof(t_IPA_Send(connId, rsl_tx.streamId, payload)); |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 583 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 584 | #endif |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 585 | |
Harald Welte | c682666 | 2019-02-06 22:26:46 +0100 | [diff] [blame] | 586 | #ifdef IPA_EMULATION_OML |
| 587 | private function f_from_oml(IPL4asp_Types.ConnectionId connId, OML_PDU oml_tx) return IPA_Send { |
| 588 | var octetstring payload := enc_OML_PDU(oml_tx); |
| 589 | var IPA_Send ret := valueof(t_IPA_Send(connId, IPAC_PROTO_OML, payload)); |
| 590 | return ret; |
| 591 | } |
| 592 | #endif |
| 593 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 594 | /* main function to use for a client-side IPA implementation */ |
Stefan Sperling | 830dc9d | 2018-02-12 21:08:28 +0100 | [diff] [blame] | 595 | function main_client(charstring remote_host, IPL4asp_Types.PortNumber remote_port, |
| 596 | charstring local_host, IPL4asp_Types.PortNumber local_port, |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 597 | IPA_CCM_Parameters ccm_pars := c_IPA_default_ccm_pars, |
| 598 | boolean ccm_enabled := true) runs on IPA_Emulation_CT { |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 599 | g_mode := IPA_MODE_CLIENT; |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 600 | g_ccm_enabled := ccm_enabled; |
Harald Welte | e09921f | 2017-12-07 17:49:00 +0100 | [diff] [blame] | 601 | f_connect(remote_host, remote_port, local_host, local_port, ccm_pars); |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 602 | if (g_ccm_enabled) { |
| 603 | /* we're a client: Send ID_ACK immediately after connect */ |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 604 | f_ccm_tx(valueof(ts_IPA_ACK), g_self_conn_id); |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 605 | } |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 606 | f_send_IPA_EVT(ts_ASP_IPA_EV(ASP_IPA_EVENT_UP, g_self_conn_id)); |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 607 | ScanEvents(); |
| 608 | } |
| 609 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 610 | /* main function to use for a server-side IPA implementation */ |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 611 | function main_server(charstring local_host, IPL4asp_Types.PortNumber local_port, |
Neels Hofmeyr | 3bf31d2 | 2018-08-24 14:44:32 +0200 | [diff] [blame] | 612 | boolean ccm_enabled := true, |
Pau Espin Pedrol | 2dc137c | 2021-01-28 19:53:21 +0100 | [diff] [blame] | 613 | IpaInitBehavior init_behavior := IPA_INIT_SEND_IPA_ID_GET, |
| 614 | boolean server_stop_on_ipa_ev_down := true) |
Neels Hofmeyr | 3bf31d2 | 2018-08-24 14:44:32 +0200 | [diff] [blame] | 615 | runs on IPA_Emulation_CT { |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 616 | g_mode := IPA_MODE_SERVER; |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 617 | g_ccm_enabled := ccm_enabled; |
Neels Hofmeyr | 3bf31d2 | 2018-08-24 14:44:32 +0200 | [diff] [blame] | 618 | g_init_behavior := init_behavior; |
Pau Espin Pedrol | 2dc137c | 2021-01-28 19:53:21 +0100 | [diff] [blame] | 619 | g_server_stop_on_ipa_ev_down := server_stop_on_ipa_ev_down; |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 620 | f_bind(local_host, local_port); |
| 621 | ScanEvents(); |
| 622 | } |
| 623 | |
Pau Espin Pedrol | acc5119 | 2019-06-11 15:35:19 +0200 | [diff] [blame] | 624 | #ifdef IPA_EMULATION_CTRL |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 625 | private function f_ctrl_to_user(octetstring msg) runs on IPA_Emulation_CT { |
| 626 | var charstring msg_ch := oct2char(msg); |
| 627 | IPA_CTRL_PORT.send(dec_CtrlMessage(msg_ch)); |
| 628 | } |
Pau Espin Pedrol | acc5119 | 2019-06-11 15:35:19 +0200 | [diff] [blame] | 629 | #endif |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 630 | |
| 631 | #ifdef IPA_EMULATION_GSUP |
| 632 | private function f_gsup_to_user(octetstring msg) runs on IPA_Emulation_CT { |
| 633 | var GSUP_PDU gsup := dec_GSUP_PDU(msg); |
| 634 | f_gsup_postprocess_decoded(gsup); |
| 635 | IPA_GSUP_PORT.send(gsup); |
| 636 | } |
| 637 | #endif |
| 638 | |
Harald Welte | 7460a72 | 2018-10-10 12:28:27 +0200 | [diff] [blame] | 639 | #ifdef IPA_EMULATION_RSPRO |
| 640 | private function f_rspro_to_user(octetstring msg) runs on IPA_Emulation_CT { |
| 641 | var RsproPDU rspro := dec_RsproPDU(msg); |
| 642 | IPA_RSPRO_PORT.send(rspro); |
| 643 | } |
| 644 | #endif |
| 645 | |
Pau Espin Pedrol | 6924ef7 | 2021-06-09 16:19:26 +0200 | [diff] [blame] | 646 | #ifdef IPA_EMULATION_OSMO_PCU |
| 647 | private function f_osmo_pcu_to_user(octetstring msg) runs on IPA_Emulation_CT { |
| 648 | var PCUIF_Message pcuif_msg := dec_PCUIF_Message(msg); |
| 649 | IPA_OSMO_PCU_PORT.send(pcuif_msg); |
| 650 | } |
| 651 | #endif |
| 652 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 653 | #ifdef IPA_EMULATION_MGCP |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 654 | private function f_mgcp_to_user(octetstring msg) runs on IPA_Emulation_CT { |
| 655 | var charstring msg_ch := oct2char(msg); |
| 656 | if (g_is_bsc_mgw) { |
| 657 | log("============"); |
| 658 | log(msg_ch); |
| 659 | IPA_MGCP_PORT.send(dec_MgcpCommand(msg_ch)); |
| 660 | } else { |
| 661 | IPA_MGCP_PORT.send(dec_MgcpResponse(msg_ch)); |
| 662 | } |
| 663 | } |
| 664 | |
Harald Welte | 92632e1 | 2017-11-25 02:31:20 +0100 | [diff] [blame] | 665 | private function f_mgcp_to_ud(octetstring payload) runs on IPA_Emulation_CT return ASP_IPA_Unitdata { |
| 666 | if (mp_ipa_mgcp_uses_osmo_ext) { |
| 667 | return valueof(t_ASP_IPA_UD(IPAC_PROTO_MGCP_OLD, payload)); |
| 668 | } else { |
| 669 | return valueof(t_ASP_IPA_UD(IPAC_PROTO_OSMO, payload, IPAC_PROTO_EXT_MGCP)); |
| 670 | } |
| 671 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 672 | #endif |
Harald Welte | 92632e1 | 2017-11-25 02:31:20 +0100 | [diff] [blame] | 673 | |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 674 | /* Resolve TCP/IP connection identifier depending on g_mode */ |
| 675 | private function f_ipa_conn_id() runs on IPA_Emulation_CT |
| 676 | return IPL4asp_Types.ConnectionId { |
| 677 | var IPL4asp_Types.ConnectionId conn_id; |
| 678 | |
| 679 | select (g_mode) { |
| 680 | case (IPA_MODE_CLIENT) { conn_id := g_self_conn_id; } |
| 681 | case (IPA_MODE_SERVER) { conn_id := g_last_conn_id; } |
| 682 | case else { |
| 683 | setverdict(fail, "Unknown mode"); |
| 684 | mtc.stop; |
| 685 | } |
| 686 | } |
| 687 | |
| 688 | if (conn_id == -1) { /* Just to be sure */ |
| 689 | setverdict(fail, "Connection is not established"); |
| 690 | mtc.stop; |
| 691 | } |
| 692 | |
| 693 | return conn_id; |
| 694 | } |
| 695 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 696 | /* main loop function for both client and server. 'thread' of the component */ |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 697 | private function ScanEvents() runs on IPA_Emulation_CT { |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 698 | var IPA_RecvFrom ipa_rx; |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 699 | var ASP_Event asp_evt; |
Stefan Sperling | 830dc9d | 2018-02-12 21:08:28 +0100 | [diff] [blame] | 700 | var Socket_API_Definitions.PortEvent port_evt; |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 701 | var octetstring payload; |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 702 | var ASP_IPA_Unitdata ipa_ud; |
Pau Espin Pedrol | af0c61e | 2022-01-11 12:48:34 +0100 | [diff] [blame] | 703 | var IPL4asp_Types.Result res; |
Harald Welte | 3286eb3 | 2019-08-18 19:36:10 +0200 | [diff] [blame] | 704 | #ifdef IPA_EMULATION_CTRL |
| 705 | var CtrlMessage ctrl_msg; |
| 706 | #endif |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 707 | #ifdef IPA_EMULATION_SCCP |
| 708 | var ASP_MTP3_TRANSFERreq mtp_req; |
| 709 | #endif |
| 710 | #ifdef IPA_EMULATION_MGCP |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 711 | var MgcpCommand mgcp_cmd; |
| 712 | var MgcpResponse mgcp_rsp; |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 713 | #endif |
| 714 | #ifdef IPA_EMULATION_GSUP |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 715 | var GSUP_PDU gsup_msg; |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 716 | #endif |
| 717 | #ifdef IPA_EMULATION_RSL |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 718 | var ASP_RSL_Unitdata rsl; |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 719 | #endif |
Harald Welte | c682666 | 2019-02-06 22:26:46 +0100 | [diff] [blame] | 720 | #ifdef IPA_EMULATION_OML |
| 721 | var OML_PDU oml; |
| 722 | #endif |
Harald Welte | 7460a72 | 2018-10-10 12:28:27 +0200 | [diff] [blame] | 723 | #ifdef IPA_EMULATION_RSPRO |
| 724 | var RsproPDU rspro; |
| 725 | #endif |
Pau Espin Pedrol | 6924ef7 | 2021-06-09 16:19:26 +0200 | [diff] [blame] | 726 | #ifdef IPA_EMULATION_OSMO_PCU |
| 727 | var PCUIF_Message pcu; |
| 728 | #endif |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 729 | |
Harald Welte | 3e6ad89 | 2017-12-12 14:39:46 +0100 | [diff] [blame] | 730 | /* Set function for dissecting the binary */ |
| 731 | var f_IPL4_getMsgLen vl_f := refers(f_IPL4_fixedMsgLen); |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 732 | IPA_CodecPort_CtrlFunct.f_IPL4_setGetMsgLen(IPA_PORT, g_self_conn_id, vl_f, {0, 2, 3, 1, 0}); |
Harald Welte | 3e6ad89 | 2017-12-12 14:39:46 +0100 | [diff] [blame] | 733 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 734 | while (true) { |
| 735 | alt { |
| 736 | /* Received IPA -> up into SCCP stack */ |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 737 | [g_ccm_enabled] IPA_PORT.receive(IPA_RecvFrom:{?,IPAC_PROTO_CCM,omit,?}) -> value ipa_rx { |
| 738 | var PDU_IPA_CCM ccm := dec_PDU_IPA_CCM(ipa_rx.msg); |
| 739 | log("CCM Rx:", ccm); |
| 740 | select (g_mode) { |
| 741 | case (IPA_MODE_CLIENT) { |
| 742 | f_ccm_rx_client(ccm); |
| 743 | } |
| 744 | case (IPA_MODE_SERVER) { |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 745 | f_ccm_rx_server(ccm, ipa_rx.connId); |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 746 | } |
| 747 | case else { |
| 748 | setverdict(fail, "Unknown mode"); |
Daniel Willmann | e4ff537 | 2018-07-05 17:35:03 +0200 | [diff] [blame] | 749 | mtc.stop; |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 750 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 751 | } |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 752 | } |
| 753 | [] IPA_PORT.receive(IPA_RecvFrom:?) -> value ipa_rx { |
| 754 | select (ipa_rx.streamId) { |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 755 | #ifdef IPA_EMULATION_SCCP |
| 756 | case (IPAC_PROTO_SCCP) { |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 757 | var ASP_MTP3_TRANSFERind mtp; |
| 758 | mtp := valueof(ts_MTP3_XFER_ind(0, ipa_rx.msg)); |
| 759 | MTP3_SP_PORT.send(mtp); |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 760 | } |
| 761 | #endif |
| 762 | #ifdef IPA_EMULATION_MGCP |
| 763 | case (IPAC_PROTO_MGCP_OLD) { |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 764 | f_mgcp_to_user(ipa_rx.msg); |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 765 | } |
| 766 | #endif |
| 767 | #ifdef IPA_EMULATION_RSL |
| 768 | case (t_IpaSidRSL) { |
Vadim Yanitskiy | ef9bcd2 | 2020-05-25 19:01:04 +0700 | [diff] [blame] | 769 | rsl := valueof(ts_ASP_RSL_UD( |
| 770 | rsl := dec_RSL_Message(ipa_rx.msg), |
| 771 | sid := ipa_rx.streamId, |
| 772 | conn_id := ipa_rx.connId |
| 773 | )); |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 774 | IPA_RSL_PORT.send(rsl); |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 775 | } |
| 776 | #endif |
Harald Welte | c682666 | 2019-02-06 22:26:46 +0100 | [diff] [blame] | 777 | #ifdef IPA_EMULATION_OML |
| 778 | case (IPAC_PROTO_OML) { |
| 779 | oml := dec_OML_PDU(ipa_rx.msg) |
| 780 | IPA_OML_PORT.send(oml); |
| 781 | } |
| 782 | #endif |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 783 | case (IPAC_PROTO_OSMO) { |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 784 | select (ipa_rx.streamIdExt) { |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 785 | #ifdef IPA_EMULATION_MGCP |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 786 | case (IPAC_PROTO_EXT_MGCP) { |
| 787 | f_mgcp_to_user(ipa_rx.msg); |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 788 | } |
| 789 | #endif |
Harald Welte | 3286eb3 | 2019-08-18 19:36:10 +0200 | [diff] [blame] | 790 | #ifdef IPA_EMULATION_CTRL |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 791 | case (IPAC_PROTO_EXT_CTRL) { |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 792 | f_ctrl_to_user(ipa_rx.msg); |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 793 | } |
Harald Welte | 3286eb3 | 2019-08-18 19:36:10 +0200 | [diff] [blame] | 794 | #endif |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 795 | #ifdef IPA_EMULATION_GSUP |
| 796 | case (IPAC_PROTO_EXT_GSUP) { |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 797 | f_gsup_to_user(ipa_rx.msg); |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 798 | } |
| 799 | #endif |
Harald Welte | 7460a72 | 2018-10-10 12:28:27 +0200 | [diff] [blame] | 800 | #ifdef IPA_EMULATION_RSPRO |
| 801 | case (IPAC_PROTO_EXT_RSPRO) { |
| 802 | f_rspro_to_user(ipa_rx.msg); |
| 803 | } |
| 804 | #endif |
Pau Espin Pedrol | 6924ef7 | 2021-06-09 16:19:26 +0200 | [diff] [blame] | 805 | #ifdef IPA_EMULATION_OSMO_PCU |
| 806 | case (IPAC_PROTO_EXT_OSMO_PCU) { |
| 807 | f_osmo_pcu_to_user(ipa_rx.msg); |
| 808 | } |
| 809 | #endif |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 810 | case else { |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 811 | IPA_SP_PORT.send(f_to_asp(ipa_rx)); |
| 812 | } |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 813 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 814 | } |
| 815 | case else { |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 816 | IPA_SP_PORT.send(f_to_asp(ipa_rx)); |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 817 | } |
| 818 | } |
| 819 | } |
| 820 | |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 821 | /* server only */ |
| 822 | [] IPA_PORT.receive(ASP_Event:{connOpened:=?}) -> value asp_evt { |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 823 | g_last_conn_id := asp_evt.connOpened.connId; |
| 824 | log("Established a new IPA connection (conn_id=", g_last_conn_id, ")"); |
| 825 | |
| 826 | f_send_IPA_EVT(ts_ASP_IPA_EV(ASP_IPA_EVENT_UP, g_last_conn_id)); |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 827 | if (g_mode == IPA_MODE_SERVER and g_ccm_enabled) { |
Neels Hofmeyr | 3bf31d2 | 2018-08-24 14:44:32 +0200 | [diff] [blame] | 828 | select (g_init_behavior) { |
| 829 | case (IPA_INIT_SEND_IPA_ID_GET) { |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 830 | f_ccm_tx(valueof(ts_IPA_ID_GET), g_last_conn_id); |
Neels Hofmeyr | 3bf31d2 | 2018-08-24 14:44:32 +0200 | [diff] [blame] | 831 | } |
| 832 | case (IPA_INIT_SEND_IPA_ID_ACK) { |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 833 | f_ccm_tx(valueof(ts_IPA_ACK), g_last_conn_id); |
Neels Hofmeyr | 3bf31d2 | 2018-08-24 14:44:32 +0200 | [diff] [blame] | 834 | } |
| 835 | } |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 836 | } |
| 837 | } |
| 838 | |
| 839 | [] IPA_PORT.receive(ASP_Event:{connClosed:=?}) -> value asp_evt { |
| 840 | log("IPA: Closed"); |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 841 | g_self_conn_id := -1; |
| 842 | f_send_IPA_EVT(ts_ASP_IPA_EV(ASP_IPA_EVENT_DOWN, asp_evt.connClosed.connId)); |
Pau Espin Pedrol | 2dc137c | 2021-01-28 19:53:21 +0100 | [diff] [blame] | 843 | if (g_mode != IPA_MODE_SERVER or g_server_stop_on_ipa_ev_down) { |
| 844 | self.stop; |
| 845 | } |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 846 | } |
| 847 | |
Stefan Sperling | 830dc9d | 2018-02-12 21:08:28 +0100 | [diff] [blame] | 848 | [] IPA_PORT.receive(Socket_API_Definitions.PortEvent:{result:={errorCode:=ERROR_SOCKET, connId:=?, os_error_code:=?, os_error_text:=?}}) -> value port_evt { |
| 849 | log("PortEvent: ERROR_SOCKET: ", port_evt); |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 850 | g_self_conn_id := -1; |
| 851 | f_send_IPA_EVT(ts_ASP_IPA_EV(ASP_IPA_EVENT_DOWN, port_evt.result.connId)); |
Stefan Sperling | 830dc9d | 2018-02-12 21:08:28 +0100 | [diff] [blame] | 852 | self.stop; |
| 853 | } |
| 854 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 855 | #ifdef IPA_EMULATION_SCCP |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 856 | /* Received SCCP -> down into IPA */ |
| 857 | [] MTP3_SP_PORT.receive(ASP_MTP3_TRANSFERreq: ?) -> value mtp_req { |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 858 | var IPA_Send ipa_tx := valueof(t_IPA_Send(f_ipa_conn_id(), IPAC_PROTO_SCCP, |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 859 | mtp_req.data)); |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 860 | IPA_PORT.send(ipa_tx); |
| 861 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 862 | #endif |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 863 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 864 | #ifdef IPA_EMULATION_MGCP |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 865 | /* Received MGCP -> down into IPA */ |
| 866 | [] IPA_MGCP_PORT.receive(MgcpCommand:?) -> value mgcp_cmd { |
Harald Welte | 92632e1 | 2017-11-25 02:31:20 +0100 | [diff] [blame] | 867 | payload := char2oct(enc_MgcpCommand(mgcp_cmd)); |
| 868 | ipa_ud := f_mgcp_to_ud(payload); |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 869 | IPA_PORT.send(f_from_asp(f_ipa_conn_id(), ipa_ud)); |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 870 | } |
| 871 | [] IPA_MGCP_PORT.receive(MgcpResponse:?) -> value mgcp_rsp { |
Harald Welte | 1dd8f37 | 2017-11-25 02:25:27 +0100 | [diff] [blame] | 872 | payload := char2oct(enc_MgcpResponse(mgcp_rsp)); |
Harald Welte | 92632e1 | 2017-11-25 02:31:20 +0100 | [diff] [blame] | 873 | ipa_ud := f_mgcp_to_ud(payload); |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 874 | IPA_PORT.send(f_from_asp(f_ipa_conn_id(), ipa_ud)); |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 875 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 876 | #endif |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 877 | |
Pau Espin Pedrol | acc5119 | 2019-06-11 15:35:19 +0200 | [diff] [blame] | 878 | #ifdef IPA_EMULATION_CTRL |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 879 | [] IPA_CTRL_PORT.receive(CtrlMessage:?) -> value ctrl_msg { |
| 880 | payload := char2oct(enc_CtrlMessage(ctrl_msg)); |
| 881 | ipa_ud := valueof(t_ASP_IPA_UD(IPAC_PROTO_OSMO, payload, IPAC_PROTO_EXT_CTRL)); |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 882 | IPA_PORT.send(f_from_asp(f_ipa_conn_id(), ipa_ud)); |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 883 | } |
Pau Espin Pedrol | acc5119 | 2019-06-11 15:35:19 +0200 | [diff] [blame] | 884 | #endif |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 885 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 886 | #ifdef IPA_EMULATION_GSUP |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 887 | [] IPA_GSUP_PORT.receive(GSUP_PDU:?) -> value gsup_msg { |
Harald Welte | 2f562b1 | 2018-01-24 20:52:38 +0100 | [diff] [blame] | 888 | f_gsup_preprocess_encoded(gsup_msg); |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 889 | payload := enc_GSUP_PDU(gsup_msg); |
| 890 | ipa_ud := valueof(t_ASP_IPA_UD(IPAC_PROTO_OSMO, payload, IPAC_PROTO_EXT_GSUP)); |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 891 | IPA_PORT.send(f_from_asp(f_ipa_conn_id(), ipa_ud)); |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 892 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 893 | #endif |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 894 | |
Harald Welte | 7460a72 | 2018-10-10 12:28:27 +0200 | [diff] [blame] | 895 | #ifdef IPA_EMULATION_RSPRO |
| 896 | [] IPA_RSPRO_PORT.receive(RsproPDU:?) -> value rspro { |
| 897 | payload := enc_RsproPDU(rspro); |
| 898 | ipa_ud := valueof(t_ASP_IPA_UD(IPAC_PROTO_OSMO, payload, IPAC_PROTO_EXT_RSPRO)); |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 899 | IPA_PORT.send(f_from_asp(f_ipa_conn_id(), ipa_ud)); |
Harald Welte | 7460a72 | 2018-10-10 12:28:27 +0200 | [diff] [blame] | 900 | } |
| 901 | #endif |
| 902 | |
Pau Espin Pedrol | 6924ef7 | 2021-06-09 16:19:26 +0200 | [diff] [blame] | 903 | #ifdef IPA_EMULATION_OSMO_PCU |
| 904 | [] IPA_OSMO_PCU_PORT.receive(PCUIF_Message:?) -> value pcu { |
| 905 | payload := enc_PCUIF_Message(pcu); |
| 906 | ipa_ud := valueof(t_ASP_IPA_UD(IPAC_PROTO_OSMO, payload, IPAC_PROTO_EXT_OSMO_PCU)); |
| 907 | IPA_PORT.send(f_from_asp(f_ipa_conn_id(), ipa_ud)); |
| 908 | } |
| 909 | #endif |
| 910 | |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 911 | #ifdef IPA_EMULATION_RSL |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 912 | /* Received RSL -> down into IPA */ |
| 913 | [] IPA_RSL_PORT.receive(ASP_RSL_Unitdata:?) -> value rsl { |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 914 | IPA_PORT.send(f_from_rsl(f_ipa_conn_id(), rsl)); |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 915 | } |
Harald Welte | df27725 | 2018-02-20 15:49:30 +0100 | [diff] [blame] | 916 | #endif |
Harald Welte | c682666 | 2019-02-06 22:26:46 +0100 | [diff] [blame] | 917 | #ifdef IPA_EMULATION_OML |
| 918 | /* Received OML -> down into IPA */ |
| 919 | [] IPA_OML_PORT.receive(OML_PDU:?) -> value oml { |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 920 | IPA_PORT.send(f_from_oml(f_ipa_conn_id(), oml)); |
Harald Welte | c682666 | 2019-02-06 22:26:46 +0100 | [diff] [blame] | 921 | } |
| 922 | [] IPA_OML_PORT.receive(octetstring:?) -> value payload { |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 923 | IPA_PORT.send(t_IPA_Send(f_ipa_conn_id(), IPAC_PROTO_OML, payload)); |
Harald Welte | c682666 | 2019-02-06 22:26:46 +0100 | [diff] [blame] | 924 | } |
| 925 | #endif |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 926 | /* Received MISC (OML/CTRL) -> down into IPA */ |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 927 | [] IPA_SP_PORT.receive(ASP_IPA_Unitdata: ?) -> value ipa_ud { |
Vadim Yanitskiy | 6643e8d | 2020-05-18 21:50:12 +0700 | [diff] [blame] | 928 | IPA_PORT.send(f_from_asp(f_ipa_conn_id(), ipa_ud)); |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 929 | } |
| 930 | |
Pau Espin Pedrol | af0c61e | 2022-01-11 12:48:34 +0100 | [diff] [blame] | 931 | /* Received call to configure/operate the component */ |
| 932 | [] CFG_PORT.getcall(IPA_CFG_disconnect:{?}) { |
| 933 | res := f_close(); |
| 934 | CFG_PORT.reply(IPA_CFG_disconnect:{res}); |
| 935 | } |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 936 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 937 | } |
| 938 | } |
| 939 | } |
| 940 | |
Harald Welte | 2e32e43 | 2018-05-24 20:00:00 +0200 | [diff] [blame] | 941 | /*********************************************************************** |
| 942 | * IPA Event waiter component. Wait for ASP_IPA_EVENT_ID_ACK |
| 943 | ***********************************************************************/ |
| 944 | |
| 945 | type component IPA_EventWaiter_CT { |
| 946 | port IPA_SP_PT IPA_SP_PORT; |
| 947 | } |
| 948 | |
Vadim Yanitskiy | 61564be | 2020-05-18 20:44:14 +0700 | [diff] [blame] | 949 | 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] | 950 | runs on IPA_EventWaiter_CT { |
| 951 | |
| 952 | alt { |
| 953 | [] IPA_SP_PORT.receive(wait_for) { |
| 954 | setverdict(pass); |
| 955 | } |
| 956 | [] IPA_SP_PORT.receive { repeat; } |
| 957 | } |
| 958 | } |
| 959 | |
| 960 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 961 | } |