blob: a271f2d8f724eb4d02fd16a326e737650ff8e759 [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
Harald Weltec76f29f2017-11-22 12:46:46 +010054type record ASP_IPA_Unitdata {
55 IpaStreamId streamId,
Harald Weltec82eef42017-11-24 20:40:12 +010056 IpaExtStreamId streamIdExt optional,
Harald Weltec76f29f2017-11-22 12:46:46 +010057 octetstring payload
58}
59
Harald Welte0d846a72017-12-07 17:58:28 +010060type enumerated ASP_IPA_EventUpDown {
61 ASP_IPA_EVENT_DOWN,
62 ASP_IPA_EVENT_UP,
63 ASP_IPA_EVENT_ID_ACK
64}
65
Harald Weltebdb63702017-12-09 01:15:44 +010066/* an event indicating us whether or not a connection is physically up or down,
67 * and whether we have received an ID_ACK */
Harald Welte0d846a72017-12-07 17:58:28 +010068type union ASP_IPA_Event {
69 ASP_IPA_EventUpDown up_down
70}
71
72template ASP_IPA_Event t_ASP_IPA_EVT_UD(ASP_IPA_EventUpDown ud) := {
73 up_down := ud
74}
75
Harald Welte1dd8f372017-11-25 02:25:27 +010076template ASP_IPA_Unitdata t_ASP_IPA_UD(IpaStreamId sid, octetstring pl,
77 template IpaExtStreamId esid := omit) := {
78 streamId := sid,
79 streamIdExt := esid,
80 payload := pl
81}
82
Harald Weltedf277252018-02-20 15:49:30 +010083#ifdef IPA_EMULATION_RSL
Harald Weltebdb63702017-12-09 01:15:44 +010084/* like ASP_IPA_Unitdata, but with RSL_Message abstract type instead of octetstring */
Harald Welte0d846a72017-12-07 17:58:28 +010085type record ASP_RSL_Unitdata {
86 IpaStreamId streamId,
87 RSL_Message rsl
88};
89
Harald Welte7ae019e2017-12-09 00:54:15 +010090template ASP_RSL_Unitdata ts_ASP_RSL_UD(IpaStreamId sid, template RSL_Message rsl) := {
Harald Welte0d846a72017-12-07 17:58:28 +010091 streamId := sid,
92 rsl := valueof(rsl)
93}
94
Harald Welte7ae019e2017-12-09 00:54:15 +010095template ASP_RSL_Unitdata tr_ASP_RSL_UD(IpaStreamId sid, template RSL_Message rsl) := {
96 streamId := sid,
97 rsl := rsl
98}
99
Harald Welte0d846a72017-12-07 17:58:28 +0100100template IpaStreamId t_IpaSidRSL := ( IPAC_PROTO_RSL_TRX0, IPAC_PROTO_RSL_TRX1,
101 IPAC_PROTO_RSL_TRX2, IPAC_PROTO_RSL_TRX3 );
Harald Weltedf277252018-02-20 15:49:30 +0100102#endif
Harald Welte0d846a72017-12-07 17:58:28 +0100103
Harald Weltebdb63702017-12-09 01:15:44 +0100104/* Client port for general IPA messages, not further decoded */
Harald Weltec76f29f2017-11-22 12:46:46 +0100105type port IPA_SP_PT message {
Harald Welte0d846a72017-12-07 17:58:28 +0100106 inout ASP_IPA_Unitdata, ASP_IPA_Event;
Harald Weltec76f29f2017-11-22 12:46:46 +0100107} with { extension "internal" }
108
Harald Weltedf277252018-02-20 15:49:30 +0100109#ifdef IPA_EMULATION_MGCP
Harald Weltebdb63702017-12-09 01:15:44 +0100110/* Client port for MGCP inside IPA */
Harald Weltec82eef42017-11-24 20:40:12 +0100111type port IPA_MGCP_PT message {
112 inout MgcpCommand, MgcpResponse;
113} with { extension "internal" }
Harald Weltedf277252018-02-20 15:49:30 +0100114#endif
Harald Weltec82eef42017-11-24 20:40:12 +0100115
Harald Weltedf277252018-02-20 15:49:30 +0100116#ifdef IPA_EMULATION_RSL
Harald Weltebdb63702017-12-09 01:15:44 +0100117/* Client port for A-bis RSL inside IPA */
Harald Welte0d846a72017-12-07 17:58:28 +0100118type port IPA_RSL_PT message {
119 inout ASP_RSL_Unitdata, ASP_IPA_Event;
120} with { extension "internal" }
Harald Weltedf277252018-02-20 15:49:30 +0100121#endif
Harald Welte0d846a72017-12-07 17:58:28 +0100122
Harald Weltea76c4bb2017-12-09 02:06:07 +0100123/* Client port for CTRL inside IPA */
124type port IPA_CTRL_PT message {
125 inout CtrlMessage, ASP_IPA_Event;
126} with { extension "internal" }
127
Harald Weltedf277252018-02-20 15:49:30 +0100128#ifdef IPA_EMULATION_GSUP
Harald Weltedf327232017-12-28 22:51:51 +0100129/* Client port for CTRL inside IPA */
130type port IPA_GSUP_PT message {
131 inout GSUP_PDU, ASP_IPA_Event;
132} with { extension "internal" }
Harald Weltedf277252018-02-20 15:49:30 +0100133#endif
Harald Weltedf327232017-12-28 22:51:51 +0100134
135
Harald Welted86cdc62017-11-22 00:45:07 +0100136type component IPA_Emulation_CT {
137 /* down-facing port to IPA codec port */
138 port IPA_CODEC_PT IPA_PORT;
Harald Weltedf277252018-02-20 15:49:30 +0100139#ifdef IPA_EMULATION_SCCP
Harald Welted86cdc62017-11-22 00:45:07 +0100140 /* up-facing port to SCCP */
141 port MTP3asp_SP_PT MTP3_SP_PORT;
Harald Weltedf277252018-02-20 15:49:30 +0100142#endif
143#ifdef IPA_EMULATION_MGCP
Harald Weltec82eef42017-11-24 20:40:12 +0100144 /* up-facing port for MGCP */
145 port IPA_MGCP_PT IPA_MGCP_PORT;
Harald Weltedf277252018-02-20 15:49:30 +0100146#endif
147#ifdef IPA_EMULATION_RSL
Harald Welte0d846a72017-12-07 17:58:28 +0100148 /* up-facing port for RSL */
149 port IPA_RSL_PT IPA_RSL_PORT;
Harald Weltedf277252018-02-20 15:49:30 +0100150#endif
Harald Weltea76c4bb2017-12-09 02:06:07 +0100151 /* up-facing port for CTRL */
152 port IPA_CTRL_PT IPA_CTRL_PORT;
Harald Weltedf277252018-02-20 15:49:30 +0100153#ifdef IPA_EMULATION_GSUP
Harald Weltedf327232017-12-28 22:51:51 +0100154 /* up-facing port for GSUP */
155 port IPA_GSUP_PT IPA_GSUP_PORT;
Harald Weltedf277252018-02-20 15:49:30 +0100156#endif
Harald Weltedf327232017-12-28 22:51:51 +0100157
Harald Weltec76f29f2017-11-22 12:46:46 +0100158 /* up-facing port for other streams */
159 port IPA_SP_PT IPA_SP_PORT;
Harald Welted86cdc62017-11-22 00:45:07 +0100160
161 var boolean g_initialized := false;
Stefan Sperling830dc9d2018-02-12 21:08:28 +0100162 var IPL4asp_Types.ConnectionId g_ipa_conn_id := -1;
Harald Weltec82eef42017-11-24 20:40:12 +0100163 /* Are we a BSC/MGW (truel) or MSC (false) */
164 var boolean g_is_bsc_mgw;
Harald Welteb3414b22017-11-23 18:22:10 +0100165
166 var IpaMode g_mode;
Harald Welte2d86aff2018-04-17 11:23:04 +0200167 var boolean g_ccm_enabled;
Harald Weltee09921f2017-12-07 17:49:00 +0100168 var IPA_CCM_Parameters g_ccm_pars := c_IPA_default_ccm_pars;
Harald Welted86cdc62017-11-22 00:45:07 +0100169}
170
Harald Weltee21096d2017-12-04 20:45:12 +0100171type record IPA_CCM_Parameters {
172 charstring ser_nr optional,
173 charstring name optional,
174 charstring location1 optional,
175 charstring location2 optional,
176 charstring equip_version optional,
177 charstring sw_version optional,
178 charstring ip_addr optional,
179 charstring mac_addr optional,
180 charstring unit_id optional,
181 charstring osmo_rand optional
182}
183
Harald Weltee09921f2017-12-07 17:49:00 +0100184const IPA_CCM_Parameters c_IPA_default_ccm_pars := {
185 ser_nr := "",
Harald Weltee21096d2017-12-04 20:45:12 +0100186 name := "mahlzeit",
Harald Weltee09921f2017-12-07 17:49:00 +0100187 location1 := "",
188 location2 := "",
189 equip_version := "",
190 sw_version := "",
191 ip_addr := "",
192 mac_addr := "",
Harald Weltee21096d2017-12-04 20:45:12 +0100193 unit_id := "0/1/2",
Harald Weltee09921f2017-12-07 17:49:00 +0100194 osmo_rand := ""
Harald Weltee21096d2017-12-04 20:45:12 +0100195};
196
Harald Weltebdb63702017-12-09 01:15:44 +0100197/* Function to use to connect as client to a remote IPA Server */
Stefan Sperling830dc9d2018-02-12 21:08:28 +0100198function f_connect(charstring remote_host, IPL4asp_Types.PortNumber remote_port,
199 charstring local_host, IPL4asp_Types.PortNumber local_port,
Harald Weltee09921f2017-12-07 17:49:00 +0100200 IPA_CCM_Parameters ccm_pars := c_IPA_default_ccm_pars) runs on IPA_Emulation_CT {
Stefan Sperling830dc9d2018-02-12 21:08:28 +0100201 var IPL4asp_Types.Result res;
Harald Welted86cdc62017-11-22 00:45:07 +0100202 res := IPA_CodecPort_CtrlFunct.f_IPL4_connect(IPA_PORT, remote_host, remote_port,
203 local_host, local_port, 0, { tcp:={} });
Harald Welte9220f632018-05-23 20:27:02 +0200204 if (not ispresent(res.connId)) {
205 setverdict(fail, "Could not connect IPA socket, check your configuration");
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200206 mtc.stop;
Harald Welte9220f632018-05-23 20:27:02 +0200207 }
Harald Welted86cdc62017-11-22 00:45:07 +0100208 g_ipa_conn_id := res.connId;
Harald Weltee21096d2017-12-04 20:45:12 +0100209 g_ccm_pars := ccm_pars;
Harald Weltec82eef42017-11-24 20:40:12 +0100210 g_is_bsc_mgw := true;
Harald Welted86cdc62017-11-22 00:45:07 +0100211}
212
Harald Weltebdb63702017-12-09 01:15:44 +0100213/* Function to use to bind to a local port as IPA server, accepting remote clients */
Stefan Sperling830dc9d2018-02-12 21:08:28 +0100214function f_bind(charstring local_host, IPL4asp_Types.PortNumber local_port,
Harald Weltee09921f2017-12-07 17:49:00 +0100215 IPA_CCM_Parameters ccm_pars := c_IPA_default_ccm_pars) runs on IPA_Emulation_CT {
Stefan Sperling830dc9d2018-02-12 21:08:28 +0100216 var IPL4asp_Types.Result res;
Harald Welteb3414b22017-11-23 18:22:10 +0100217 res := IPA_CodecPort_CtrlFunct.f_IPL4_listen(IPA_PORT,
218 local_host, local_port, { tcp:={} });
Harald Welte9220f632018-05-23 20:27:02 +0200219 if (not ispresent(res.connId)) {
220 setverdict(fail, "Could not listen IPA socket, check your configuration");
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200221 mtc.stop;
Harald Welte9220f632018-05-23 20:27:02 +0200222 }
Harald Welteb3414b22017-11-23 18:22:10 +0100223 g_ipa_conn_id := res.connId;
Harald Weltee21096d2017-12-04 20:45:12 +0100224 g_ccm_pars := ccm_pars;
Harald Weltec82eef42017-11-24 20:40:12 +0100225 g_is_bsc_mgw := false;
Harald Welteb3414b22017-11-23 18:22:10 +0100226}
227
Harald Weltedf277252018-02-20 15:49:30 +0100228#ifdef IPA_EMULATION_SCCP
Harald Welted86cdc62017-11-22 00:45:07 +0100229template ASP_MTP3_TRANSFERind ts_MTP3_XFER_ind(integer opc, octetstring data) := {
230 sio := { '10'B, '00'B, '0011'B },
231 opc := opc,
232 dpc := 0,
233 sls := 0,
234 data := data
235}
Harald Weltedf277252018-02-20 15:49:30 +0100236#endif
Harald Welted86cdc62017-11-22 00:45:07 +0100237
238
239private template IpaCcmRespPart t_IdRespPart(IpaCcmIdTag tag, charstring payload) := {
240 len := 0, /* overwritten by codec */
241 tag := tag,
242 data := payload
243}
244
Harald Welte0d846a72017-12-07 17:58:28 +0100245private function f_send_IPA_EVT(template ASP_IPA_Event evt) runs on IPA_Emulation_CT {
Harald Welte2e32e432018-05-24 20:00:00 +0200246 if (IPA_SP_PORT.checkstate("Connected")) {
247 IPA_SP_PORT.send(evt);
248 }
Harald Weltedf277252018-02-20 15:49:30 +0100249#ifdef IPA_EMULATION_RSL
Harald Welte5819b552017-12-09 02:55:46 +0100250 if (IPA_RSL_PORT.checkstate("Connected")) {
251 IPA_RSL_PORT.send(evt);
252 }
Harald Weltedf277252018-02-20 15:49:30 +0100253#endif
Harald Welte5819b552017-12-09 02:55:46 +0100254 if (IPA_CTRL_PORT.checkstate("Connected")) {
255 IPA_CTRL_PORT.send(evt);
256 }
Harald Weltedf277252018-02-20 15:49:30 +0100257#ifdef IPA_EMULATION_GSUP
Harald Weltedf327232017-12-28 22:51:51 +0100258 if (IPA_GSUP_PORT.checkstate("Connected")) {
259 IPA_GSUP_PORT.send(evt);
260 }
Harald Weltedf277252018-02-20 15:49:30 +0100261#endif
Harald Welte0d846a72017-12-07 17:58:28 +0100262 /* FIXME: to other ports */
263}
264
Harald Welted86cdc62017-11-22 00:45:07 +0100265/* build IPA CCM ID RESP response from IPA CCM GET */
Harald Weltee21096d2017-12-04 20:45:12 +0100266private 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 +0100267 var integer i;
268 var PDU_IPA_CCM resp := {
269 msg_type := IPAC_MSGT_ID_RESP,
270 u := {
271 resp := {}
272 }
273 }
274
275 for (i := 0; i < sizeof(get.u.get); i := i + 1) {
276 var IpaCcmIdTag tag := get.u.get[i].tag;
277 var charstring foo;
278 select (tag) {
Harald Weltee21096d2017-12-04 20:45:12 +0100279 case (IPAC_IDTAG_SERNR) {
280 foo := g_ccm_pars.ser_nr;
Harald Welted86cdc62017-11-22 00:45:07 +0100281 }
282 case (IPAC_IDTAG_UNITNAME) {
Harald Weltee21096d2017-12-04 20:45:12 +0100283 foo := g_ccm_pars.name;
284 }
285 case (IPAC_IDTAG_LOCATION1) {
286 foo := g_ccm_pars.location1;
287 }
288 case (IPAC_IDTAG_LOCATION2) {
289 foo := g_ccm_pars.location2;
290 }
291 case (IPAC_IDTAG_EQUIPVERS) {
292 foo := g_ccm_pars.equip_version;
293 }
294 case (IPAC_IDTAG_SWVERSION) {
295 foo := g_ccm_pars.sw_version;
296 }
297 case (IPAC_IDTAG_IPADDR) {
298 foo := g_ccm_pars.ip_addr;
299 }
300 case (IPAC_IDTAG_MACADDR) {
301 foo := g_ccm_pars.mac_addr;
302 }
303 case (IPAC_IDTAG_UNIT) {
304 foo := g_ccm_pars.unit_id;
305 }
306 case (IPAC_IDTAG_OSMO_RAND) {
307 foo := g_ccm_pars.osmo_rand;
Harald Welted86cdc62017-11-22 00:45:07 +0100308 }
309 case else {
Harald Weltee21096d2017-12-04 20:45:12 +0100310 foo := "unknown";
Harald Welted86cdc62017-11-22 00:45:07 +0100311 }
312 }
313 resp.u.resp[sizeof(resp.u.resp)] := valueof(t_IdRespPart(tag, foo));
314 }
315
316 return resp;
317}
318
319/* transmit IPA CCM message */
320private function f_ccm_tx(PDU_IPA_CCM ccm) runs on IPA_Emulation_CT {
Harald Weltec82eef42017-11-24 20:40:12 +0100321 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 +0100322 log("CCM Tx:", ccm);
323 IPA_PORT.send(ipa_tx);
324}
325
326template PDU_IPA_CCM ts_IPA_PONG := {
327 msg_type := IPAC_MSGT_PONG,
328 u := omit
329}
330
331template PDU_IPA_CCM ts_IPA_ACK := {
332 msg_type := IPAC_MSGT_ID_ACK,
333 u := omit
334}
335
Harald Welteb3414b22017-11-23 18:22:10 +0100336template PDU_IPA_CCM ts_IPA_ID_GET := {
337 msg_type := IPAC_MSGT_ID_GET,
338 u := {
339 get := {
340 { 1, IPAC_IDTAG_UNITNAME }
341 }
342 }
343}
344
Harald Welted86cdc62017-11-22 00:45:07 +0100345/* receive IPA CCM message */
Harald Welte2d86aff2018-04-17 11:23:04 +0200346private function f_ccm_rx_client(PDU_IPA_CCM ccm) runs on IPA_Emulation_CT {
Harald Welted86cdc62017-11-22 00:45:07 +0100347 select (ccm.msg_type) {
348 case (IPAC_MSGT_PING) {
349 f_ccm_tx(valueof(ts_IPA_PONG));
350 }
351 case (IPAC_MSGT_ID_ACK) {
Harald Welte2d86aff2018-04-17 11:23:04 +0200352 f_send_IPA_EVT(t_ASP_IPA_EVT_UD(ASP_IPA_EVENT_ID_ACK));
Harald Welted86cdc62017-11-22 00:45:07 +0100353 }
354 case (IPAC_MSGT_ID_GET) {
355 f_ccm_tx(f_ccm_make_id_resp(ccm));
356 }
Harald Welte2d86aff2018-04-17 11:23:04 +0200357 case else {
358 log("Unknown/unsupported IPA CCM message type", ccm);
359 }
360 }
361}
362
363private function f_ccm_rx_server(PDU_IPA_CCM ccm) runs on IPA_Emulation_CT {
364 select (ccm.msg_type) {
365 case (IPAC_MSGT_PING) {
366 f_ccm_tx(valueof(ts_IPA_PONG));
367 }
368 case (IPAC_MSGT_ID_ACK) {
369 /* the IPA server should at some point receive an ID_ACK from the client,
370 * in case of RSL/OML from nanoBTS, this is actually the first message after
371 * the TCP connection is established. Other implementations may differ.
372 * We currently ignore it completely - but actually we should make sure that
373 * one ID_ACK is received by the server at some point */
Harald Welte2e32e432018-05-24 20:00:00 +0200374 f_send_IPA_EVT(t_ASP_IPA_EVT_UD(ASP_IPA_EVENT_ID_ACK));
Harald Welte2d86aff2018-04-17 11:23:04 +0200375 }
Harald Welte3bc387f2018-02-21 12:18:46 +0100376 case (IPAC_MSGT_ID_RESP) {
377 log("IPA ID RESP: ", ccm.u.resp);
Harald Welte2d86aff2018-04-17 11:23:04 +0200378 /* acknowledge any identity that the client may have sent */
379 f_ccm_tx(valueof(ts_IPA_ACK));
Harald Welte3bc387f2018-02-21 12:18:46 +0100380 }
Harald Welted86cdc62017-11-22 00:45:07 +0100381 case else {
382 log("Unknown/unsupported IPA CCM message type", ccm);
383 }
384 }
385}
386
Harald Weltec76f29f2017-11-22 12:46:46 +0100387private function f_to_asp(IPA_RecvFrom ipa_rx) return ASP_IPA_Unitdata {
388 var ASP_IPA_Unitdata ret := {
389 streamId := ipa_rx.streamId,
Harald Welte2a8f8472017-11-23 21:11:34 +0100390 streamIdExt := ipa_rx.streamIdExt,
Harald Weltec76f29f2017-11-22 12:46:46 +0100391 payload := ipa_rx.msg
392 }
393 return ret;
394}
395
Stefan Sperling830dc9d2018-02-12 21:08:28 +0100396private function f_from_asp(IPL4asp_Types.ConnectionId connId, ASP_IPA_Unitdata ipa_tx) return IPA_Send {
Harald Weltec82eef42017-11-24 20:40:12 +0100397 var IPA_Send ret := valueof(t_IPA_Send(connId, ipa_tx.streamId, ipa_tx.payload,
398 ipa_tx.streamIdExt));
Harald Weltec76f29f2017-11-22 12:46:46 +0100399 return ret;
400}
Harald Welted86cdc62017-11-22 00:45:07 +0100401
Harald Weltedf277252018-02-20 15:49:30 +0100402#ifdef IPA_EMULATION_RSL
Stefan Sperling830dc9d2018-02-12 21:08:28 +0100403private function f_from_rsl(IPL4asp_Types.ConnectionId connId, ASP_RSL_Unitdata rsl_tx) return IPA_Send {
Harald Welte0d846a72017-12-07 17:58:28 +0100404 var octetstring payload := enc_RSL_Message(rsl_tx.rsl);
405 var IPA_Send ret := valueof(t_IPA_Send(connId, rsl_tx.streamId, payload));
406 return ret;
407}
Harald Weltedf277252018-02-20 15:49:30 +0100408#endif
Harald Welte0d846a72017-12-07 17:58:28 +0100409
Harald Weltebdb63702017-12-09 01:15:44 +0100410/* main function to use for a client-side IPA implementation */
Stefan Sperling830dc9d2018-02-12 21:08:28 +0100411function main_client(charstring remote_host, IPL4asp_Types.PortNumber remote_port,
412 charstring local_host, IPL4asp_Types.PortNumber local_port,
Harald Welte2d86aff2018-04-17 11:23:04 +0200413 IPA_CCM_Parameters ccm_pars := c_IPA_default_ccm_pars,
414 boolean ccm_enabled := true) runs on IPA_Emulation_CT {
Harald Welteb3414b22017-11-23 18:22:10 +0100415 g_mode := IPA_MODE_CLIENT;
Harald Welte2d86aff2018-04-17 11:23:04 +0200416 g_ccm_enabled := ccm_enabled;
Harald Weltee09921f2017-12-07 17:49:00 +0100417 f_connect(remote_host, remote_port, local_host, local_port, ccm_pars);
Harald Welte2d86aff2018-04-17 11:23:04 +0200418 if (g_ccm_enabled) {
419 /* we're a client: Send ID_ACK immediately after connect */
420 f_ccm_tx(valueof(ts_IPA_ACK));
421 }
Harald Welte03c0e562017-12-09 02:55:12 +0100422 f_send_IPA_EVT(t_ASP_IPA_EVT_UD(ASP_IPA_EVENT_UP));
Harald Welteb3414b22017-11-23 18:22:10 +0100423 ScanEvents();
424}
425
Harald Weltebdb63702017-12-09 01:15:44 +0100426/* main function to use for a server-side IPA implementation */
Harald Welte2d86aff2018-04-17 11:23:04 +0200427function main_server(charstring local_host, IPL4asp_Types.PortNumber local_port,
428 boolean ccm_enabled := true) runs on IPA_Emulation_CT {
Harald Welteb3414b22017-11-23 18:22:10 +0100429 g_mode := IPA_MODE_SERVER;
Harald Welte2d86aff2018-04-17 11:23:04 +0200430 g_ccm_enabled := ccm_enabled;
Harald Welteb3414b22017-11-23 18:22:10 +0100431 f_bind(local_host, local_port);
432 ScanEvents();
433}
434
Harald Weltedf277252018-02-20 15:49:30 +0100435private function f_ctrl_to_user(octetstring msg) runs on IPA_Emulation_CT {
436 var charstring msg_ch := oct2char(msg);
437 IPA_CTRL_PORT.send(dec_CtrlMessage(msg_ch));
438}
439
440#ifdef IPA_EMULATION_GSUP
441private function f_gsup_to_user(octetstring msg) runs on IPA_Emulation_CT {
442 var GSUP_PDU gsup := dec_GSUP_PDU(msg);
443 f_gsup_postprocess_decoded(gsup);
444 IPA_GSUP_PORT.send(gsup);
445}
446#endif
447
448#ifdef IPA_EMULATION_MGCP
Harald Weltec82eef42017-11-24 20:40:12 +0100449private function f_mgcp_to_user(octetstring msg) runs on IPA_Emulation_CT {
450 var charstring msg_ch := oct2char(msg);
451 if (g_is_bsc_mgw) {
452 log("============");
453 log(msg_ch);
454 IPA_MGCP_PORT.send(dec_MgcpCommand(msg_ch));
455 } else {
456 IPA_MGCP_PORT.send(dec_MgcpResponse(msg_ch));
457 }
458}
459
Harald Welte92632e12017-11-25 02:31:20 +0100460private function f_mgcp_to_ud(octetstring payload) runs on IPA_Emulation_CT return ASP_IPA_Unitdata {
461 if (mp_ipa_mgcp_uses_osmo_ext) {
462 return valueof(t_ASP_IPA_UD(IPAC_PROTO_MGCP_OLD, payload));
463 } else {
464 return valueof(t_ASP_IPA_UD(IPAC_PROTO_OSMO, payload, IPAC_PROTO_EXT_MGCP));
465 }
466}
Harald Weltedf277252018-02-20 15:49:30 +0100467#endif
Harald Welte92632e12017-11-25 02:31:20 +0100468
Harald Weltebdb63702017-12-09 01:15:44 +0100469/* main loop function for both client and server. 'thread' of the component */
Harald Welteb3414b22017-11-23 18:22:10 +0100470private function ScanEvents() runs on IPA_Emulation_CT {
Harald Welted86cdc62017-11-22 00:45:07 +0100471 var IPA_RecvFrom ipa_rx;
Harald Welteb3414b22017-11-23 18:22:10 +0100472 var ASP_Event asp_evt;
Stefan Sperling830dc9d2018-02-12 21:08:28 +0100473 var Socket_API_Definitions.PortEvent port_evt;
Harald Weltedf277252018-02-20 15:49:30 +0100474 var octetstring payload;
475 var CtrlMessage ctrl_msg;
476 var ASP_IPA_Unitdata ipa_ud;
477#ifdef IPA_EMULATION_SCCP
478 var ASP_MTP3_TRANSFERreq mtp_req;
479#endif
480#ifdef IPA_EMULATION_MGCP
Harald Weltec82eef42017-11-24 20:40:12 +0100481 var MgcpCommand mgcp_cmd;
482 var MgcpResponse mgcp_rsp;
Harald Weltedf277252018-02-20 15:49:30 +0100483#endif
484#ifdef IPA_EMULATION_GSUP
Harald Weltedf327232017-12-28 22:51:51 +0100485 var GSUP_PDU gsup_msg;
Harald Weltedf277252018-02-20 15:49:30 +0100486#endif
487#ifdef IPA_EMULATION_RSL
Harald Welte0d846a72017-12-07 17:58:28 +0100488 var ASP_RSL_Unitdata rsl;
Harald Weltedf277252018-02-20 15:49:30 +0100489#endif
Harald Welted86cdc62017-11-22 00:45:07 +0100490
Harald Welte3e6ad892017-12-12 14:39:46 +0100491 /* Set function for dissecting the binary */
492 var f_IPL4_getMsgLen vl_f := refers(f_IPL4_fixedMsgLen);
493 IPA_CodecPort_CtrlFunct.f_IPL4_setGetMsgLen(IPA_PORT, g_ipa_conn_id, vl_f, {0, 2, 3, 1, 0});
494
Harald Welted86cdc62017-11-22 00:45:07 +0100495 while (true) {
496 alt {
497 /* Received IPA -> up into SCCP stack */
Harald Welte2d86aff2018-04-17 11:23:04 +0200498 [g_ccm_enabled] IPA_PORT.receive(IPA_RecvFrom:{?,IPAC_PROTO_CCM,omit,?}) -> value ipa_rx {
499 var PDU_IPA_CCM ccm := dec_PDU_IPA_CCM(ipa_rx.msg);
500 log("CCM Rx:", ccm);
501 select (g_mode) {
502 case (IPA_MODE_CLIENT) {
503 f_ccm_rx_client(ccm);
504 }
505 case (IPA_MODE_SERVER) {
506 f_ccm_rx_server(ccm);
507 }
508 case else {
509 setverdict(fail, "Unknown mode");
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200510 mtc.stop;
Harald Welte2d86aff2018-04-17 11:23:04 +0200511 }
Harald Weltedf277252018-02-20 15:49:30 +0100512 }
Harald Welte2d86aff2018-04-17 11:23:04 +0200513 }
514 [] IPA_PORT.receive(IPA_RecvFrom:?) -> value ipa_rx {
515 select (ipa_rx.streamId) {
Harald Weltedf277252018-02-20 15:49:30 +0100516#ifdef IPA_EMULATION_SCCP
517 case (IPAC_PROTO_SCCP) {
Harald Welted86cdc62017-11-22 00:45:07 +0100518 var ASP_MTP3_TRANSFERind mtp;
519 mtp := valueof(ts_MTP3_XFER_ind(0, ipa_rx.msg));
520 MTP3_SP_PORT.send(mtp);
Harald Weltedf277252018-02-20 15:49:30 +0100521 }
522#endif
523#ifdef IPA_EMULATION_MGCP
524 case (IPAC_PROTO_MGCP_OLD) {
Harald Weltec82eef42017-11-24 20:40:12 +0100525 f_mgcp_to_user(ipa_rx.msg);
Harald Weltedf277252018-02-20 15:49:30 +0100526 }
527#endif
528#ifdef IPA_EMULATION_RSL
529 case (t_IpaSidRSL) {
Harald Welte0d846a72017-12-07 17:58:28 +0100530 rsl := {
531 streamId := ipa_rx.streamId,
532 rsl := dec_RSL_Message(ipa_rx.msg)
533 };
534 IPA_RSL_PORT.send(rsl);
Harald Weltedf277252018-02-20 15:49:30 +0100535 }
536#endif
537 case (IPAC_PROTO_OSMO) {
Harald Weltec82eef42017-11-24 20:40:12 +0100538 select (ipa_rx.streamIdExt) {
Harald Weltedf277252018-02-20 15:49:30 +0100539#ifdef IPA_EMULATION_MGCP
Harald Weltec82eef42017-11-24 20:40:12 +0100540 case (IPAC_PROTO_EXT_MGCP) {
541 f_mgcp_to_user(ipa_rx.msg);
Harald Weltedf277252018-02-20 15:49:30 +0100542 }
543#endif
544 case (IPAC_PROTO_EXT_CTRL) {
Harald Weltea76c4bb2017-12-09 02:06:07 +0100545 f_ctrl_to_user(ipa_rx.msg);
Harald Weltedf277252018-02-20 15:49:30 +0100546 }
547#ifdef IPA_EMULATION_GSUP
548 case (IPAC_PROTO_EXT_GSUP) {
Harald Weltedf327232017-12-28 22:51:51 +0100549 f_gsup_to_user(ipa_rx.msg);
Harald Weltedf277252018-02-20 15:49:30 +0100550 }
551#endif
552 case else {
Harald Weltec82eef42017-11-24 20:40:12 +0100553 IPA_SP_PORT.send(f_to_asp(ipa_rx));
554 }
Harald Welted86cdc62017-11-22 00:45:07 +0100555 }
Harald Weltedf277252018-02-20 15:49:30 +0100556 }
557 case else {
Harald Weltec76f29f2017-11-22 12:46:46 +0100558 IPA_SP_PORT.send(f_to_asp(ipa_rx));
Harald Welted86cdc62017-11-22 00:45:07 +0100559 }
560 }
561 }
562
Harald Welteb3414b22017-11-23 18:22:10 +0100563 /* server only */
564 [] IPA_PORT.receive(ASP_Event:{connOpened:=?}) -> value asp_evt {
565 log("IPA: Connected");
566 g_ipa_conn_id := asp_evt.connOpened.connId;
Harald Welte0d846a72017-12-07 17:58:28 +0100567 f_send_IPA_EVT(t_ASP_IPA_EVT_UD(ASP_IPA_EVENT_UP));
Harald Welte2d86aff2018-04-17 11:23:04 +0200568 if (g_mode == IPA_MODE_SERVER and g_ccm_enabled) {
Harald Welteb3414b22017-11-23 18:22:10 +0100569 f_ccm_tx(valueof(ts_IPA_ID_GET));
570 }
571 }
572
573 [] IPA_PORT.receive(ASP_Event:{connClosed:=?}) -> value asp_evt {
574 log("IPA: Closed");
575 g_ipa_conn_id := -1;
Harald Welte0d846a72017-12-07 17:58:28 +0100576 f_send_IPA_EVT(t_ASP_IPA_EVT_UD(ASP_IPA_EVENT_DOWN));
Harald Welteb3414b22017-11-23 18:22:10 +0100577 self.stop;
578 }
579
Stefan Sperling830dc9d2018-02-12 21:08:28 +0100580 [] IPA_PORT.receive(Socket_API_Definitions.PortEvent:{result:={errorCode:=ERROR_SOCKET, connId:=?, os_error_code:=?, os_error_text:=?}}) -> value port_evt {
581 log("PortEvent: ERROR_SOCKET: ", port_evt);
582 g_ipa_conn_id := -1;
583 f_send_IPA_EVT(t_ASP_IPA_EVT_UD(ASP_IPA_EVENT_DOWN));
584 self.stop;
585 }
586
Harald Weltedf277252018-02-20 15:49:30 +0100587#ifdef IPA_EMULATION_SCCP
Harald Welted86cdc62017-11-22 00:45:07 +0100588 /* Received SCCP -> down into IPA */
589 [] MTP3_SP_PORT.receive(ASP_MTP3_TRANSFERreq: ?) -> value mtp_req {
Harald Weltec82eef42017-11-24 20:40:12 +0100590 var IPA_Send ipa_tx := valueof(t_IPA_Send(g_ipa_conn_id, IPAC_PROTO_SCCP,
591 mtp_req.data));
Harald Welted86cdc62017-11-22 00:45:07 +0100592 IPA_PORT.send(ipa_tx);
593 }
Harald Weltedf277252018-02-20 15:49:30 +0100594#endif
Harald Weltec76f29f2017-11-22 12:46:46 +0100595
Harald Weltedf277252018-02-20 15:49:30 +0100596#ifdef IPA_EMULATION_MGCP
Harald Weltec82eef42017-11-24 20:40:12 +0100597 /* Received MGCP -> down into IPA */
598 [] IPA_MGCP_PORT.receive(MgcpCommand:?) -> value mgcp_cmd {
Harald Welte92632e12017-11-25 02:31:20 +0100599 payload := char2oct(enc_MgcpCommand(mgcp_cmd));
600 ipa_ud := f_mgcp_to_ud(payload);
Harald Weltec82eef42017-11-24 20:40:12 +0100601 IPA_PORT.send(f_from_asp(g_ipa_conn_id, ipa_ud));
602 }
603 [] IPA_MGCP_PORT.receive(MgcpResponse:?) -> value mgcp_rsp {
Harald Welte1dd8f372017-11-25 02:25:27 +0100604 payload := char2oct(enc_MgcpResponse(mgcp_rsp));
Harald Welte92632e12017-11-25 02:31:20 +0100605 ipa_ud := f_mgcp_to_ud(payload);
Harald Weltec82eef42017-11-24 20:40:12 +0100606 IPA_PORT.send(f_from_asp(g_ipa_conn_id, ipa_ud));
607 }
Harald Weltedf277252018-02-20 15:49:30 +0100608#endif
Harald Weltec82eef42017-11-24 20:40:12 +0100609
Harald Weltea76c4bb2017-12-09 02:06:07 +0100610 [] IPA_CTRL_PORT.receive(CtrlMessage:?) -> value ctrl_msg {
611 payload := char2oct(enc_CtrlMessage(ctrl_msg));
612 ipa_ud := valueof(t_ASP_IPA_UD(IPAC_PROTO_OSMO, payload, IPAC_PROTO_EXT_CTRL));
613 IPA_PORT.send(f_from_asp(g_ipa_conn_id, ipa_ud));
614 }
615
Harald Weltedf277252018-02-20 15:49:30 +0100616#ifdef IPA_EMULATION_GSUP
Harald Weltedf327232017-12-28 22:51:51 +0100617 [] IPA_GSUP_PORT.receive(GSUP_PDU:?) -> value gsup_msg {
Harald Welte2f562b12018-01-24 20:52:38 +0100618 f_gsup_preprocess_encoded(gsup_msg);
Harald Weltedf327232017-12-28 22:51:51 +0100619 payload := enc_GSUP_PDU(gsup_msg);
620 ipa_ud := valueof(t_ASP_IPA_UD(IPAC_PROTO_OSMO, payload, IPAC_PROTO_EXT_GSUP));
621 IPA_PORT.send(f_from_asp(g_ipa_conn_id, ipa_ud));
622 }
Harald Weltedf277252018-02-20 15:49:30 +0100623#endif
Harald Weltedf327232017-12-28 22:51:51 +0100624
Harald Weltedf277252018-02-20 15:49:30 +0100625#ifdef IPA_EMULATION_RSL
Harald Welte0d846a72017-12-07 17:58:28 +0100626 /* Received RSL -> down into IPA */
627 [] IPA_RSL_PORT.receive(ASP_RSL_Unitdata:?) -> value rsl {
628 IPA_PORT.send(f_from_rsl(g_ipa_conn_id, rsl));
629 }
Harald Weltedf277252018-02-20 15:49:30 +0100630#endif
Harald Welte0d846a72017-12-07 17:58:28 +0100631
632 /* Received MISC (OML/CTRL) -> down into IPA */
Harald Weltec76f29f2017-11-22 12:46:46 +0100633 [] IPA_SP_PORT.receive(ASP_IPA_Unitdata: ?) -> value ipa_ud {
634 IPA_PORT.send(f_from_asp(g_ipa_conn_id, ipa_ud));
635 }
636
637
Harald Welted86cdc62017-11-22 00:45:07 +0100638 }
639 }
640}
641
Harald Welte2e32e432018-05-24 20:00:00 +0200642/***********************************************************************
643 * IPA Event waiter component. Wait for ASP_IPA_EVENT_ID_ACK
644 ***********************************************************************/
645
646type component IPA_EventWaiter_CT {
647 port IPA_SP_PT IPA_SP_PORT;
648}
649
650function waiter_main(template ASP_IPA_Event wait_for := t_ASP_IPA_EVT_UD(ASP_IPA_EVENT_ID_ACK))
651runs on IPA_EventWaiter_CT {
652
653 alt {
654 [] IPA_SP_PORT.receive(wait_for) {
655 setverdict(pass);
656 }
657 [] IPA_SP_PORT.receive { repeat; }
658 }
659}
660
661
Harald Welted86cdc62017-11-22 00:45:07 +0100662}