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 |
Harald Welte | 35bb716 | 2018-01-03 21:07:52 +0100 | [diff] [blame] | 5 | * handshake for establishing the identity of the client to the server. |
| 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 | * |
| 11 | * (C) 2017 by Harald Welte <laforge@gnumonks.org> |
| 12 | * All rights reserved. |
| 13 | * |
| 14 | * Released under the terms of GNU General Public License, Version 2 or |
| 15 | * (at your option) any later version. |
| 16 | */ |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 17 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 18 | import from IPA_Types all; |
| 19 | import from IPA_CodecPort all; |
| 20 | import from IPA_CodecPort_CtrlFunct all; |
| 21 | import from IPL4asp_Types all; |
Harald Welte | 1218883 | 2017-11-29 11:47:13 +0100 | [diff] [blame] | 22 | import from IPL4asp_PortType all; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 23 | import from MTP3asp_Types all; |
| 24 | import from MTP3asp_PortType all; |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 25 | import from RSL_Types all; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 26 | |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 27 | import from MGCP_Types all; |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 28 | import from GSUP_Types all; |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 29 | |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 30 | import from Osmocom_CTRL_Types all; |
| 31 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 32 | modulepar { |
Harald Welte | 92632e1 | 2017-11-25 02:31:20 +0100 | [diff] [blame] | 33 | /* Use Osmocom extended IPA mux header */ |
| 34 | boolean mp_ipa_mgcp_uses_osmo_ext := true; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 35 | } |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 36 | |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 37 | type enumerated IpaMode { |
| 38 | IPA_MODE_CLIENT, |
| 39 | IPA_MODE_SERVER |
| 40 | } |
| 41 | |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 42 | type record ASP_IPA_Unitdata { |
| 43 | IpaStreamId streamId, |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 44 | IpaExtStreamId streamIdExt optional, |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 45 | octetstring payload |
| 46 | } |
| 47 | |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 48 | type enumerated ASP_IPA_EventUpDown { |
| 49 | ASP_IPA_EVENT_DOWN, |
| 50 | ASP_IPA_EVENT_UP, |
| 51 | ASP_IPA_EVENT_ID_ACK |
| 52 | } |
| 53 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 54 | /* an event indicating us whether or not a connection is physically up or down, |
| 55 | * and whether we have received an ID_ACK */ |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 56 | type union ASP_IPA_Event { |
| 57 | ASP_IPA_EventUpDown up_down |
| 58 | } |
| 59 | |
| 60 | template ASP_IPA_Event t_ASP_IPA_EVT_UD(ASP_IPA_EventUpDown ud) := { |
| 61 | up_down := ud |
| 62 | } |
| 63 | |
Harald Welte | 1dd8f37 | 2017-11-25 02:25:27 +0100 | [diff] [blame] | 64 | template ASP_IPA_Unitdata t_ASP_IPA_UD(IpaStreamId sid, octetstring pl, |
| 65 | template IpaExtStreamId esid := omit) := { |
| 66 | streamId := sid, |
| 67 | streamIdExt := esid, |
| 68 | payload := pl |
| 69 | } |
| 70 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 71 | /* 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] | 72 | type record ASP_RSL_Unitdata { |
| 73 | IpaStreamId streamId, |
| 74 | RSL_Message rsl |
| 75 | }; |
| 76 | |
Harald Welte | 7ae019e | 2017-12-09 00:54:15 +0100 | [diff] [blame] | 77 | template ASP_RSL_Unitdata ts_ASP_RSL_UD(IpaStreamId sid, template RSL_Message rsl) := { |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 78 | streamId := sid, |
| 79 | rsl := valueof(rsl) |
| 80 | } |
| 81 | |
Harald Welte | 7ae019e | 2017-12-09 00:54:15 +0100 | [diff] [blame] | 82 | template ASP_RSL_Unitdata tr_ASP_RSL_UD(IpaStreamId sid, template RSL_Message rsl) := { |
| 83 | streamId := sid, |
| 84 | rsl := rsl |
| 85 | } |
| 86 | |
| 87 | |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 88 | template IpaStreamId t_IpaSidRSL := ( IPAC_PROTO_RSL_TRX0, IPAC_PROTO_RSL_TRX1, |
| 89 | IPAC_PROTO_RSL_TRX2, IPAC_PROTO_RSL_TRX3 ); |
| 90 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 91 | /* Client port for general IPA messages, not further decoded */ |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 92 | type port IPA_SP_PT message { |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 93 | inout ASP_IPA_Unitdata, ASP_IPA_Event; |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 94 | } with { extension "internal" } |
| 95 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 96 | /* Client port for MGCP inside IPA */ |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 97 | type port IPA_MGCP_PT message { |
| 98 | inout MgcpCommand, MgcpResponse; |
| 99 | } with { extension "internal" } |
| 100 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 101 | /* Client port for A-bis RSL inside IPA */ |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 102 | type port IPA_RSL_PT message { |
| 103 | inout ASP_RSL_Unitdata, ASP_IPA_Event; |
| 104 | } with { extension "internal" } |
| 105 | |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 106 | /* Client port for CTRL inside IPA */ |
| 107 | type port IPA_CTRL_PT message { |
| 108 | inout CtrlMessage, ASP_IPA_Event; |
| 109 | } with { extension "internal" } |
| 110 | |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 111 | /* Client port for CTRL inside IPA */ |
| 112 | type port IPA_GSUP_PT message { |
| 113 | inout GSUP_PDU, ASP_IPA_Event; |
| 114 | } with { extension "internal" } |
| 115 | |
| 116 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 117 | type component IPA_Emulation_CT { |
| 118 | /* down-facing port to IPA codec port */ |
| 119 | port IPA_CODEC_PT IPA_PORT; |
| 120 | /* up-facing port to SCCP */ |
| 121 | port MTP3asp_SP_PT MTP3_SP_PORT; |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 122 | /* up-facing port for MGCP */ |
| 123 | port IPA_MGCP_PT IPA_MGCP_PORT; |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 124 | /* up-facing port for RSL */ |
| 125 | port IPA_RSL_PT IPA_RSL_PORT; |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 126 | /* up-facing port for CTRL */ |
| 127 | port IPA_CTRL_PT IPA_CTRL_PORT; |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 128 | /* up-facing port for GSUP */ |
| 129 | port IPA_GSUP_PT IPA_GSUP_PORT; |
| 130 | |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 131 | /* up-facing port for other streams */ |
| 132 | port IPA_SP_PT IPA_SP_PORT; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 133 | |
| 134 | var boolean g_initialized := false; |
| 135 | var ConnectionId g_ipa_conn_id := -1; |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 136 | /* Are we a BSC/MGW (truel) or MSC (false) */ |
| 137 | var boolean g_is_bsc_mgw; |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 138 | |
| 139 | var IpaMode g_mode; |
Harald Welte | e09921f | 2017-12-07 17:49:00 +0100 | [diff] [blame] | 140 | var IPA_CCM_Parameters g_ccm_pars := c_IPA_default_ccm_pars; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 141 | } |
| 142 | |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 143 | type record IPA_CCM_Parameters { |
| 144 | charstring ser_nr optional, |
| 145 | charstring name optional, |
| 146 | charstring location1 optional, |
| 147 | charstring location2 optional, |
| 148 | charstring equip_version optional, |
| 149 | charstring sw_version optional, |
| 150 | charstring ip_addr optional, |
| 151 | charstring mac_addr optional, |
| 152 | charstring unit_id optional, |
| 153 | charstring osmo_rand optional |
| 154 | } |
| 155 | |
Harald Welte | e09921f | 2017-12-07 17:49:00 +0100 | [diff] [blame] | 156 | const IPA_CCM_Parameters c_IPA_default_ccm_pars := { |
| 157 | ser_nr := "", |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 158 | name := "mahlzeit", |
Harald Welte | e09921f | 2017-12-07 17:49:00 +0100 | [diff] [blame] | 159 | location1 := "", |
| 160 | location2 := "", |
| 161 | equip_version := "", |
| 162 | sw_version := "", |
| 163 | ip_addr := "", |
| 164 | mac_addr := "", |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 165 | unit_id := "0/1/2", |
Harald Welte | e09921f | 2017-12-07 17:49:00 +0100 | [diff] [blame] | 166 | osmo_rand := "" |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 167 | }; |
| 168 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 169 | /* Function to use to connect as client to a remote IPA Server */ |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 170 | function f_connect(charstring remote_host, PortNumber remote_port, |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 171 | charstring local_host, PortNumber local_port, |
Harald Welte | e09921f | 2017-12-07 17:49:00 +0100 | [diff] [blame] | 172 | IPA_CCM_Parameters ccm_pars := c_IPA_default_ccm_pars) runs on IPA_Emulation_CT { |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 173 | var Result res; |
| 174 | res := IPA_CodecPort_CtrlFunct.f_IPL4_connect(IPA_PORT, remote_host, remote_port, |
| 175 | local_host, local_port, 0, { tcp:={} }); |
| 176 | g_ipa_conn_id := res.connId; |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 177 | g_ccm_pars := ccm_pars; |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 178 | g_is_bsc_mgw := true; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 179 | } |
| 180 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 181 | /* Function to use to bind to a local port as IPA server, accepting remote clients */ |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 182 | function f_bind(charstring local_host, PortNumber local_port, |
Harald Welte | e09921f | 2017-12-07 17:49:00 +0100 | [diff] [blame] | 183 | IPA_CCM_Parameters ccm_pars := c_IPA_default_ccm_pars) runs on IPA_Emulation_CT { |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 184 | var Result res; |
| 185 | res := IPA_CodecPort_CtrlFunct.f_IPL4_listen(IPA_PORT, |
| 186 | local_host, local_port, { tcp:={} }); |
| 187 | g_ipa_conn_id := res.connId; |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 188 | g_ccm_pars := ccm_pars; |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 189 | g_is_bsc_mgw := false; |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 190 | } |
| 191 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 192 | template ASP_MTP3_TRANSFERind ts_MTP3_XFER_ind(integer opc, octetstring data) := { |
| 193 | sio := { '10'B, '00'B, '0011'B }, |
| 194 | opc := opc, |
| 195 | dpc := 0, |
| 196 | sls := 0, |
| 197 | data := data |
| 198 | } |
| 199 | |
| 200 | |
| 201 | private template IpaCcmRespPart t_IdRespPart(IpaCcmIdTag tag, charstring payload) := { |
| 202 | len := 0, /* overwritten by codec */ |
| 203 | tag := tag, |
| 204 | data := payload |
| 205 | } |
| 206 | |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 207 | private function f_send_IPA_EVT(template ASP_IPA_Event evt) runs on IPA_Emulation_CT { |
Harald Welte | 5819b55 | 2017-12-09 02:55:46 +0100 | [diff] [blame] | 208 | if (IPA_RSL_PORT.checkstate("Connected")) { |
| 209 | IPA_RSL_PORT.send(evt); |
| 210 | } |
| 211 | if (IPA_CTRL_PORT.checkstate("Connected")) { |
| 212 | IPA_CTRL_PORT.send(evt); |
| 213 | } |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 214 | if (IPA_GSUP_PORT.checkstate("Connected")) { |
| 215 | IPA_GSUP_PORT.send(evt); |
| 216 | } |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 217 | /* FIXME: to other ports */ |
| 218 | } |
| 219 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 220 | /* build IPA CCM ID RESP response from IPA CCM GET */ |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 221 | 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] | 222 | var integer i; |
| 223 | var PDU_IPA_CCM resp := { |
| 224 | msg_type := IPAC_MSGT_ID_RESP, |
| 225 | u := { |
| 226 | resp := {} |
| 227 | } |
| 228 | } |
| 229 | |
| 230 | for (i := 0; i < sizeof(get.u.get); i := i + 1) { |
| 231 | var IpaCcmIdTag tag := get.u.get[i].tag; |
| 232 | var charstring foo; |
| 233 | select (tag) { |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 234 | case (IPAC_IDTAG_SERNR) { |
| 235 | foo := g_ccm_pars.ser_nr; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 236 | } |
| 237 | case (IPAC_IDTAG_UNITNAME) { |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 238 | foo := g_ccm_pars.name; |
| 239 | } |
| 240 | case (IPAC_IDTAG_LOCATION1) { |
| 241 | foo := g_ccm_pars.location1; |
| 242 | } |
| 243 | case (IPAC_IDTAG_LOCATION2) { |
| 244 | foo := g_ccm_pars.location2; |
| 245 | } |
| 246 | case (IPAC_IDTAG_EQUIPVERS) { |
| 247 | foo := g_ccm_pars.equip_version; |
| 248 | } |
| 249 | case (IPAC_IDTAG_SWVERSION) { |
| 250 | foo := g_ccm_pars.sw_version; |
| 251 | } |
| 252 | case (IPAC_IDTAG_IPADDR) { |
| 253 | foo := g_ccm_pars.ip_addr; |
| 254 | } |
| 255 | case (IPAC_IDTAG_MACADDR) { |
| 256 | foo := g_ccm_pars.mac_addr; |
| 257 | } |
| 258 | case (IPAC_IDTAG_UNIT) { |
| 259 | foo := g_ccm_pars.unit_id; |
| 260 | } |
| 261 | case (IPAC_IDTAG_OSMO_RAND) { |
| 262 | foo := g_ccm_pars.osmo_rand; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 263 | } |
| 264 | case else { |
Harald Welte | e21096d | 2017-12-04 20:45:12 +0100 | [diff] [blame] | 265 | foo := "unknown"; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 266 | } |
| 267 | } |
| 268 | resp.u.resp[sizeof(resp.u.resp)] := valueof(t_IdRespPart(tag, foo)); |
| 269 | } |
| 270 | |
| 271 | return resp; |
| 272 | } |
| 273 | |
| 274 | /* transmit IPA CCM message */ |
| 275 | 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] | 276 | 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] | 277 | log("CCM Tx:", ccm); |
| 278 | IPA_PORT.send(ipa_tx); |
| 279 | } |
| 280 | |
| 281 | template PDU_IPA_CCM ts_IPA_PONG := { |
| 282 | msg_type := IPAC_MSGT_PONG, |
| 283 | u := omit |
| 284 | } |
| 285 | |
| 286 | template PDU_IPA_CCM ts_IPA_ACK := { |
| 287 | msg_type := IPAC_MSGT_ID_ACK, |
| 288 | u := omit |
| 289 | } |
| 290 | |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 291 | template PDU_IPA_CCM ts_IPA_ID_GET := { |
| 292 | msg_type := IPAC_MSGT_ID_GET, |
| 293 | u := { |
| 294 | get := { |
| 295 | { 1, IPAC_IDTAG_UNITNAME } |
| 296 | } |
| 297 | } |
| 298 | } |
| 299 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 300 | /* receive IPA CCM message */ |
| 301 | private function f_ccm_rx(PDU_IPA_CCM ccm) runs on IPA_Emulation_CT { |
| 302 | select (ccm.msg_type) { |
| 303 | case (IPAC_MSGT_PING) { |
| 304 | f_ccm_tx(valueof(ts_IPA_PONG)); |
| 305 | } |
| 306 | case (IPAC_MSGT_ID_ACK) { |
| 307 | f_ccm_tx(valueof(ts_IPA_ACK)); |
| 308 | } |
| 309 | case (IPAC_MSGT_ID_GET) { |
| 310 | f_ccm_tx(f_ccm_make_id_resp(ccm)); |
| 311 | } |
| 312 | case else { |
| 313 | log("Unknown/unsupported IPA CCM message type", ccm); |
| 314 | } |
| 315 | } |
| 316 | } |
| 317 | |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 318 | private function f_to_asp(IPA_RecvFrom ipa_rx) return ASP_IPA_Unitdata { |
| 319 | var ASP_IPA_Unitdata ret := { |
| 320 | streamId := ipa_rx.streamId, |
Harald Welte | 2a8f847 | 2017-11-23 21:11:34 +0100 | [diff] [blame] | 321 | streamIdExt := ipa_rx.streamIdExt, |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 322 | payload := ipa_rx.msg |
| 323 | } |
| 324 | return ret; |
| 325 | } |
| 326 | |
| 327 | private function f_from_asp(ConnectionId connId, ASP_IPA_Unitdata ipa_tx) return IPA_Send { |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 328 | var IPA_Send ret := valueof(t_IPA_Send(connId, ipa_tx.streamId, ipa_tx.payload, |
| 329 | ipa_tx.streamIdExt)); |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 330 | return ret; |
| 331 | } |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 332 | |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 333 | private function f_from_rsl(ConnectionId connId, ASP_RSL_Unitdata rsl_tx) return IPA_Send { |
| 334 | var octetstring payload := enc_RSL_Message(rsl_tx.rsl); |
| 335 | var IPA_Send ret := valueof(t_IPA_Send(connId, rsl_tx.streamId, payload)); |
| 336 | return ret; |
| 337 | } |
| 338 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 339 | /* main function to use for a client-side IPA implementation */ |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 340 | function main_client(charstring remote_host, PortNumber remote_port, |
Harald Welte | e09921f | 2017-12-07 17:49:00 +0100 | [diff] [blame] | 341 | charstring local_host, PortNumber local_port, |
| 342 | IPA_CCM_Parameters ccm_pars := c_IPA_default_ccm_pars) runs on IPA_Emulation_CT { |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 343 | g_mode := IPA_MODE_CLIENT; |
Harald Welte | e09921f | 2017-12-07 17:49:00 +0100 | [diff] [blame] | 344 | f_connect(remote_host, remote_port, local_host, local_port, ccm_pars); |
Harald Welte | 03c0e56 | 2017-12-09 02:55:12 +0100 | [diff] [blame] | 345 | f_send_IPA_EVT(t_ASP_IPA_EVT_UD(ASP_IPA_EVENT_UP)); |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 346 | ScanEvents(); |
| 347 | } |
| 348 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 349 | /* main function to use for a server-side IPA implementation */ |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 350 | function main_server(charstring local_host, PortNumber local_port) runs on IPA_Emulation_CT { |
| 351 | g_mode := IPA_MODE_SERVER; |
| 352 | f_bind(local_host, local_port); |
| 353 | ScanEvents(); |
| 354 | } |
| 355 | |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 356 | private function f_mgcp_to_user(octetstring msg) runs on IPA_Emulation_CT { |
| 357 | var charstring msg_ch := oct2char(msg); |
| 358 | if (g_is_bsc_mgw) { |
| 359 | log("============"); |
| 360 | log(msg_ch); |
| 361 | IPA_MGCP_PORT.send(dec_MgcpCommand(msg_ch)); |
| 362 | } else { |
| 363 | IPA_MGCP_PORT.send(dec_MgcpResponse(msg_ch)); |
| 364 | } |
| 365 | } |
| 366 | |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 367 | private function f_ctrl_to_user(octetstring msg) runs on IPA_Emulation_CT { |
| 368 | var charstring msg_ch := oct2char(msg); |
| 369 | IPA_CTRL_PORT.send(dec_CtrlMessage(msg_ch)); |
| 370 | } |
| 371 | |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 372 | private function f_gsup_to_user(octetstring msg) runs on IPA_Emulation_CT { |
Harald Welte | 2f562b1 | 2018-01-24 20:52:38 +0100 | [diff] [blame] | 373 | var GSUP_PDU gsup := dec_GSUP_PDU(msg); |
| 374 | f_gsup_postprocess_decoded(gsup); |
| 375 | IPA_GSUP_PORT.send(gsup); |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 376 | } |
| 377 | |
Harald Welte | 92632e1 | 2017-11-25 02:31:20 +0100 | [diff] [blame] | 378 | private function f_mgcp_to_ud(octetstring payload) runs on IPA_Emulation_CT return ASP_IPA_Unitdata { |
| 379 | if (mp_ipa_mgcp_uses_osmo_ext) { |
| 380 | return valueof(t_ASP_IPA_UD(IPAC_PROTO_MGCP_OLD, payload)); |
| 381 | } else { |
| 382 | return valueof(t_ASP_IPA_UD(IPAC_PROTO_OSMO, payload, IPAC_PROTO_EXT_MGCP)); |
| 383 | } |
| 384 | } |
| 385 | |
Harald Welte | bdb6370 | 2017-12-09 01:15:44 +0100 | [diff] [blame] | 386 | /* main loop function for both client and server. 'thread' of the component */ |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 387 | private function ScanEvents() runs on IPA_Emulation_CT { |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 388 | var IPA_RecvFrom ipa_rx; |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 389 | var ASP_IPA_Unitdata ipa_ud; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 390 | var ASP_MTP3_TRANSFERreq mtp_req; |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 391 | var ASP_Event asp_evt; |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 392 | var MgcpCommand mgcp_cmd; |
| 393 | var MgcpResponse mgcp_rsp; |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 394 | var CtrlMessage ctrl_msg; |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 395 | var GSUP_PDU gsup_msg; |
Harald Welte | 1dd8f37 | 2017-11-25 02:25:27 +0100 | [diff] [blame] | 396 | var octetstring payload; |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 397 | var ASP_RSL_Unitdata rsl; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 398 | |
Harald Welte | 3e6ad89 | 2017-12-12 14:39:46 +0100 | [diff] [blame] | 399 | /* Set function for dissecting the binary */ |
| 400 | var f_IPL4_getMsgLen vl_f := refers(f_IPL4_fixedMsgLen); |
| 401 | IPA_CodecPort_CtrlFunct.f_IPL4_setGetMsgLen(IPA_PORT, g_ipa_conn_id, vl_f, {0, 2, 3, 1, 0}); |
| 402 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 403 | while (true) { |
| 404 | alt { |
| 405 | /* Received IPA -> up into SCCP stack */ |
| 406 | [] IPA_PORT.receive(IPA_RecvFrom: ?) -> value ipa_rx { |
| 407 | select (ipa_rx.streamId) { |
| 408 | case (IPAC_PROTO_CCM) { |
| 409 | var PDU_IPA_CCM ccm := dec_PDU_IPA_CCM(ipa_rx.msg); |
| 410 | log("CCM Rx:", ccm); |
| 411 | f_ccm_rx(ccm); |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 412 | } case (IPAC_PROTO_SCCP) { |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 413 | var ASP_MTP3_TRANSFERind mtp; |
| 414 | mtp := valueof(ts_MTP3_XFER_ind(0, ipa_rx.msg)); |
| 415 | MTP3_SP_PORT.send(mtp); |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 416 | } case (IPAC_PROTO_MGCP_OLD) { |
| 417 | f_mgcp_to_user(ipa_rx.msg); |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 418 | } case (t_IpaSidRSL) { |
| 419 | rsl := { |
| 420 | streamId := ipa_rx.streamId, |
| 421 | rsl := dec_RSL_Message(ipa_rx.msg) |
| 422 | }; |
| 423 | IPA_RSL_PORT.send(rsl); |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 424 | } case (IPAC_PROTO_OSMO) { |
| 425 | select (ipa_rx.streamIdExt) { |
| 426 | case (IPAC_PROTO_EXT_MGCP) { |
| 427 | f_mgcp_to_user(ipa_rx.msg); |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 428 | } case (IPAC_PROTO_EXT_CTRL) { |
| 429 | f_ctrl_to_user(ipa_rx.msg); |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 430 | } case (IPAC_PROTO_EXT_GSUP) { |
| 431 | f_gsup_to_user(ipa_rx.msg); |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 432 | } case else { |
| 433 | IPA_SP_PORT.send(f_to_asp(ipa_rx)); |
| 434 | } |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 435 | } |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 436 | } case else { |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 437 | IPA_SP_PORT.send(f_to_asp(ipa_rx)); |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 438 | } |
| 439 | } |
| 440 | } |
| 441 | |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 442 | /* server only */ |
| 443 | [] IPA_PORT.receive(ASP_Event:{connOpened:=?}) -> value asp_evt { |
| 444 | log("IPA: Connected"); |
| 445 | g_ipa_conn_id := asp_evt.connOpened.connId; |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 446 | f_send_IPA_EVT(t_ASP_IPA_EVT_UD(ASP_IPA_EVENT_UP)); |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 447 | if (g_mode == IPA_MODE_SERVER) { |
| 448 | f_ccm_tx(valueof(ts_IPA_ID_GET)); |
| 449 | } |
| 450 | } |
| 451 | |
| 452 | [] IPA_PORT.receive(ASP_Event:{connClosed:=?}) -> value asp_evt { |
| 453 | log("IPA: Closed"); |
| 454 | g_ipa_conn_id := -1; |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 455 | f_send_IPA_EVT(t_ASP_IPA_EVT_UD(ASP_IPA_EVENT_DOWN)); |
Harald Welte | b3414b2 | 2017-11-23 18:22:10 +0100 | [diff] [blame] | 456 | self.stop; |
| 457 | } |
| 458 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 459 | /* Received SCCP -> down into IPA */ |
| 460 | [] MTP3_SP_PORT.receive(ASP_MTP3_TRANSFERreq: ?) -> value mtp_req { |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 461 | var IPA_Send ipa_tx := valueof(t_IPA_Send(g_ipa_conn_id, IPAC_PROTO_SCCP, |
| 462 | mtp_req.data)); |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 463 | IPA_PORT.send(ipa_tx); |
| 464 | } |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 465 | |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 466 | /* Received MGCP -> down into IPA */ |
| 467 | [] IPA_MGCP_PORT.receive(MgcpCommand:?) -> value mgcp_cmd { |
Harald Welte | 92632e1 | 2017-11-25 02:31:20 +0100 | [diff] [blame] | 468 | payload := char2oct(enc_MgcpCommand(mgcp_cmd)); |
| 469 | ipa_ud := f_mgcp_to_ud(payload); |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 470 | IPA_PORT.send(f_from_asp(g_ipa_conn_id, ipa_ud)); |
| 471 | } |
| 472 | [] IPA_MGCP_PORT.receive(MgcpResponse:?) -> value mgcp_rsp { |
Harald Welte | 1dd8f37 | 2017-11-25 02:25:27 +0100 | [diff] [blame] | 473 | payload := char2oct(enc_MgcpResponse(mgcp_rsp)); |
Harald Welte | 92632e1 | 2017-11-25 02:31:20 +0100 | [diff] [blame] | 474 | ipa_ud := f_mgcp_to_ud(payload); |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 475 | IPA_PORT.send(f_from_asp(g_ipa_conn_id, ipa_ud)); |
| 476 | } |
| 477 | |
Harald Welte | a76c4bb | 2017-12-09 02:06:07 +0100 | [diff] [blame] | 478 | [] IPA_CTRL_PORT.receive(CtrlMessage:?) -> value ctrl_msg { |
| 479 | payload := char2oct(enc_CtrlMessage(ctrl_msg)); |
| 480 | ipa_ud := valueof(t_ASP_IPA_UD(IPAC_PROTO_OSMO, payload, IPAC_PROTO_EXT_CTRL)); |
| 481 | IPA_PORT.send(f_from_asp(g_ipa_conn_id, ipa_ud)); |
| 482 | } |
| 483 | |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 484 | [] IPA_GSUP_PORT.receive(GSUP_PDU:?) -> value gsup_msg { |
Harald Welte | 2f562b1 | 2018-01-24 20:52:38 +0100 | [diff] [blame] | 485 | f_gsup_preprocess_encoded(gsup_msg); |
Harald Welte | df32723 | 2017-12-28 22:51:51 +0100 | [diff] [blame] | 486 | payload := enc_GSUP_PDU(gsup_msg); |
| 487 | ipa_ud := valueof(t_ASP_IPA_UD(IPAC_PROTO_OSMO, payload, IPAC_PROTO_EXT_GSUP)); |
| 488 | IPA_PORT.send(f_from_asp(g_ipa_conn_id, ipa_ud)); |
| 489 | } |
| 490 | |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 491 | /* Received RSL -> down into IPA */ |
| 492 | [] IPA_RSL_PORT.receive(ASP_RSL_Unitdata:?) -> value rsl { |
| 493 | IPA_PORT.send(f_from_rsl(g_ipa_conn_id, rsl)); |
| 494 | } |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 495 | |
Harald Welte | 0d846a7 | 2017-12-07 17:58:28 +0100 | [diff] [blame] | 496 | |
| 497 | /* Received MISC (OML/CTRL) -> down into IPA */ |
Harald Welte | c76f29f | 2017-11-22 12:46:46 +0100 | [diff] [blame] | 498 | [] IPA_SP_PORT.receive(ASP_IPA_Unitdata: ?) -> value ipa_ud { |
| 499 | IPA_PORT.send(f_from_asp(g_ipa_conn_id, ipa_ud)); |
| 500 | } |
| 501 | |
| 502 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 503 | } |
| 504 | } |
| 505 | } |
| 506 | |
| 507 | } |