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