blob: 5c385e6879318c9636d6149349b88ab688a0fd6e [file] [log] [blame]
Harald Welted86cdc62017-11-22 00:45:07 +01001module IPA_Emulation {
2
Harald Weltebdb63702017-12-09 01:15:44 +01003/* 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 Welte35bb7162018-01-03 21:07:52 +01005 * 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 Weltebdb63702017-12-09 01:15:44 +010017
Harald Welted86cdc62017-11-22 00:45:07 +010018import from IPA_Types all;
19import from IPA_CodecPort all;
20import from IPA_CodecPort_CtrlFunct all;
21import from IPL4asp_Types all;
Harald Welte12188832017-11-29 11:47:13 +010022import from IPL4asp_PortType all;
Stefan Sperling830dc9d2018-02-12 21:08:28 +010023import from Socket_API_Definitions all;
Harald Welted86cdc62017-11-22 00:45:07 +010024
Harald Weltedf277252018-02-20 15:49:30 +010025#ifdef IPA_EMULATION_SCCP
26import from MTP3asp_Types all;
27import from MTP3asp_PortType all;
28#endif
29
30#ifdef IPA_EMULATION_RSL
31import from RSL_Types all;
32#endif
33
34#ifdef IPA_EMULATION_MGCP
Harald Weltec82eef42017-11-24 20:40:12 +010035import from MGCP_Types all;
Harald Weltedf277252018-02-20 15:49:30 +010036#endif
37
38#ifdef IPA_EMULATION_GSUP
Harald Weltedf327232017-12-28 22:51:51 +010039import from GSUP_Types all;
Harald Weltedf277252018-02-20 15:49:30 +010040#endif
Harald Weltec82eef42017-11-24 20:40:12 +010041
Harald Weltea76c4bb2017-12-09 02:06:07 +010042import from Osmocom_CTRL_Types all;
43
Harald Welted86cdc62017-11-22 00:45:07 +010044modulepar {
Harald Welte92632e12017-11-25 02:31:20 +010045 /* Use Osmocom extended IPA mux header */
46 boolean mp_ipa_mgcp_uses_osmo_ext := true;
Harald Welted86cdc62017-11-22 00:45:07 +010047}
Harald Welted86cdc62017-11-22 00:45:07 +010048
Harald Welteb3414b22017-11-23 18:22:10 +010049type enumerated IpaMode {
50 IPA_MODE_CLIENT,
51 IPA_MODE_SERVER
52}
53
Neels Hofmeyr3bf31d22018-08-24 14:44:32 +020054type enumerated IpaInitBehavior {
55 IPA_INIT_SEND_IPA_ID_GET,
56 IPA_INIT_SEND_IPA_ID_ACK
57}
58
Harald Weltec76f29f2017-11-22 12:46:46 +010059type record ASP_IPA_Unitdata {
60 IpaStreamId streamId,
Harald Weltec82eef42017-11-24 20:40:12 +010061 IpaExtStreamId streamIdExt optional,
Harald Weltec76f29f2017-11-22 12:46:46 +010062 octetstring payload
63}
64
Harald Welte0d846a72017-12-07 17:58:28 +010065type enumerated ASP_IPA_EventUpDown {
66 ASP_IPA_EVENT_DOWN,
67 ASP_IPA_EVENT_UP,
68 ASP_IPA_EVENT_ID_ACK
69}
70
Harald Weltebdb63702017-12-09 01:15:44 +010071/* an event indicating us whether or not a connection is physically up or down,
72 * and whether we have received an ID_ACK */
Harald Welte0d846a72017-12-07 17:58:28 +010073type union ASP_IPA_Event {
74 ASP_IPA_EventUpDown up_down
75}
76
77template ASP_IPA_Event t_ASP_IPA_EVT_UD(ASP_IPA_EventUpDown ud) := {
78 up_down := ud
79}
80
Harald Welte1dd8f372017-11-25 02:25:27 +010081template ASP_IPA_Unitdata t_ASP_IPA_UD(IpaStreamId sid, octetstring pl,
82 template IpaExtStreamId esid := omit) := {
83 streamId := sid,
84 streamIdExt := esid,
85 payload := pl
86}
87
Harald Weltedf277252018-02-20 15:49:30 +010088#ifdef IPA_EMULATION_RSL
Harald Weltebdb63702017-12-09 01:15:44 +010089/* like ASP_IPA_Unitdata, but with RSL_Message abstract type instead of octetstring */
Harald Welte0d846a72017-12-07 17:58:28 +010090type record ASP_RSL_Unitdata {
91 IpaStreamId streamId,
92 RSL_Message rsl
93};
94
Harald Welte7ae019e2017-12-09 00:54:15 +010095template ASP_RSL_Unitdata ts_ASP_RSL_UD(IpaStreamId sid, template RSL_Message rsl) := {
Harald Welte0d846a72017-12-07 17:58:28 +010096 streamId := sid,
97 rsl := valueof(rsl)
98}
99
Harald Welte7ae019e2017-12-09 00:54:15 +0100100template ASP_RSL_Unitdata tr_ASP_RSL_UD(IpaStreamId sid, template RSL_Message rsl) := {
101 streamId := sid,
102 rsl := rsl
103}
104
Harald Welte0d846a72017-12-07 17:58:28 +0100105template IpaStreamId t_IpaSidRSL := ( IPAC_PROTO_RSL_TRX0, IPAC_PROTO_RSL_TRX1,
106 IPAC_PROTO_RSL_TRX2, IPAC_PROTO_RSL_TRX3 );
Harald Weltedf277252018-02-20 15:49:30 +0100107#endif
Harald Welte0d846a72017-12-07 17:58:28 +0100108
Harald Weltebdb63702017-12-09 01:15:44 +0100109/* Client port for general IPA messages, not further decoded */
Harald Weltec76f29f2017-11-22 12:46:46 +0100110type port IPA_SP_PT message {
Harald Welte0d846a72017-12-07 17:58:28 +0100111 inout ASP_IPA_Unitdata, ASP_IPA_Event;
Harald Weltec76f29f2017-11-22 12:46:46 +0100112} with { extension "internal" }
113
Harald Weltedf277252018-02-20 15:49:30 +0100114#ifdef IPA_EMULATION_MGCP
Harald Weltebdb63702017-12-09 01:15:44 +0100115/* Client port for MGCP inside IPA */
Harald Weltec82eef42017-11-24 20:40:12 +0100116type port IPA_MGCP_PT message {
117 inout MgcpCommand, MgcpResponse;
118} with { extension "internal" }
Harald Weltedf277252018-02-20 15:49:30 +0100119#endif
Harald Weltec82eef42017-11-24 20:40:12 +0100120
Harald Weltedf277252018-02-20 15:49:30 +0100121#ifdef IPA_EMULATION_RSL
Harald Weltebdb63702017-12-09 01:15:44 +0100122/* Client port for A-bis RSL inside IPA */
Harald Welte0d846a72017-12-07 17:58:28 +0100123type port IPA_RSL_PT message {
124 inout ASP_RSL_Unitdata, ASP_IPA_Event;
125} with { extension "internal" }
Harald Weltedf277252018-02-20 15:49:30 +0100126#endif
Harald Welte0d846a72017-12-07 17:58:28 +0100127
Harald Weltea76c4bb2017-12-09 02:06:07 +0100128/* Client port for CTRL inside IPA */
129type port IPA_CTRL_PT message {
130 inout CtrlMessage, ASP_IPA_Event;
131} with { extension "internal" }
132
Harald Weltedf277252018-02-20 15:49:30 +0100133#ifdef IPA_EMULATION_GSUP
Harald Weltedf327232017-12-28 22:51:51 +0100134/* Client port for CTRL inside IPA */
135type port IPA_GSUP_PT message {
136 inout GSUP_PDU, ASP_IPA_Event;
137} with { extension "internal" }
Harald Weltedf277252018-02-20 15:49:30 +0100138#endif
Harald Weltedf327232017-12-28 22:51:51 +0100139
140
Harald Welted86cdc62017-11-22 00:45:07 +0100141type component IPA_Emulation_CT {
142 /* down-facing port to IPA codec port */
143 port IPA_CODEC_PT IPA_PORT;
Harald Weltedf277252018-02-20 15:49:30 +0100144#ifdef IPA_EMULATION_SCCP
Harald Welted86cdc62017-11-22 00:45:07 +0100145 /* up-facing port to SCCP */
146 port MTP3asp_SP_PT MTP3_SP_PORT;
Harald Weltedf277252018-02-20 15:49:30 +0100147#endif
148#ifdef IPA_EMULATION_MGCP
Harald Weltec82eef42017-11-24 20:40:12 +0100149 /* up-facing port for MGCP */
150 port IPA_MGCP_PT IPA_MGCP_PORT;
Harald Weltedf277252018-02-20 15:49:30 +0100151#endif
152#ifdef IPA_EMULATION_RSL
Harald Welte0d846a72017-12-07 17:58:28 +0100153 /* up-facing port for RSL */
154 port IPA_RSL_PT IPA_RSL_PORT;
Harald Weltedf277252018-02-20 15:49:30 +0100155#endif
Harald Weltea76c4bb2017-12-09 02:06:07 +0100156 /* up-facing port for CTRL */
157 port IPA_CTRL_PT IPA_CTRL_PORT;
Harald Weltedf277252018-02-20 15:49:30 +0100158#ifdef IPA_EMULATION_GSUP
Harald Weltedf327232017-12-28 22:51:51 +0100159 /* up-facing port for GSUP */
160 port IPA_GSUP_PT IPA_GSUP_PORT;
Harald Weltedf277252018-02-20 15:49:30 +0100161#endif
Harald Weltedf327232017-12-28 22:51:51 +0100162
Harald Weltec76f29f2017-11-22 12:46:46 +0100163 /* up-facing port for other streams */
164 port IPA_SP_PT IPA_SP_PORT;
Harald Welted86cdc62017-11-22 00:45:07 +0100165
166 var boolean g_initialized := false;
Stefan Sperling830dc9d2018-02-12 21:08:28 +0100167 var IPL4asp_Types.ConnectionId g_ipa_conn_id := -1;
Harald Weltec82eef42017-11-24 20:40:12 +0100168 /* Are we a BSC/MGW (truel) or MSC (false) */
169 var boolean g_is_bsc_mgw;
Harald Welteb3414b22017-11-23 18:22:10 +0100170
171 var IpaMode g_mode;
Harald Welte2d86aff2018-04-17 11:23:04 +0200172 var boolean g_ccm_enabled;
Neels Hofmeyr3bf31d22018-08-24 14:44:32 +0200173 var IpaInitBehavior g_init_behavior;
Harald Weltee09921f2017-12-07 17:49:00 +0100174 var IPA_CCM_Parameters g_ccm_pars := c_IPA_default_ccm_pars;
Harald Welted86cdc62017-11-22 00:45:07 +0100175}
176
Harald Weltee21096d2017-12-04 20:45:12 +0100177type record IPA_CCM_Parameters {
178 charstring ser_nr optional,
179 charstring name optional,
180 charstring location1 optional,
181 charstring location2 optional,
182 charstring equip_version optional,
183 charstring sw_version optional,
184 charstring ip_addr optional,
185 charstring mac_addr optional,
186 charstring unit_id optional,
187 charstring osmo_rand optional
188}
189
Harald Weltee09921f2017-12-07 17:49:00 +0100190const IPA_CCM_Parameters c_IPA_default_ccm_pars := {
191 ser_nr := "",
Harald Weltee21096d2017-12-04 20:45:12 +0100192 name := "mahlzeit",
Harald Weltee09921f2017-12-07 17:49:00 +0100193 location1 := "",
194 location2 := "",
195 equip_version := "",
196 sw_version := "",
197 ip_addr := "",
198 mac_addr := "",
Harald Weltee21096d2017-12-04 20:45:12 +0100199 unit_id := "0/1/2",
Harald Weltee09921f2017-12-07 17:49:00 +0100200 osmo_rand := ""
Harald Weltee21096d2017-12-04 20:45:12 +0100201};
202
Harald Weltebdb63702017-12-09 01:15:44 +0100203/* Function to use to connect as client to a remote IPA Server */
Stefan Sperling830dc9d2018-02-12 21:08:28 +0100204function f_connect(charstring remote_host, IPL4asp_Types.PortNumber remote_port,
205 charstring local_host, IPL4asp_Types.PortNumber local_port,
Harald Weltee09921f2017-12-07 17:49:00 +0100206 IPA_CCM_Parameters ccm_pars := c_IPA_default_ccm_pars) runs on IPA_Emulation_CT {
Stefan Sperling830dc9d2018-02-12 21:08:28 +0100207 var IPL4asp_Types.Result res;
Harald Welted86cdc62017-11-22 00:45:07 +0100208 res := IPA_CodecPort_CtrlFunct.f_IPL4_connect(IPA_PORT, remote_host, remote_port,
209 local_host, local_port, 0, { tcp:={} });
Harald Welte9220f632018-05-23 20:27:02 +0200210 if (not ispresent(res.connId)) {
211 setverdict(fail, "Could not connect IPA socket, check your configuration");
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200212 mtc.stop;
Harald Welte9220f632018-05-23 20:27:02 +0200213 }
Harald Welted86cdc62017-11-22 00:45:07 +0100214 g_ipa_conn_id := res.connId;
Harald Weltee21096d2017-12-04 20:45:12 +0100215 g_ccm_pars := ccm_pars;
Harald Weltec82eef42017-11-24 20:40:12 +0100216 g_is_bsc_mgw := true;
Harald Welted86cdc62017-11-22 00:45:07 +0100217}
218
Harald Weltebdb63702017-12-09 01:15:44 +0100219/* Function to use to bind to a local port as IPA server, accepting remote clients */
Stefan Sperling830dc9d2018-02-12 21:08:28 +0100220function f_bind(charstring local_host, IPL4asp_Types.PortNumber local_port,
Harald Weltee09921f2017-12-07 17:49:00 +0100221 IPA_CCM_Parameters ccm_pars := c_IPA_default_ccm_pars) runs on IPA_Emulation_CT {
Stefan Sperling830dc9d2018-02-12 21:08:28 +0100222 var IPL4asp_Types.Result res;
Harald Welteb3414b22017-11-23 18:22:10 +0100223 res := IPA_CodecPort_CtrlFunct.f_IPL4_listen(IPA_PORT,
224 local_host, local_port, { tcp:={} });
Harald Welte9220f632018-05-23 20:27:02 +0200225 if (not ispresent(res.connId)) {
226 setverdict(fail, "Could not listen IPA socket, check your configuration");
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200227 mtc.stop;
Harald Welte9220f632018-05-23 20:27:02 +0200228 }
Harald Welteb3414b22017-11-23 18:22:10 +0100229 g_ipa_conn_id := res.connId;
Harald Weltee21096d2017-12-04 20:45:12 +0100230 g_ccm_pars := ccm_pars;
Harald Weltec82eef42017-11-24 20:40:12 +0100231 g_is_bsc_mgw := false;
Harald Welteb3414b22017-11-23 18:22:10 +0100232}
233
Harald Weltedf277252018-02-20 15:49:30 +0100234#ifdef IPA_EMULATION_SCCP
Harald Welted86cdc62017-11-22 00:45:07 +0100235template ASP_MTP3_TRANSFERind ts_MTP3_XFER_ind(integer opc, octetstring data) := {
236 sio := { '10'B, '00'B, '0011'B },
237 opc := opc,
238 dpc := 0,
239 sls := 0,
240 data := data
241}
Harald Weltedf277252018-02-20 15:49:30 +0100242#endif
Harald Welted86cdc62017-11-22 00:45:07 +0100243
244
245private template IpaCcmRespPart t_IdRespPart(IpaCcmIdTag tag, charstring payload) := {
246 len := 0, /* overwritten by codec */
247 tag := tag,
Harald Welte95686e02018-08-02 15:05:43 +0200248 data := char2oct(payload) & '00'O
Harald Welted86cdc62017-11-22 00:45:07 +0100249}
250
Harald Welte0d846a72017-12-07 17:58:28 +0100251private function f_send_IPA_EVT(template ASP_IPA_Event evt) runs on IPA_Emulation_CT {
Harald Welte2e32e432018-05-24 20:00:00 +0200252 if (IPA_SP_PORT.checkstate("Connected")) {
253 IPA_SP_PORT.send(evt);
254 }
Harald Weltedf277252018-02-20 15:49:30 +0100255#ifdef IPA_EMULATION_RSL
Harald Welte5819b552017-12-09 02:55:46 +0100256 if (IPA_RSL_PORT.checkstate("Connected")) {
257 IPA_RSL_PORT.send(evt);
258 }
Harald Weltedf277252018-02-20 15:49:30 +0100259#endif
Harald Welte5819b552017-12-09 02:55:46 +0100260 if (IPA_CTRL_PORT.checkstate("Connected")) {
261 IPA_CTRL_PORT.send(evt);
262 }
Harald Weltedf277252018-02-20 15:49:30 +0100263#ifdef IPA_EMULATION_GSUP
Harald Weltedf327232017-12-28 22:51:51 +0100264 if (IPA_GSUP_PORT.checkstate("Connected")) {
265 IPA_GSUP_PORT.send(evt);
266 }
Harald Weltedf277252018-02-20 15:49:30 +0100267#endif
Harald Welte0d846a72017-12-07 17:58:28 +0100268 /* FIXME: to other ports */
269}
270
Harald Welted86cdc62017-11-22 00:45:07 +0100271/* build IPA CCM ID RESP response from IPA CCM GET */
Harald Weltee21096d2017-12-04 20:45:12 +0100272private function f_ccm_make_id_resp(PDU_IPA_CCM get) runs on IPA_Emulation_CT return PDU_IPA_CCM {
Harald Welted86cdc62017-11-22 00:45:07 +0100273 var integer i;
274 var PDU_IPA_CCM resp := {
275 msg_type := IPAC_MSGT_ID_RESP,
276 u := {
277 resp := {}
278 }
279 }
280
281 for (i := 0; i < sizeof(get.u.get); i := i + 1) {
282 var IpaCcmIdTag tag := get.u.get[i].tag;
283 var charstring foo;
284 select (tag) {
Harald Weltee21096d2017-12-04 20:45:12 +0100285 case (IPAC_IDTAG_SERNR) {
286 foo := g_ccm_pars.ser_nr;
Harald Welted86cdc62017-11-22 00:45:07 +0100287 }
288 case (IPAC_IDTAG_UNITNAME) {
Harald Weltee21096d2017-12-04 20:45:12 +0100289 foo := g_ccm_pars.name;
290 }
291 case (IPAC_IDTAG_LOCATION1) {
292 foo := g_ccm_pars.location1;
293 }
294 case (IPAC_IDTAG_LOCATION2) {
295 foo := g_ccm_pars.location2;
296 }
297 case (IPAC_IDTAG_EQUIPVERS) {
298 foo := g_ccm_pars.equip_version;
299 }
300 case (IPAC_IDTAG_SWVERSION) {
301 foo := g_ccm_pars.sw_version;
302 }
303 case (IPAC_IDTAG_IPADDR) {
304 foo := g_ccm_pars.ip_addr;
305 }
306 case (IPAC_IDTAG_MACADDR) {
307 foo := g_ccm_pars.mac_addr;
308 }
309 case (IPAC_IDTAG_UNIT) {
310 foo := g_ccm_pars.unit_id;
311 }
312 case (IPAC_IDTAG_OSMO_RAND) {
313 foo := g_ccm_pars.osmo_rand;
Harald Welted86cdc62017-11-22 00:45:07 +0100314 }
315 case else {
Harald Weltee21096d2017-12-04 20:45:12 +0100316 foo := "unknown";
Harald Welted86cdc62017-11-22 00:45:07 +0100317 }
318 }
319 resp.u.resp[sizeof(resp.u.resp)] := valueof(t_IdRespPart(tag, foo));
320 }
321
322 return resp;
323}
324
325/* transmit IPA CCM message */
326private function f_ccm_tx(PDU_IPA_CCM ccm) runs on IPA_Emulation_CT {
Harald Weltec82eef42017-11-24 20:40:12 +0100327 var IPA_Send ipa_tx := valueof(t_IPA_Send(g_ipa_conn_id, IPAC_PROTO_CCM, enc_PDU_IPA_CCM(ccm)));
Harald Welted86cdc62017-11-22 00:45:07 +0100328 log("CCM Tx:", ccm);
329 IPA_PORT.send(ipa_tx);
330}
331
332template PDU_IPA_CCM ts_IPA_PONG := {
333 msg_type := IPAC_MSGT_PONG,
334 u := omit
335}
336
337template PDU_IPA_CCM ts_IPA_ACK := {
338 msg_type := IPAC_MSGT_ID_ACK,
339 u := omit
340}
341
Harald Welteb3414b22017-11-23 18:22:10 +0100342template PDU_IPA_CCM ts_IPA_ID_GET := {
343 msg_type := IPAC_MSGT_ID_GET,
344 u := {
345 get := {
346 { 1, IPAC_IDTAG_UNITNAME }
347 }
348 }
349}
350
Harald Welted86cdc62017-11-22 00:45:07 +0100351/* receive IPA CCM message */
Harald Welte2d86aff2018-04-17 11:23:04 +0200352private function f_ccm_rx_client(PDU_IPA_CCM ccm) runs on IPA_Emulation_CT {
Harald Welted86cdc62017-11-22 00:45:07 +0100353 select (ccm.msg_type) {
354 case (IPAC_MSGT_PING) {
355 f_ccm_tx(valueof(ts_IPA_PONG));
356 }
357 case (IPAC_MSGT_ID_ACK) {
Harald Welte2d86aff2018-04-17 11:23:04 +0200358 f_send_IPA_EVT(t_ASP_IPA_EVT_UD(ASP_IPA_EVENT_ID_ACK));
Harald Welted86cdc62017-11-22 00:45:07 +0100359 }
360 case (IPAC_MSGT_ID_GET) {
361 f_ccm_tx(f_ccm_make_id_resp(ccm));
362 }
Harald Welte2d86aff2018-04-17 11:23:04 +0200363 case else {
364 log("Unknown/unsupported IPA CCM message type", ccm);
365 }
366 }
367}
368
369private function f_ccm_rx_server(PDU_IPA_CCM ccm) runs on IPA_Emulation_CT {
370 select (ccm.msg_type) {
371 case (IPAC_MSGT_PING) {
372 f_ccm_tx(valueof(ts_IPA_PONG));
373 }
374 case (IPAC_MSGT_ID_ACK) {
375 /* the IPA server should at some point receive an ID_ACK from the client,
376 * in case of RSL/OML from nanoBTS, this is actually the first message after
377 * the TCP connection is established. Other implementations may differ.
378 * We currently ignore it completely - but actually we should make sure that
379 * one ID_ACK is received by the server at some point */
Harald Welte2e32e432018-05-24 20:00:00 +0200380 f_send_IPA_EVT(t_ASP_IPA_EVT_UD(ASP_IPA_EVENT_ID_ACK));
Harald Welte2d86aff2018-04-17 11:23:04 +0200381 }
Harald Welte3bc387f2018-02-21 12:18:46 +0100382 case (IPAC_MSGT_ID_RESP) {
383 log("IPA ID RESP: ", ccm.u.resp);
Harald Welte2d86aff2018-04-17 11:23:04 +0200384 /* acknowledge any identity that the client may have sent */
385 f_ccm_tx(valueof(ts_IPA_ACK));
Harald Welte3bc387f2018-02-21 12:18:46 +0100386 }
Harald Welted86cdc62017-11-22 00:45:07 +0100387 case else {
388 log("Unknown/unsupported IPA CCM message type", ccm);
389 }
390 }
391}
392
Harald Weltec76f29f2017-11-22 12:46:46 +0100393private function f_to_asp(IPA_RecvFrom ipa_rx) return ASP_IPA_Unitdata {
394 var ASP_IPA_Unitdata ret := {
395 streamId := ipa_rx.streamId,
Harald Welte2a8f8472017-11-23 21:11:34 +0100396 streamIdExt := ipa_rx.streamIdExt,
Harald Weltec76f29f2017-11-22 12:46:46 +0100397 payload := ipa_rx.msg
398 }
399 return ret;
400}
401
Stefan Sperling830dc9d2018-02-12 21:08:28 +0100402private function f_from_asp(IPL4asp_Types.ConnectionId connId, ASP_IPA_Unitdata ipa_tx) return IPA_Send {
Harald Weltec82eef42017-11-24 20:40:12 +0100403 var IPA_Send ret := valueof(t_IPA_Send(connId, ipa_tx.streamId, ipa_tx.payload,
404 ipa_tx.streamIdExt));
Harald Weltec76f29f2017-11-22 12:46:46 +0100405 return ret;
406}
Harald Welted86cdc62017-11-22 00:45:07 +0100407
Harald Weltedf277252018-02-20 15:49:30 +0100408#ifdef IPA_EMULATION_RSL
Stefan Sperling830dc9d2018-02-12 21:08:28 +0100409private function f_from_rsl(IPL4asp_Types.ConnectionId connId, ASP_RSL_Unitdata rsl_tx) return IPA_Send {
Harald Welte0d846a72017-12-07 17:58:28 +0100410 var octetstring payload := enc_RSL_Message(rsl_tx.rsl);
411 var IPA_Send ret := valueof(t_IPA_Send(connId, rsl_tx.streamId, payload));
412 return ret;
413}
Harald Weltedf277252018-02-20 15:49:30 +0100414#endif
Harald Welte0d846a72017-12-07 17:58:28 +0100415
Harald Weltebdb63702017-12-09 01:15:44 +0100416/* main function to use for a client-side IPA implementation */
Stefan Sperling830dc9d2018-02-12 21:08:28 +0100417function main_client(charstring remote_host, IPL4asp_Types.PortNumber remote_port,
418 charstring local_host, IPL4asp_Types.PortNumber local_port,
Harald Welte2d86aff2018-04-17 11:23:04 +0200419 IPA_CCM_Parameters ccm_pars := c_IPA_default_ccm_pars,
420 boolean ccm_enabled := true) runs on IPA_Emulation_CT {
Harald Welteb3414b22017-11-23 18:22:10 +0100421 g_mode := IPA_MODE_CLIENT;
Harald Welte2d86aff2018-04-17 11:23:04 +0200422 g_ccm_enabled := ccm_enabled;
Harald Weltee09921f2017-12-07 17:49:00 +0100423 f_connect(remote_host, remote_port, local_host, local_port, ccm_pars);
Harald Welte2d86aff2018-04-17 11:23:04 +0200424 if (g_ccm_enabled) {
425 /* we're a client: Send ID_ACK immediately after connect */
426 f_ccm_tx(valueof(ts_IPA_ACK));
427 }
Harald Welte03c0e562017-12-09 02:55:12 +0100428 f_send_IPA_EVT(t_ASP_IPA_EVT_UD(ASP_IPA_EVENT_UP));
Harald Welteb3414b22017-11-23 18:22:10 +0100429 ScanEvents();
430}
431
Harald Weltebdb63702017-12-09 01:15:44 +0100432/* main function to use for a server-side IPA implementation */
Harald Welte2d86aff2018-04-17 11:23:04 +0200433function main_server(charstring local_host, IPL4asp_Types.PortNumber local_port,
Neels Hofmeyr3bf31d22018-08-24 14:44:32 +0200434 boolean ccm_enabled := true,
435 IpaInitBehavior init_behavior := IPA_INIT_SEND_IPA_ID_GET)
436runs on IPA_Emulation_CT {
Harald Welteb3414b22017-11-23 18:22:10 +0100437 g_mode := IPA_MODE_SERVER;
Harald Welte2d86aff2018-04-17 11:23:04 +0200438 g_ccm_enabled := ccm_enabled;
Neels Hofmeyr3bf31d22018-08-24 14:44:32 +0200439 g_init_behavior := init_behavior;
Harald Welteb3414b22017-11-23 18:22:10 +0100440 f_bind(local_host, local_port);
441 ScanEvents();
442}
443
Harald Weltedf277252018-02-20 15:49:30 +0100444private function f_ctrl_to_user(octetstring msg) runs on IPA_Emulation_CT {
445 var charstring msg_ch := oct2char(msg);
446 IPA_CTRL_PORT.send(dec_CtrlMessage(msg_ch));
447}
448
449#ifdef IPA_EMULATION_GSUP
450private function f_gsup_to_user(octetstring msg) runs on IPA_Emulation_CT {
451 var GSUP_PDU gsup := dec_GSUP_PDU(msg);
452 f_gsup_postprocess_decoded(gsup);
453 IPA_GSUP_PORT.send(gsup);
454}
455#endif
456
457#ifdef IPA_EMULATION_MGCP
Harald Weltec82eef42017-11-24 20:40:12 +0100458private function f_mgcp_to_user(octetstring msg) runs on IPA_Emulation_CT {
459 var charstring msg_ch := oct2char(msg);
460 if (g_is_bsc_mgw) {
461 log("============");
462 log(msg_ch);
463 IPA_MGCP_PORT.send(dec_MgcpCommand(msg_ch));
464 } else {
465 IPA_MGCP_PORT.send(dec_MgcpResponse(msg_ch));
466 }
467}
468
Harald Welte92632e12017-11-25 02:31:20 +0100469private function f_mgcp_to_ud(octetstring payload) runs on IPA_Emulation_CT return ASP_IPA_Unitdata {
470 if (mp_ipa_mgcp_uses_osmo_ext) {
471 return valueof(t_ASP_IPA_UD(IPAC_PROTO_MGCP_OLD, payload));
472 } else {
473 return valueof(t_ASP_IPA_UD(IPAC_PROTO_OSMO, payload, IPAC_PROTO_EXT_MGCP));
474 }
475}
Harald Weltedf277252018-02-20 15:49:30 +0100476#endif
Harald Welte92632e12017-11-25 02:31:20 +0100477
Harald Weltebdb63702017-12-09 01:15:44 +0100478/* main loop function for both client and server. 'thread' of the component */
Harald Welteb3414b22017-11-23 18:22:10 +0100479private function ScanEvents() runs on IPA_Emulation_CT {
Harald Welted86cdc62017-11-22 00:45:07 +0100480 var IPA_RecvFrom ipa_rx;
Harald Welteb3414b22017-11-23 18:22:10 +0100481 var ASP_Event asp_evt;
Stefan Sperling830dc9d2018-02-12 21:08:28 +0100482 var Socket_API_Definitions.PortEvent port_evt;
Harald Weltedf277252018-02-20 15:49:30 +0100483 var octetstring payload;
484 var CtrlMessage ctrl_msg;
485 var ASP_IPA_Unitdata ipa_ud;
486#ifdef IPA_EMULATION_SCCP
487 var ASP_MTP3_TRANSFERreq mtp_req;
488#endif
489#ifdef IPA_EMULATION_MGCP
Harald Weltec82eef42017-11-24 20:40:12 +0100490 var MgcpCommand mgcp_cmd;
491 var MgcpResponse mgcp_rsp;
Harald Weltedf277252018-02-20 15:49:30 +0100492#endif
493#ifdef IPA_EMULATION_GSUP
Harald Weltedf327232017-12-28 22:51:51 +0100494 var GSUP_PDU gsup_msg;
Harald Weltedf277252018-02-20 15:49:30 +0100495#endif
496#ifdef IPA_EMULATION_RSL
Harald Welte0d846a72017-12-07 17:58:28 +0100497 var ASP_RSL_Unitdata rsl;
Harald Weltedf277252018-02-20 15:49:30 +0100498#endif
Harald Welted86cdc62017-11-22 00:45:07 +0100499
Harald Welte3e6ad892017-12-12 14:39:46 +0100500 /* Set function for dissecting the binary */
501 var f_IPL4_getMsgLen vl_f := refers(f_IPL4_fixedMsgLen);
502 IPA_CodecPort_CtrlFunct.f_IPL4_setGetMsgLen(IPA_PORT, g_ipa_conn_id, vl_f, {0, 2, 3, 1, 0});
503
Harald Welted86cdc62017-11-22 00:45:07 +0100504 while (true) {
505 alt {
506 /* Received IPA -> up into SCCP stack */
Harald Welte2d86aff2018-04-17 11:23:04 +0200507 [g_ccm_enabled] IPA_PORT.receive(IPA_RecvFrom:{?,IPAC_PROTO_CCM,omit,?}) -> value ipa_rx {
508 var PDU_IPA_CCM ccm := dec_PDU_IPA_CCM(ipa_rx.msg);
509 log("CCM Rx:", ccm);
510 select (g_mode) {
511 case (IPA_MODE_CLIENT) {
512 f_ccm_rx_client(ccm);
513 }
514 case (IPA_MODE_SERVER) {
515 f_ccm_rx_server(ccm);
516 }
517 case else {
518 setverdict(fail, "Unknown mode");
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200519 mtc.stop;
Harald Welte2d86aff2018-04-17 11:23:04 +0200520 }
Harald Weltedf277252018-02-20 15:49:30 +0100521 }
Harald Welte2d86aff2018-04-17 11:23:04 +0200522 }
523 [] IPA_PORT.receive(IPA_RecvFrom:?) -> value ipa_rx {
524 select (ipa_rx.streamId) {
Harald Weltedf277252018-02-20 15:49:30 +0100525#ifdef IPA_EMULATION_SCCP
526 case (IPAC_PROTO_SCCP) {
Harald Welted86cdc62017-11-22 00:45:07 +0100527 var ASP_MTP3_TRANSFERind mtp;
528 mtp := valueof(ts_MTP3_XFER_ind(0, ipa_rx.msg));
529 MTP3_SP_PORT.send(mtp);
Harald Weltedf277252018-02-20 15:49:30 +0100530 }
531#endif
532#ifdef IPA_EMULATION_MGCP
533 case (IPAC_PROTO_MGCP_OLD) {
Harald Weltec82eef42017-11-24 20:40:12 +0100534 f_mgcp_to_user(ipa_rx.msg);
Harald Weltedf277252018-02-20 15:49:30 +0100535 }
536#endif
537#ifdef IPA_EMULATION_RSL
538 case (t_IpaSidRSL) {
Harald Welte0d846a72017-12-07 17:58:28 +0100539 rsl := {
540 streamId := ipa_rx.streamId,
541 rsl := dec_RSL_Message(ipa_rx.msg)
542 };
543 IPA_RSL_PORT.send(rsl);
Harald Weltedf277252018-02-20 15:49:30 +0100544 }
545#endif
546 case (IPAC_PROTO_OSMO) {
Harald Weltec82eef42017-11-24 20:40:12 +0100547 select (ipa_rx.streamIdExt) {
Harald Weltedf277252018-02-20 15:49:30 +0100548#ifdef IPA_EMULATION_MGCP
Harald Weltec82eef42017-11-24 20:40:12 +0100549 case (IPAC_PROTO_EXT_MGCP) {
550 f_mgcp_to_user(ipa_rx.msg);
Harald Weltedf277252018-02-20 15:49:30 +0100551 }
552#endif
553 case (IPAC_PROTO_EXT_CTRL) {
Harald Weltea76c4bb2017-12-09 02:06:07 +0100554 f_ctrl_to_user(ipa_rx.msg);
Harald Weltedf277252018-02-20 15:49:30 +0100555 }
556#ifdef IPA_EMULATION_GSUP
557 case (IPAC_PROTO_EXT_GSUP) {
Harald Weltedf327232017-12-28 22:51:51 +0100558 f_gsup_to_user(ipa_rx.msg);
Harald Weltedf277252018-02-20 15:49:30 +0100559 }
560#endif
561 case else {
Harald Weltec82eef42017-11-24 20:40:12 +0100562 IPA_SP_PORT.send(f_to_asp(ipa_rx));
563 }
Harald Welted86cdc62017-11-22 00:45:07 +0100564 }
Harald Weltedf277252018-02-20 15:49:30 +0100565 }
566 case else {
Harald Weltec76f29f2017-11-22 12:46:46 +0100567 IPA_SP_PORT.send(f_to_asp(ipa_rx));
Harald Welted86cdc62017-11-22 00:45:07 +0100568 }
569 }
570 }
571
Harald Welteb3414b22017-11-23 18:22:10 +0100572 /* server only */
573 [] IPA_PORT.receive(ASP_Event:{connOpened:=?}) -> value asp_evt {
574 log("IPA: Connected");
575 g_ipa_conn_id := asp_evt.connOpened.connId;
Harald Welte0d846a72017-12-07 17:58:28 +0100576 f_send_IPA_EVT(t_ASP_IPA_EVT_UD(ASP_IPA_EVENT_UP));
Harald Welte2d86aff2018-04-17 11:23:04 +0200577 if (g_mode == IPA_MODE_SERVER and g_ccm_enabled) {
Neels Hofmeyr3bf31d22018-08-24 14:44:32 +0200578 select (g_init_behavior) {
579 case (IPA_INIT_SEND_IPA_ID_GET) {
580 f_ccm_tx(valueof(ts_IPA_ID_GET));
581 }
582 case (IPA_INIT_SEND_IPA_ID_ACK) {
583 f_ccm_tx(valueof(ts_IPA_ACK));
584 }
585 }
Harald Welteb3414b22017-11-23 18:22:10 +0100586 }
587 }
588
589 [] IPA_PORT.receive(ASP_Event:{connClosed:=?}) -> value asp_evt {
590 log("IPA: Closed");
591 g_ipa_conn_id := -1;
Harald Welte0d846a72017-12-07 17:58:28 +0100592 f_send_IPA_EVT(t_ASP_IPA_EVT_UD(ASP_IPA_EVENT_DOWN));
Harald Welteb3414b22017-11-23 18:22:10 +0100593 self.stop;
594 }
595
Stefan Sperling830dc9d2018-02-12 21:08:28 +0100596 [] IPA_PORT.receive(Socket_API_Definitions.PortEvent:{result:={errorCode:=ERROR_SOCKET, connId:=?, os_error_code:=?, os_error_text:=?}}) -> value port_evt {
597 log("PortEvent: ERROR_SOCKET: ", port_evt);
598 g_ipa_conn_id := -1;
599 f_send_IPA_EVT(t_ASP_IPA_EVT_UD(ASP_IPA_EVENT_DOWN));
600 self.stop;
601 }
602
Harald Weltedf277252018-02-20 15:49:30 +0100603#ifdef IPA_EMULATION_SCCP
Harald Welted86cdc62017-11-22 00:45:07 +0100604 /* Received SCCP -> down into IPA */
605 [] MTP3_SP_PORT.receive(ASP_MTP3_TRANSFERreq: ?) -> value mtp_req {
Harald Weltec82eef42017-11-24 20:40:12 +0100606 var IPA_Send ipa_tx := valueof(t_IPA_Send(g_ipa_conn_id, IPAC_PROTO_SCCP,
607 mtp_req.data));
Harald Welted86cdc62017-11-22 00:45:07 +0100608 IPA_PORT.send(ipa_tx);
609 }
Harald Weltedf277252018-02-20 15:49:30 +0100610#endif
Harald Weltec76f29f2017-11-22 12:46:46 +0100611
Harald Weltedf277252018-02-20 15:49:30 +0100612#ifdef IPA_EMULATION_MGCP
Harald Weltec82eef42017-11-24 20:40:12 +0100613 /* Received MGCP -> down into IPA */
614 [] IPA_MGCP_PORT.receive(MgcpCommand:?) -> value mgcp_cmd {
Harald Welte92632e12017-11-25 02:31:20 +0100615 payload := char2oct(enc_MgcpCommand(mgcp_cmd));
616 ipa_ud := f_mgcp_to_ud(payload);
Harald Weltec82eef42017-11-24 20:40:12 +0100617 IPA_PORT.send(f_from_asp(g_ipa_conn_id, ipa_ud));
618 }
619 [] IPA_MGCP_PORT.receive(MgcpResponse:?) -> value mgcp_rsp {
Harald Welte1dd8f372017-11-25 02:25:27 +0100620 payload := char2oct(enc_MgcpResponse(mgcp_rsp));
Harald Welte92632e12017-11-25 02:31:20 +0100621 ipa_ud := f_mgcp_to_ud(payload);
Harald Weltec82eef42017-11-24 20:40:12 +0100622 IPA_PORT.send(f_from_asp(g_ipa_conn_id, ipa_ud));
623 }
Harald Weltedf277252018-02-20 15:49:30 +0100624#endif
Harald Weltec82eef42017-11-24 20:40:12 +0100625
Harald Weltea76c4bb2017-12-09 02:06:07 +0100626 [] IPA_CTRL_PORT.receive(CtrlMessage:?) -> value ctrl_msg {
627 payload := char2oct(enc_CtrlMessage(ctrl_msg));
628 ipa_ud := valueof(t_ASP_IPA_UD(IPAC_PROTO_OSMO, payload, IPAC_PROTO_EXT_CTRL));
629 IPA_PORT.send(f_from_asp(g_ipa_conn_id, ipa_ud));
630 }
631
Harald Weltedf277252018-02-20 15:49:30 +0100632#ifdef IPA_EMULATION_GSUP
Harald Weltedf327232017-12-28 22:51:51 +0100633 [] IPA_GSUP_PORT.receive(GSUP_PDU:?) -> value gsup_msg {
Harald Welte2f562b12018-01-24 20:52:38 +0100634 f_gsup_preprocess_encoded(gsup_msg);
Harald Weltedf327232017-12-28 22:51:51 +0100635 payload := enc_GSUP_PDU(gsup_msg);
636 ipa_ud := valueof(t_ASP_IPA_UD(IPAC_PROTO_OSMO, payload, IPAC_PROTO_EXT_GSUP));
637 IPA_PORT.send(f_from_asp(g_ipa_conn_id, ipa_ud));
638 }
Harald Weltedf277252018-02-20 15:49:30 +0100639#endif
Harald Weltedf327232017-12-28 22:51:51 +0100640
Harald Weltedf277252018-02-20 15:49:30 +0100641#ifdef IPA_EMULATION_RSL
Harald Welte0d846a72017-12-07 17:58:28 +0100642 /* Received RSL -> down into IPA */
643 [] IPA_RSL_PORT.receive(ASP_RSL_Unitdata:?) -> value rsl {
644 IPA_PORT.send(f_from_rsl(g_ipa_conn_id, rsl));
645 }
Harald Weltedf277252018-02-20 15:49:30 +0100646#endif
Harald Welte0d846a72017-12-07 17:58:28 +0100647
648 /* Received MISC (OML/CTRL) -> down into IPA */
Harald Weltec76f29f2017-11-22 12:46:46 +0100649 [] IPA_SP_PORT.receive(ASP_IPA_Unitdata: ?) -> value ipa_ud {
650 IPA_PORT.send(f_from_asp(g_ipa_conn_id, ipa_ud));
651 }
652
653
Harald Welted86cdc62017-11-22 00:45:07 +0100654 }
655 }
656}
657
Harald Welte2e32e432018-05-24 20:00:00 +0200658/***********************************************************************
659 * IPA Event waiter component. Wait for ASP_IPA_EVENT_ID_ACK
660 ***********************************************************************/
661
662type component IPA_EventWaiter_CT {
663 port IPA_SP_PT IPA_SP_PORT;
664}
665
666function waiter_main(template ASP_IPA_Event wait_for := t_ASP_IPA_EVT_UD(ASP_IPA_EVENT_ID_ACK))
667runs on IPA_EventWaiter_CT {
668
669 alt {
670 [] IPA_SP_PORT.receive(wait_for) {
671 setverdict(pass);
672 }
673 [] IPA_SP_PORT.receive { repeat; }
674 }
675}
676
677
Harald Welted86cdc62017-11-22 00:45:07 +0100678}