blob: 0d4c81b66f7043a06eef0c7944bcac33004a01bf [file] [log] [blame]
Harald Welte28d943e2017-11-25 15:00:50 +01001module MSC_ConnectionHandler {
2
Harald Welte34b5a952019-05-27 11:54:11 +02003/* MSC Connection HAndler of BSC Tests in TTCN-3
4 * (C) 2017-2019 Harald Welte <laforge@gnumonks.org>
5 * contributions by sysmocom - s.f.m.c. GmbH
6 * All rights reserved.
7 *
8 * Released under the terms of GNU General Public License, Version 2 or
9 * (at your option) any later version.
10 *
11 * SPDX-License-Identifier: GPL-2.0-or-later
12 */
13
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +010014import from Misc_Helpers all;
Harald Welte28d943e2017-11-25 15:00:50 +010015import from General_Types all;
16import from Osmocom_Types all;
Harald Weltec1a2fff2017-12-17 11:06:19 +010017import from GSM_Types all;
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +020018import from IPA_Emulation all;
Harald Welte28d943e2017-11-25 15:00:50 +010019import from SCCPasp_Types all;
20import from BSSAP_Types all;
Harald Welte6811d102019-04-14 22:23:14 +020021import from RAN_Emulation all;
Harald Welte28d943e2017-11-25 15:00:50 +010022import from BSSMAP_Templates all;
23
Harald Welte211219e2018-01-29 22:03:36 +010024import from IPL4asp_Types all;
25import from Native_Functions all;
26
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +020027import from MGCP_CodecPort all;
Harald Welte28d943e2017-11-25 15:00:50 +010028import from MGCP_Types all;
29import from MGCP_Templates all;
Daniel Willmann191e0d92018-01-17 12:44:35 +010030import from MGCP_Emulation all;
Harald Welte28d943e2017-11-25 15:00:50 +010031import from SDP_Types all;
32
Harald Weltec1a2fff2017-12-17 11:06:19 +010033import from RSL_Emulation all;
34import from RSL_Types all;
35
36import from MobileL3_Types all;
37import from MobileL3_CommonIE_Types all;
Harald Welte211219e2018-01-29 22:03:36 +010038import from MobileL3_RRM_Types all;
Harald Weltec1a2fff2017-12-17 11:06:19 +010039import from L3_Templates all;
40
Harald Weltec20b1c42018-02-12 20:50:08 +010041import from TELNETasp_PortType all;
42import from Osmocom_VTY_Functions all;
43
Harald Weltec1a2fff2017-12-17 11:06:19 +010044
Harald Welte211219e2018-01-29 22:03:36 +010045/***********************************************************************
46 * Media related handling
47 ***********************************************************************/
48
Philipp Maier11a58942018-06-25 16:40:48 +020049/* Get the matching payload type for a specified BSSAP codec type
50 * (see also: BSSAP_Types.ttcn */
51private function f_get_mgcp_pt(BSSMAP_FIELD_CodecType codecType) return SDP_FIELD_PayloadType {
52 if (codecType == GSM_FR) {
53 return PT_GSM;
54 } else if (codecType == GSM_HR) {
55 return PT_GSMHR;
56 } else if (codecType == GSM_EFR) {
57 return PT_GSMEFR;
58 } else if (codecType == FR_AMR or codecType == HR_AMR) {
59 return PT_AMR;
60 } else if (codecType == FR_AMR_WB or codecType == OHR_AMR or codecType == OFR_AMR_WB or codecType == OHR_AMR_WB) {
61 return PT_AMRWB;
62 }
63
64 return PT_PCMU;
65}
66
Harald Welte211219e2018-01-29 22:03:36 +010067/* Tuple containing host/ip and port */
68type record HostPort {
69 HostName host,
70 PortNumber port_nr
71};
72
73/* State encapsulating one MGCP Connection */
74type record MgcpConnState {
Philipp Maier3e2af5d2018-07-11 17:01:05 +020075 integer crcx_seen, /* Counts how many CRCX operations happend */
76 integer mdcx_seen, /* Counts how many MDCX operations happend C */
77 integer crcx_seen_exp, /* Sets the expected number of CRCX operations */
78 integer mdcx_seen_exp, /* Sets the expected number of MDCX operations */
Harald Welte211219e2018-01-29 22:03:36 +010079 MgcpConnectionId conn_id,
80 charstring mime_type, /* e.g. AMR */
81 integer sample_rate, /* 8000 */
82 integer ptime, /* 20 */
83 uint7_t rtp_pt, /* RTP Payload Type */
84 HostPort mgw, /* MGW side */
85 HostPort peer /* CA side */
86};
87
88/* BTS media state */
89type record BtsMediaState {
90 boolean ipa_crcx_seen,
Philipp Maierc1e95c82018-07-18 16:03:00 +020091 boolean ipa_mdcx_seen,
Harald Welte211219e2018-01-29 22:03:36 +010092 uint16_t conn_id,
93 uint7_t rtp_pt,
94 HostPort bts,
95 HostPort peer
96};
97
98type record MediaState {
99 MgcpEndpoint mgcp_ep,
100 MgcpConnState mgcp_conn[2],
Harald Welte261af4b2018-02-12 21:20:39 +0100101 BtsMediaState bts,
102 BtsMediaState bts1 /* only during hand-over */
Harald Welte211219e2018-01-29 22:03:36 +0100103};
104
Philipp Maier11a58942018-06-25 16:40:48 +0200105function f_MediaState_init(inout MediaState g_media, integer nr, HostName bts, HostName mgw, BSSMAP_FIELD_CodecType codecType) {
Harald Welte211219e2018-01-29 22:03:36 +0100106 /* BTS Side */
107 g_media.bts := {
108 ipa_crcx_seen := false,
Philipp Maierc1e95c82018-07-18 16:03:00 +0200109 ipa_mdcx_seen := false,
Harald Welte211219e2018-01-29 22:03:36 +0100110 conn_id := nr,
111 rtp_pt := 0,
112 bts := {
113 host := bts,
114 port_nr := 9000 + nr*2
115 },
116 peer := -
117 }
118
Harald Welte261af4b2018-02-12 21:20:39 +0100119 g_media.bts1 := {
120 ipa_crcx_seen := false,
Philipp Maierc1e95c82018-07-18 16:03:00 +0200121 ipa_mdcx_seen := false,
Harald Welte261af4b2018-02-12 21:20:39 +0100122 conn_id := nr,
123 rtp_pt := 0,
124 bts := {
125 host := bts, /* FIXME */
126 port_nr := 9000 + nr*2
127 },
128 peer := -
129 }
130
Harald Welte363cb0a2018-01-30 19:35:53 +0100131 g_media.mgcp_ep := "rtpbridge/" & int2str(nr) & "@mgw";
Harald Welte211219e2018-01-29 22:03:36 +0100132
133 for (var integer i:= 0; i < sizeof(g_media.mgcp_conn); i := i+1) {
Philipp Maier11a58942018-06-25 16:40:48 +0200134 g_media.mgcp_conn[i].mime_type := f_encoding_name_from_pt(f_get_mgcp_pt(codecType));
Harald Welte211219e2018-01-29 22:03:36 +0100135 g_media.mgcp_conn[i].sample_rate := 8000;
136 g_media.mgcp_conn[i].ptime := 20;
Philipp Maier11a58942018-06-25 16:40:48 +0200137 g_media.mgcp_conn[i].rtp_pt := enum2int(f_get_mgcp_pt(codecType));
Philipp Maier3e2af5d2018-07-11 17:01:05 +0200138 g_media.mgcp_conn[i].crcx_seen := 0;
139 g_media.mgcp_conn[i].mdcx_seen := 0;
140 g_media.mgcp_conn[i].crcx_seen_exp := 0;
141 g_media.mgcp_conn[i].mdcx_seen_exp := 0;
Harald Welte211219e2018-01-29 22:03:36 +0100142 g_media.mgcp_conn[i].conn_id := f_mgcp_alloc_conn_id();
143 }
144
145 g_media.mgcp_conn[0].mgw := {
146 host := mgw,
147 port_nr := 10000 + nr*2
148 }
149 g_media.mgcp_conn[1].mgw := {
150 host := mgw,
151 port_nr := 11000 + nr*2
152 }
153}
154
Philipp Maier3e2af5d2018-07-11 17:01:05 +0200155/* Helper function to get the next free MGCP connection identifier. We can
156 * recognize free connection identifiers by the fact that no CRCX happend yet */
Harald Welte211219e2018-01-29 22:03:36 +0100157private function f_get_free_mgcp_conn() runs on MSC_ConnHdlr return integer {
158 for (var integer i:= 0; i < sizeof(g_media.mgcp_conn); i := i+1) {
Philipp Maier3e2af5d2018-07-11 17:01:05 +0200159 if (not g_media.mgcp_conn[i].crcx_seen >= 1) {
Harald Welte211219e2018-01-29 22:03:36 +0100160 return i;
161 }
162 }
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100163 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Only 2 Connections per EP!");
164 /* Should never be reached */
165 return -1;
Harald Welte211219e2018-01-29 22:03:36 +0100166}
167
Philipp Maier3e2af5d2018-07-11 17:01:05 +0200168/* Helper function to pick a specific connection by its cid. Since we reach out
169 * for a connection that is in-use we also check if there was already exactly
170 * one CRCX happening on that connection. */
Harald Welte211219e2018-01-29 22:03:36 +0100171private function f_get_mgcp_conn(MgcpConnectionId cid) runs on MSC_ConnHdlr return integer {
172 for (var integer i:= 0; i < sizeof(g_media.mgcp_conn); i := i+1) {
Philipp Maier3e2af5d2018-07-11 17:01:05 +0200173 if (g_media.mgcp_conn[i].conn_id == cid and g_media.mgcp_conn[i].crcx_seen == 1) {
Harald Welte211219e2018-01-29 22:03:36 +0100174 return i;
175 }
176 }
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100177 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, log2str("No Connection for ID ", cid));
178 /* Should not be reached */
179 return -1;
Harald Welte211219e2018-01-29 22:03:36 +0100180}
181
Philipp Maierb2422352018-07-11 10:36:57 +0200182/* altstep for handling of IPACC media related commands. Activated by as_Media() to test
183 * RSL level media handling */
184altstep as_Media_ipacc() runs on MSC_ConnHdlr {
Harald Welte211219e2018-01-29 22:03:36 +0100185 var RSL_Message rsl;
Harald Welte211219e2018-01-29 22:03:36 +0100186 var RSL_IE_Body ie;
Harald Welte930d0a72018-03-22 22:08:40 +0100187 var boolean b_unused;
Harald Welte211219e2018-01-29 22:03:36 +0100188 [not g_media.bts.ipa_crcx_seen] RSL.receive(tr_RSL_IPA_CRCX(g_chan_nr)) -> value rsl {
189 /* Extract parameters from request + use in response */
190 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
191 g_media.bts.rtp_pt := ie.ipa_rtp_pt;
192 }
193 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
194 g_media.bts.rtp_pt := ie.ipa_rtp_pt2;
195 }
196 RSL.send(ts_RSL_IPA_CRCX_ACK(g_chan_nr, g_media.bts.conn_id,
197 oct2int(f_inet_addr(g_media.bts.bts.host)),
198 g_media.bts.bts.port_nr,
199 g_media.bts.rtp_pt));
200 g_media.bts.ipa_crcx_seen := true;
201 repeat;
202 }
203 [g_media.bts.ipa_crcx_seen] RSL.receive(tr_RSL_IPA_MDCX(g_chan_nr, ?)) -> value rsl{
204 /* Extract conn_id, ip, port, rtp_pt2 from request + use in response */
Harald Welte930d0a72018-03-22 22:08:40 +0100205 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_CONN_ID, ie);
Harald Welte211219e2018-01-29 22:03:36 +0100206 if (g_media.bts.conn_id != ie.ipa_conn_id) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100207 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, log2str("IPA MDCX for unknown ConnId", rsl));
Harald Welte211219e2018-01-29 22:03:36 +0100208 }
209 /* mandatory */
Harald Welte930d0a72018-03-22 22:08:40 +0100210 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_IP, ie);
Harald Welte211219e2018-01-29 22:03:36 +0100211 g_media.bts.peer.host := f_inet_ntoa(int2oct(ie.ipa_remote_ip, 4));
Harald Welte930d0a72018-03-22 22:08:40 +0100212 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_PORT, ie);
Harald Welte211219e2018-01-29 22:03:36 +0100213 g_media.bts.peer.port_nr := ie.ipa_remote_port;
214 /* optional */
215 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
216 g_media.bts.rtp_pt := ie.ipa_rtp_pt;
217 }
218 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
219 g_media.bts.rtp_pt := ie.ipa_rtp_pt2;
220 }
221 RSL.send(ts_RSL_IPA_MDCX_ACK(g_chan_nr, g_media.bts.conn_id,
222 oct2int(f_inet_addr(g_media.bts.peer.host)),
223 g_media.bts.peer.port_nr,
224 g_media.bts.rtp_pt));
Philipp Maierc1e95c82018-07-18 16:03:00 +0200225 g_media.bts.ipa_mdcx_seen := true;
Harald Welte211219e2018-01-29 22:03:36 +0100226 repeat;
227 }
Harald Welte261af4b2018-02-12 21:20:39 +0100228
229 /* on second (new) BTS during hand-over */
230 [not g_media.bts1.ipa_crcx_seen] RSL1.receive(tr_RSL_IPA_CRCX(g_chan_nr)) -> value rsl {
231 /* Extract parameters from request + use in response */
232 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
233 g_media.bts1.rtp_pt := ie.ipa_rtp_pt;
234 }
235 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
236 g_media.bts1.rtp_pt := ie.ipa_rtp_pt2;
237 }
238 RSL1.send(ts_RSL_IPA_CRCX_ACK(g_chan_nr, g_media.bts1.conn_id,
239 oct2int(f_inet_addr(g_media.bts1.bts.host)),
240 g_media.bts1.bts.port_nr,
241 g_media.bts1.rtp_pt));
242 g_media.bts1.ipa_crcx_seen := true;
243 repeat;
244 }
245 /* on second (new) BTS during hand-over */
246 [g_media.bts1.ipa_crcx_seen] RSL1.receive(tr_RSL_IPA_MDCX(g_chan_nr, ?)) -> value rsl{
247 /* Extract conn_id, ip, port, rtp_pt2 from request + use in response */
Harald Welte930d0a72018-03-22 22:08:40 +0100248 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_CONN_ID, ie);
Harald Welte261af4b2018-02-12 21:20:39 +0100249 if (g_media.bts1.conn_id != ie.ipa_conn_id) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100250 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, log2str("IPA MDCX for unknown ConnId", rsl));
Harald Welte261af4b2018-02-12 21:20:39 +0100251 }
252 /* mandatory */
Harald Welte930d0a72018-03-22 22:08:40 +0100253 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_IP, ie);
Harald Welte261af4b2018-02-12 21:20:39 +0100254 g_media.bts1.peer.host := f_inet_ntoa(int2oct(ie.ipa_remote_ip, 4));
Harald Welte930d0a72018-03-22 22:08:40 +0100255 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_PORT, ie);
Harald Welte261af4b2018-02-12 21:20:39 +0100256 g_media.bts1.peer.port_nr := ie.ipa_remote_port;
257 /* optional */
258 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
259 g_media.bts1.rtp_pt := ie.ipa_rtp_pt;
260 }
261 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
262 g_media.bts1.rtp_pt := ie.ipa_rtp_pt2;
263 }
264 RSL1.send(ts_RSL_IPA_MDCX_ACK(g_chan_nr, g_media.bts1.conn_id,
265 oct2int(f_inet_addr(g_media.bts1.peer.host)),
266 g_media.bts1.peer.port_nr,
267 g_media.bts1.rtp_pt));
Philipp Maierc1e95c82018-07-18 16:03:00 +0200268 g_media.bts1.ipa_mdcx_seen := true;
Harald Welte261af4b2018-02-12 21:20:39 +0100269 repeat;
270 }
271
Philipp Maierb2422352018-07-11 10:36:57 +0200272
273}
274
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200275function f_rx_crcx(MgcpCommand mgcp_cmd)
276 runs on MSC_ConnHdlr return template MgcpResponse {
277 var MgcpOsmuxCID osmux_cid;
278 var SDP_Message sdp;
279 var integer cid := f_get_free_mgcp_conn();
280 if (match(mgcp_cmd.line.ep, t_MGCP_EP_wildcard)) {
281 if (cid != 0) {
282 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "MGCP wildcard EP only works in first CRCX");
283 }
284 /* we keep the endpoint name allocated during MediaState_init */
285 } else {
286 /* Call Agent allocated endpoint, trust/use it always */
287 g_media.mgcp_ep := mgcp_cmd.line.ep;
288 }
289 if (isvalue(mgcp_cmd.sdp)) {
290 sdp := mgcp_cmd.sdp;
291 g_media.mgcp_conn[cid].peer.host := sdp.connection.conn_addr.addr;
292 g_media.mgcp_conn[cid].peer.port_nr := sdp.media_list[0].media_field.ports.port_number;
293 }
294 var MgcpConnState mgcp_conn := g_media.mgcp_conn[cid];
295 sdp := valueof(ts_SDP(mgcp_conn.mgw.host, mgcp_conn.mgw.host, "foo", "21",
296 mgcp_conn.mgw.port_nr, { int2str(mgcp_conn.rtp_pt) },
297 {valueof(ts_SDP_rtpmap(mgcp_conn.rtp_pt,
298 mgcp_conn.mime_type & "/" &
299 int2str(mgcp_conn.sample_rate))),
300 valueof(ts_SDP_ptime(mgcp_conn.ptime)) } ));
301 var template MgcpResponse mgcp_resp;
302 if (g_pars.use_osmux and f_MgcpCmd_contains_par(mgcp_cmd, "X-OSMUX")) {
303 osmux_cid := f_MgcpCmd_extract_osmux_cid(mgcp_cmd);
304 mgcp_resp := ts_CRCX_ACK_osmux(mgcp_cmd.line.trans_id, mgcp_conn.conn_id, osmux_cid, sdp);
305 } else {
306 mgcp_resp := ts_CRCX_ACK(mgcp_cmd.line.trans_id, mgcp_conn.conn_id, sdp);
307 }
308 f_mgcp_par_append(mgcp_resp.params, ts_MgcpParSpecEP(g_media.mgcp_ep));
309 g_media.mgcp_conn[cid].crcx_seen := g_media.mgcp_conn[cid].crcx_seen + 1;
310 return mgcp_resp;
311}
312
313function f_rx_mdcx(MgcpCommand mgcp_cmd)
314 runs on MSC_ConnHdlr return template MgcpResponse {
315 var SDP_Message sdp;
316 var integer cid := f_get_mgcp_conn(f_MgcpCmd_extract_conn_id(mgcp_cmd));
317 if (isvalue(mgcp_cmd.sdp)) {
318 sdp := mgcp_cmd.sdp;
319 g_media.mgcp_conn[cid].peer.host := sdp.connection.conn_addr.addr;
320 g_media.mgcp_conn[cid].peer.port_nr := sdp.media_list[0].media_field.ports.port_number;
321 } else {
322 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "MDCX has no [recognizable] SDP");
323 }
324 var MgcpConnState mgcp_conn := g_media.mgcp_conn[cid];
325 sdp := valueof(ts_SDP(mgcp_conn.peer.host, mgcp_conn.peer.host, "foo", "21",
326 mgcp_conn.peer.port_nr, { int2str(mgcp_conn.rtp_pt) },
327 {valueof(ts_SDP_rtpmap(mgcp_conn.rtp_pt,
328 mgcp_conn.mime_type & "/" &
329 int2str(mgcp_conn.sample_rate))),
330 valueof(ts_SDP_ptime(mgcp_conn.ptime)) } ));
331 g_media.mgcp_conn[cid].mdcx_seen := g_media.mgcp_conn[cid].mdcx_seen + 1;
332 return ts_MDCX_ACK(mgcp_cmd.line.trans_id, mgcp_conn.conn_id, sdp);
333}
334
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200335function tr_MGCP_RecvFrom_any(template MgcpMessage msg)
336runs on MSC_ConnHdlr return template MGCP_RecvFrom {
337 var template MGCP_RecvFrom mrf := {
338 connId := ?,
339 remName := ?,
340 remPort := ?,
341 locName := ?,
342 locPort := ?,
343 msg := msg
344 }
345 return mrf;
346}
347
Philipp Maierb2422352018-07-11 10:36:57 +0200348/* altstep for handling of MGCP media related commands. Activated by as_Media() to test
349 * MGW level media handling */
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200350
Philipp Maierc1e95c82018-07-18 16:03:00 +0200351altstep as_Media_mgw(boolean norepeat := false) runs on MSC_ConnHdlr {
Philipp Maierb2422352018-07-11 10:36:57 +0200352 var MgcpCommand mgcp_cmd;
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200353 var template MgcpResponse mgcp_resp;
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200354 var MGCP_RecvFrom mrf;
355 var template MgcpMessage msg_crcx := {
356 command := tr_CRCX
357 }
358 var template MgcpMessage msg_mdcx := {
359 command := tr_MDCX
360 }
361 var template MgcpMessage msg_resp;
Philipp Maierb2422352018-07-11 10:36:57 +0200362
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200363 [g_pars.aoip] MGCP.receive(tr_CRCX) -> value mgcp_cmd {
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200364 mgcp_resp := f_rx_crcx(mgcp_cmd);
Harald Welte363cb0a2018-01-30 19:35:53 +0100365 MGCP.send(mgcp_resp);
Philipp Maierc1e95c82018-07-18 16:03:00 +0200366 if(norepeat == false) {
367 repeat;
368 }
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200369 }
370
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200371 [not g_pars.aoip] MGCP_MULTI.receive(tr_MGCP_RecvFrom_any(msg_crcx)) -> value mrf {
372 mgcp_resp := f_rx_crcx(mrf.msg.command);
373 msg_resp := {
374 response := mgcp_resp
375 }
376 MGCP_MULTI.send(t_MGCP_SendToMrf(mrf, msg_resp));
377 if(norepeat == false) {
378 repeat;
379 }
380 }
381
382 [g_pars.aoip] MGCP.receive(tr_MDCX) -> value mgcp_cmd {
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200383 mgcp_resp := f_rx_mdcx(mgcp_cmd);
384 MGCP.send(mgcp_resp);
Philipp Maierc1e95c82018-07-18 16:03:00 +0200385 if(norepeat == false) {
386 repeat;
387 }
Harald Welte211219e2018-01-29 22:03:36 +0100388 }
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200389
390 [not g_pars.aoip] MGCP_MULTI.receive(tr_MGCP_RecvFrom_any(msg_mdcx)) -> value mrf {
391 mgcp_resp := f_rx_mdcx(mrf.msg.command);
392 msg_resp := {
393 response := mgcp_resp
394 }
395 MGCP_MULTI.send(t_MGCP_SendToMrf(mrf, msg_resp));
396 if(norepeat == false) {
397 repeat;
398 }
399 }
Harald Welte211219e2018-01-29 22:03:36 +0100400}
401
Philipp Maierb2422352018-07-11 10:36:57 +0200402/* Altsteps for handling of media related commands. Can be activated by a given
403 * test case if it expects to see media related handling (i.e. voice calls) */
404altstep as_Media() runs on MSC_ConnHdlr {
405 [] as_Media_ipacc();
406 [] as_Media_mgw();
407}
Harald Welte211219e2018-01-29 22:03:36 +0100408
Harald Welte28d943e2017-11-25 15:00:50 +0100409/* this component represents a single subscriber connection at the MSC.
Harald Welte6811d102019-04-14 22:23:14 +0200410 * There is a 1:1 mapping between SCCP connections and RAN_ConnHdlr components.
411 * We inherit all component variables, ports, functions, ... from RAN_ConnHdlr */
412type component MSC_ConnHdlr extends RAN_ConnHdlr, RSL_DchanHdlr, MGCP_ConnHdlr {
Harald Welte28d943e2017-11-25 15:00:50 +0100413 /* SCCP Connecction Identifier for the underlying SCCP connection */
414 var integer g_sccp_conn_id;
415
Harald Welte6811d102019-04-14 22:23:14 +0200416 /* procedure port back to our parent (RAN_Emulation_CT) for control */
417 port RAN_PROC_PT RAN;
Harald Weltec20b1c42018-02-12 20:50:08 +0100418 port TELNETasp_PT BSCVTY;
Harald Welte28d943e2017-11-25 15:00:50 +0100419
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200420 /* Proxy MGCP-over-IPA and MGCP-over-UDP */
421 port IPA_MGCP_PT MGCP_MSC_CLIENT;
422 var integer g_trans_id := 0;
423
Harald Welte211219e2018-01-29 22:03:36 +0100424 var MediaState g_media;
Harald Weltea0630032018-03-20 21:09:55 +0100425 var TestHdlrParams g_pars;
Harald Weltee97eab42018-03-21 18:46:06 +0100426
Pau Espin Pedrol392963f2019-06-18 17:17:19 +0200427 var charstring host_bts := "127.0.0.2";
428 var charstring host_mgw := "127.0.0.3";
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200429 var charstring host_msc := "127.0.0.4";
430
Harald Weltee97eab42018-03-21 18:46:06 +0100431 var boolean g_vty_initialized := false;
Harald Welte211219e2018-01-29 22:03:36 +0100432}
433
434/* initialize all parameters */
Philipp Maier11a58942018-06-25 16:40:48 +0200435function f_MscConnHdlr_init(integer i, HostName bts, HostName mgw, BSSMAP_FIELD_CodecType codecType) runs on MSC_ConnHdlr {
436 f_MediaState_init(g_media, i, bts, mgw, codecType);
Harald Weltee97eab42018-03-21 18:46:06 +0100437 if (not g_vty_initialized) {
438 map(self:BSCVTY, system:BSCVTY);
439 f_vty_set_prompts(BSCVTY);
440 f_vty_transceive(BSCVTY, "enable");
441 g_vty_initialized := true;
442 }
Harald Welte28d943e2017-11-25 15:00:50 +0100443}
444
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200445private function get_next_trans_id() runs on MSC_ConnHdlr return MgcpTransId {
446 var MgcpTransId tid := int2str(g_trans_id);
447 g_trans_id := g_trans_id + 1;
448 return tid;
449}
450
Harald Welte6811d102019-04-14 22:23:14 +0200451/* Callback function from general RAN_Emulation whenever a connectionless
Harald Welte28d943e2017-11-25 15:00:50 +0100452 * BSSMAP message arrives. Can retunr a PDU_BSSAP that should be sent in return */
453private function UnitdataCallback(PDU_BSSAP bssap)
Harald Welte6811d102019-04-14 22:23:14 +0200454runs on RAN_Emulation_CT return template PDU_BSSAP {
Harald Welte28d943e2017-11-25 15:00:50 +0100455 var template PDU_BSSAP resp := omit;
Pau Espin Pedrol95549182019-06-06 16:17:30 +0200456 var boolean append_osmux_support := g_ran_ops.use_osmux and
457 (g_ran_ops.transport == BSSAP_TRANSPORT_AoIP);
Harald Welte28d943e2017-11-25 15:00:50 +0100458
Harald Weltec1a2fff2017-12-17 11:06:19 +0100459 /* answer all RESET with a RESET ACK */
Pau Espin Pedrol95549182019-06-06 16:17:30 +0200460 if (match(bssap, tr_BSSMAP_Reset(append_osmux_support))) {
461 resp := ts_BSSMAP_ResetAck(append_osmux_support);
Harald Welte28d943e2017-11-25 15:00:50 +0100462 }
463
464 return resp;
465}
466
Harald Welte6811d102019-04-14 22:23:14 +0200467const RanOps MSC_RanOps := {
468 create_cb := refers(RAN_Emulation.ExpectedCreateCallback),
Harald Welte0b476062018-01-21 19:07:32 +0100469 unitdata_cb := refers(UnitdataCallback),
470 decode_dtap := false,
Harald Welte930d0a72018-03-22 22:08:40 +0100471 role_ms := false,
Harald Welte2fce7882019-04-15 11:48:05 +0200472 protocol := RAN_PROTOCOL_BSSAP,
Pau Espin Pedrolc6b78ff2019-06-06 15:58:17 +0200473 transport := BSSAP_TRANSPORT_AoIP,
Pau Espin Pedrolc6a53db2019-05-20 19:31:47 +0200474 use_osmux := false,
Harald Welte930d0a72018-03-22 22:08:40 +0100475 sccp_addr_local := omit,
476 sccp_addr_peer := omit
Harald Welte28d943e2017-11-25 15:00:50 +0100477}
478
Daniel Willmann191e0d92018-01-17 12:44:35 +0100479const MGCPOps MSC_MGCPOps := {
Harald Welte930d0a72018-03-22 22:08:40 +0100480 create_cb := refers(MGCP_Emulation.ExpectedCreateCallback),
481 unitdata_cb := refers(MGCP_Emulation.DummyUnitdataCallback)
Daniel Willmann191e0d92018-01-17 12:44:35 +0100482}
483
Harald Weltec1a2fff2017-12-17 11:06:19 +0100484/* register an expect with the BSSMAP core */
Neels Hofmeyr4f118412020-06-04 15:25:10 +0200485function f_create_bssmap_exp(octetstring l3_enc) runs on MSC_ConnHdlr {
Harald Welte6811d102019-04-14 22:23:14 +0200486 RAN.call(RAN_register:{l3_enc, self}) {
487 [] RAN.getreply(RAN_register:{?, ?}) {};
Harald Welte28d943e2017-11-25 15:00:50 +0100488 }
489}
490
Harald Welte651fcdc2018-05-10 20:23:16 +0200491type record TestHdlrEncrParams {
492 OCT1 enc_alg,
493 octetstring enc_key
494};
495
496template (value) TestHdlrEncrParams t_EncrParams(OCT1 alg, octetstring key) := {
497 enc_alg := alg,
498 enc_key := key
499}
500
Harald Weltecc0b0142018-05-29 15:19:33 +0200501type record TestHdlrParamsLcls {
502 GlobalCallReferenceValue gcr optional,
503 /* LCLS Configuration */
504 BIT4 cfg optional,
505 /* LCLS Connection Status Control */
506 BIT4 csc optional,
Max2eeb5112018-11-06 19:21:41 +0100507 BIT4 exp_sts optional,
508 /* Whether to adjust *cx_seen_exp for LCLS tests */
509 boolean adjust_cx_exp
Harald Weltecc0b0142018-05-29 15:19:33 +0200510}
511
Neels Hofmeyrf246a922020-05-13 02:27:10 +0200512type record TestHdlrParamsMSCPool {
Neels Hofmeyr4f118412020-06-04 15:25:10 +0200513 integer bssap_idx,
Neels Hofmeyr4f118412020-06-04 15:25:10 +0200514 integer rsl_idx,
515 PDU_ML3_MS_NW l3_info optional
Neels Hofmeyrf246a922020-05-13 02:27:10 +0200516}
517
Harald Weltec1a2fff2017-12-17 11:06:19 +0100518type record TestHdlrParams {
519 OCT1 ra,
520 GsmFrameNumber fn,
521 hexstring imsi,
Harald Welte60aa5762018-03-21 19:33:13 +0100522 RslLinkId link_id,
Harald Weltecbe911c2018-06-01 18:23:07 +0200523 integer media_nr, /* determins MGCP EP, port numbers */
Harald Welte651fcdc2018-05-10 20:23:16 +0200524 BSSMAP_IE_SpeechCodecList ass_codec_list optional,
Neels Hofmeyrbcf62bc2018-07-04 00:24:33 +0200525 RSL_IE_Body expect_mr_conf_ie optional, /* typically present for AMR codecs */
Philipp Maierd0e64b02019-03-13 14:15:23 +0100526 bitstring expect_mr_s0_s7 optional, /* typically present for AMR codecs */
Harald Weltecc0b0142018-05-29 15:19:33 +0200527 TestHdlrEncrParams encr optional,
Neels Hofmeyrbd0ef932018-03-19 14:58:46 +0100528 TestHdlrParamsLcls lcls,
Neels Hofmeyr90f80962020-06-12 16:16:55 +0200529 SCCP_PAR_Address sccp_addr_msc optional,
530 SCCP_PAR_Address sccp_addr_bsc optional,
Pau Espin Pedrolf7630a62019-10-28 15:07:08 +0100531 uint5_t exp_ms_power_level,
Pau Espin Pedrol8f773632019-11-05 11:46:53 +0100532 boolean exp_ms_power_params,
Pau Espin Pedrolc6a53db2019-05-20 19:31:47 +0200533 boolean aoip,
Neels Hofmeyrf246a922020-05-13 02:27:10 +0200534 boolean use_osmux,
535 TestHdlrParamsMSCPool mscpool
Harald Weltec1a2fff2017-12-17 11:06:19 +0100536};
537
Philipp Maier48604732018-10-09 15:00:37 +0200538/* Note: Do not use valueof() to get a value of this template, use
539 * f_gen_test_hdlr_pars() instead in order to get a configuration that is
Pau Espin Pedrol8df10112020-01-09 18:21:53 +0100540 * matched to the current test situation (aoip vs. sccplite) */
Harald Weltec1a2fff2017-12-17 11:06:19 +0100541template (value) TestHdlrParams t_def_TestHdlrPars := {
542 ra := '23'O,
543 fn := 23,
544 imsi := '001019876543210'H,
Harald Welte60aa5762018-03-21 19:33:13 +0100545 link_id := valueof(ts_RslLinkID_DCCH(0)),
Harald Weltecbe911c2018-06-01 18:23:07 +0200546 media_nr := 1,
Harald Welte651fcdc2018-05-10 20:23:16 +0200547 ass_codec_list := omit,
Neels Hofmeyrbcf62bc2018-07-04 00:24:33 +0200548 expect_mr_conf_ie := omit,
Philipp Maierd0e64b02019-03-13 14:15:23 +0100549 expect_mr_s0_s7 := omit,
Harald Weltecc0b0142018-05-29 15:19:33 +0200550 encr := omit,
551 lcls := {
552 gcr := omit,
553 cfg := omit,
554 csc := omit,
Max2eeb5112018-11-06 19:21:41 +0100555 exp_sts := omit,
556 adjust_cx_exp := true
Neels Hofmeyrbd0ef932018-03-19 14:58:46 +0100557 },
Neels Hofmeyr90f80962020-06-12 16:16:55 +0200558 sccp_addr_msc := omit,
559 sccp_addr_bsc := omit,
Pau Espin Pedrolf7630a62019-10-28 15:07:08 +0100560 exp_ms_power_level := 7, /* calculated from osmo-bsc.cfg "ms max power" */
Pau Espin Pedrol8f773632019-11-05 11:46:53 +0100561 exp_ms_power_params := false,
Pau Espin Pedrolc6a53db2019-05-20 19:31:47 +0200562 aoip := true,
Neels Hofmeyrf246a922020-05-13 02:27:10 +0200563 use_osmux := false,
564 mscpool := {
Neels Hofmeyr4f118412020-06-04 15:25:10 +0200565 bssap_idx := 0,
Neels Hofmeyr4f118412020-06-04 15:25:10 +0200566 rsl_idx := 0,
567 l3_info := omit
Neels Hofmeyrf246a922020-05-13 02:27:10 +0200568 }
Harald Weltec1a2fff2017-12-17 11:06:19 +0100569}
570
Harald Weltea0630032018-03-20 21:09:55 +0100571function f_create_chan_and_exp() runs on MSC_ConnHdlr {
572 var MobileIdentityLV mi := valueof(ts_MI_IMSI_LV(g_pars.imsi));
Harald Welte6ed6bf92018-01-24 21:09:15 +0100573 var PDU_ML3_MS_NW l3_info := valueof(ts_CM_SERV_REQ(CM_TYPE_MO_CALL, mi));
Harald Weltec1a2fff2017-12-17 11:06:19 +0100574 var octetstring l3_enc := enc_PDU_ML3_MS_NW(l3_info);
575
576 /* call helper function for CHAN_RQD -> IMM ASS ->EST_IND */
Harald Weltea0630032018-03-20 21:09:55 +0100577 RSL_Emulation.f_chan_est(g_pars.ra, l3_enc, g_pars.link_id, g_pars.fn);
Daniel Willmann191e0d92018-01-17 12:44:35 +0100578 f_create_bssmap_exp(l3_enc);
Harald Weltec1a2fff2017-12-17 11:06:19 +0100579}
580
Harald Welte898113b2018-01-31 18:32:21 +0100581function f_rsl_send_l3(template PDU_ML3_MS_NW l3, template (omit) RslLinkId link_id := omit,
582 template (omit) RslChannelNr chan_nr := omit) runs on MSC_ConnHdlr {
583 if (not isvalue(link_id)) {
584 link_id := ts_RslLinkID_DCCH(0);
585 }
586 if (not isvalue(chan_nr)) {
587 chan_nr := g_chan_nr;
588 }
589 RSL.send(ts_RSL_DATA_IND(valueof(chan_nr), valueof(link_id), enc_PDU_ML3_MS_NW(valueof(l3))));
590}
591
Harald Weltec1a2fff2017-12-17 11:06:19 +0100592function f_rsl_reply(template PDU_ML3_MS_NW l3, RSL_Message orig) runs on MSC_ConnHdlr {
593 var RslChannelNr chan_nr := orig.ies[0].body.chan_nr;
Harald Welte1a40de62017-12-23 02:28:34 +0100594 var RslLinkId link_id;
Harald Welte8d5eead2017-12-17 18:56:45 +0100595 if (orig.msg_type == RSL_MT_ENCR_CMD) {
596 link_id := orig.ies[2].body.link_id;
597 } else {
598 link_id := orig.ies[1].body.link_id;
599 }
Harald Welte898113b2018-01-31 18:32:21 +0100600 f_rsl_send_l3(l3, link_id, chan_nr);
Harald Weltec1a2fff2017-12-17 11:06:19 +0100601}
602
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100603/* Convert the chipher representation on BSSMAP to the representation used on RSL */
Harald Weltee613f962018-04-18 22:38:16 +0200604function f_chipher_mode_bssmap_to_rsl(OCT1 alg_bssmap) return RSL_AlgId
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100605{
606 /* A5 0 */
607 if (alg_bssmap == '01'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200608 return RSL_ALG_ID_A5_0;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100609 }
610 /* A5 1 */
611 else if (alg_bssmap == '02'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200612 return RSL_ALG_ID_A5_1;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100613 }
614 /* A5 2 */
615 else if (alg_bssmap == '04'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200616 return RSL_ALG_ID_A5_2;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100617 }
618 /* A5 3 */
619 else if (alg_bssmap == '08'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200620 return RSL_ALG_ID_A5_3;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100621 }
622 /* A5 4 */
623 else if (alg_bssmap == '10'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200624 return RSL_ALG_ID_A5_4;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100625 }
626 /* A5 5 */
627 else if (alg_bssmap == '20'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200628 return RSL_ALG_ID_A5_5;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100629 }
630 /* A5 6 */
631 else if (alg_bssmap == '40'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200632 return RSL_ALG_ID_A5_6;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100633 }
634 /* A5 7 */
635 else if (alg_bssmap == '80'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200636 return RSL_ALG_ID_A5_7;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100637 } else {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100638 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Unexpected Encryption Algorithm");
Harald Weltee613f962018-04-18 22:38:16 +0200639 return RSL_ALG_ID_A5_0;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100640 }
641}
642
Harald Welte38b2a102017-12-23 02:42:58 +0100643function f_cipher_mode(OCT1 alg, OCT8 key, template OCT16 kc128 := omit, boolean exp_fail := false)
644runs on MSC_ConnHdlr {
Harald Welte73cd2712017-12-17 00:44:52 +0100645 var PDU_BSSAP bssap;
646 var RSL_Message rsl;
Harald Weltee613f962018-04-18 22:38:16 +0200647 var RSL_AlgId alg_rsl;
Harald Welte73cd2712017-12-17 00:44:52 +0100648
649 if (isvalue(kc128)) {
650 BSSAP.send(ts_BSSMAP_CipherModeCmdKc128(alg, key, valueof(kc128)));
651 } else {
652 BSSAP.send(ts_BSSMAP_CipherModeCmd(alg, key));
653 }
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100654
655 /* RSL uses a different representation of the encryption algorithm,
656 * so we need to convert first */
657 alg_rsl := f_chipher_mode_bssmap_to_rsl(alg);
658
Harald Welte73cd2712017-12-17 00:44:52 +0100659 alt {
660 /* RSL/UE Side */
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100661 [] RSL.receive(tr_RSL_ENCR_CMD(g_chan_nr, ?, alg_rsl, key)) -> value rsl {
Harald Welte73cd2712017-12-17 00:44:52 +0100662 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[3].body.l3_info.payload);
663 log("Rx L3 from net: ", l3);
664 if (ischosen(l3.msgs.rrm.cipheringModeCommand)) {
665 f_rsl_reply(ts_RRM_CiphModeCompl, rsl);
666 }
667 repeat;
668 }
669 [] BSSAP.receive(tr_BSSMAP_CipherModeCompl) -> value bssap {
670 // bssap.bssmap.cipherModeComplete.chosenEncryptionAlgorithm.algoritmhIdentifier
Harald Welte38b2a102017-12-23 02:42:58 +0100671 if (exp_fail == true) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100672 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Unexpected Cipher Mode Complete");
Harald Welte38b2a102017-12-23 02:42:58 +0100673 } else {
674 setverdict(pass);
675 }
Harald Welte73cd2712017-12-17 00:44:52 +0100676 }
677 [] BSSAP.receive(tr_BSSMAP_CipherModeRej) -> value bssap {
Harald Welte38b2a102017-12-23 02:42:58 +0100678 if (exp_fail == false) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100679 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Ciphering Mode Reject");
Harald Welte38b2a102017-12-23 02:42:58 +0100680 } else {
681 setverdict(pass);
682 }
Harald Welte73cd2712017-12-17 00:44:52 +0100683 }
684 }
685}
686
Harald Welte211219e2018-01-29 22:03:36 +0100687/* Convert from Ericsson ChanDesc2 format to Osmocom RslChannelNr format */
688function f_ChDesc2RslChanNr(ChannelDescription2_V ch_desc, out RslChannelNr chan_nr, out GsmArfcn arfcn) {
689 var BIT5 inp := ch_desc.channelTypeandTDMAOffset;
Harald Welte6fa1f732018-03-21 22:46:16 +0100690 var uint3_t tn := bit2int(ch_desc.timeslotNumber);
Harald Welte211219e2018-01-29 22:03:36 +0100691
692 if (match(inp, '00001'B)) { /* TCH/F */
Harald Welte6fa1f732018-03-21 22:46:16 +0100693 chan_nr := valueof(t_RslChanNr_Bm(tn));
Harald Welte211219e2018-01-29 22:03:36 +0100694 }
695 else if (match(inp, '0001?'B)) { /* TCH/H */
Harald Welte6fa1f732018-03-21 22:46:16 +0100696 chan_nr := valueof(t_RslChanNr_Lm(tn, bit2int(substr(inp, 4, 1))));
Harald Welte211219e2018-01-29 22:03:36 +0100697 }
698 else if (match(inp, '001??'B)) { /* SDCCH/4 */
Harald Welte6fa1f732018-03-21 22:46:16 +0100699 chan_nr := valueof(t_RslChanNr_SDCCH4(tn, bit2int(substr(inp, 3, 2))));
Harald Welte211219e2018-01-29 22:03:36 +0100700 }
701 else if (match(inp, '01???'B)) { /* SDCCH/8 */
Harald Welte6fa1f732018-03-21 22:46:16 +0100702 chan_nr := valueof(t_RslChanNr_SDCCH8(tn, bit2int(substr(inp, 2, 3))));
Harald Welte211219e2018-01-29 22:03:36 +0100703 }
704 else {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100705 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Unknown ChDesc!");
Harald Welte211219e2018-01-29 22:03:36 +0100706 }
707
708 if (ch_desc.octet3 and4b '10'O == '10'O) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100709 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "No support for Hopping");
Harald Welte211219e2018-01-29 22:03:36 +0100710 } else {
711 var OCT2 concat := ch_desc.octet3 & ch_desc.octet4;
712 arfcn := oct2int(concat);
713 }
714}
715
716type record AssignmentState {
717 /* global */
718 boolean voice_call,
719 boolean is_assignment,
720 /* Assignment related bits */
721 boolean rr_ass_cmpl_seen,
Neels Hofmeyra5302c82018-11-04 23:09:58 +0100722 boolean old_lchan_deact_sacch_seen,
723 boolean old_lchan_rll_rel_req_seen,
Harald Welte21583082018-01-29 22:28:26 +0100724 boolean assignment_done,
Harald Welte211219e2018-01-29 22:03:36 +0100725 RslChannelNr old_chan_nr,
726 /* Modify related bits */
727 boolean rr_modify_seen,
Harald Welte21583082018-01-29 22:28:26 +0100728 boolean modify_done
Harald Welte211219e2018-01-29 22:03:36 +0100729}
730
731template (value) AssignmentState ts_AssignmentStateInit := {
732 voice_call := false,
733 is_assignment := false,
734 rr_ass_cmpl_seen := false,
Neels Hofmeyra5302c82018-11-04 23:09:58 +0100735 old_lchan_deact_sacch_seen := false,
736 old_lchan_rll_rel_req_seen := false,
Harald Welte21583082018-01-29 22:28:26 +0100737 assignment_done := false,
Harald Welte211219e2018-01-29 22:03:36 +0100738 old_chan_nr := -,
739 rr_modify_seen := false,
Harald Welte21583082018-01-29 22:28:26 +0100740 modify_done := false
Harald Welte211219e2018-01-29 22:03:36 +0100741}
742
Harald Welte8a9bf6f2018-05-10 22:00:49 +0200743private template RSL_IE_Body tr_EncrInfo(template RSL_AlgId alg, template octetstring key) := {
744 encr_info := {
745 len := ?,
746 alg_id := alg,
747 key := key
748 }
749}
750
751/* ensure the RSL CHAN ACT (during assignment) contains values we expect depending on test case */
752private function f_check_chan_act(AssignmentState st, RSL_Message chan_act) runs on MSC_ConnHdlr {
753 var RSL_IE_Body encr_info;
Pau Espin Pedrol3d008ae2019-10-28 13:35:46 +0100754 var RSL_IE_Body ms_power_param;
Pau Espin Pedrolf7630a62019-10-28 15:07:08 +0100755 var RSL_IE_Body ms_power;
Pau Espin Pedrol3d008ae2019-10-28 13:35:46 +0100756
Harald Welte8a9bf6f2018-05-10 22:00:49 +0200757 if (ispresent(g_pars.encr) and g_pars.encr.enc_alg != '01'O) {
758 if (not f_rsl_find_ie(chan_act, RSL_IE_ENCR_INFO, encr_info)) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100759 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Missing Encryption IE in CHAN ACT");
Harald Welte8a9bf6f2018-05-10 22:00:49 +0200760 } else {
761 var RSL_AlgId alg := f_chipher_mode_bssmap_to_rsl(g_pars.encr.enc_alg);
762 if (not match(encr_info, tr_EncrInfo(alg, g_pars.encr.enc_key))) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100763 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Wrong Encryption IE in CHAN ACT");
Harald Welte8a9bf6f2018-05-10 22:00:49 +0200764 }
765 }
766 } else {
767 if (f_rsl_find_ie(chan_act, RSL_IE_ENCR_INFO, encr_info)) {
768 if (encr_info.encr_info.alg_id != RSL_ALG_ID_A5_0) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100769 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Unexpected Encryption in CHAN ACT");
Harald Welte8a9bf6f2018-05-10 22:00:49 +0200770 }
771 }
772 }
773 /* FIXME: validate RSL_IE_ACT_TYPE, RSL_IE_CHAN_MODE, RSL_IE_CHAN_IDENT, RSL_IE_BS_POWER,
Pau Espin Pedrol7a9ccf82019-11-05 11:33:33 +0100774 * RSL_IE_TIMING_ADVANCE */
Pau Espin Pedrol3d008ae2019-10-28 13:35:46 +0100775
Pau Espin Pedrol8f773632019-11-05 11:46:53 +0100776 if (g_pars.exp_ms_power_params and not f_rsl_find_ie(chan_act, RSL_IE_MS_POWER_PARAM, ms_power_param)) {
Pau Espin Pedrol3d008ae2019-10-28 13:35:46 +0100777 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "IE MS Power Parameters not found in CHAN ACT");
778 }
779
Pau Espin Pedrolf7630a62019-10-28 15:07:08 +0100780 if (not f_rsl_find_ie(chan_act, RSL_IE_MS_POWER, ms_power)) {
781 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "IE MS Power not found in CHAN ACT");
782 } else {
783 if (not match(ms_power.ms_power, tr_RSL_IE_MS_Power(g_pars.exp_ms_power_level, false))) {
Pau Espin Pedrol7a9ccf82019-11-05 11:33:33 +0100784 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, log2str("Wrong MS Power IE in CHAN ACT, ", ms_power.ms_power.power_level, " vs exp ", g_pars.exp_ms_power_level));
Pau Espin Pedrolf7630a62019-10-28 15:07:08 +0100785 }
786 }
787
Harald Welte8a9bf6f2018-05-10 22:00:49 +0200788}
789
Harald Welte211219e2018-01-29 22:03:36 +0100790altstep as_assignment(inout AssignmentState st) runs on MSC_ConnHdlr {
Harald Weltec1a2fff2017-12-17 11:06:19 +0100791 var RSL_Message rsl;
Harald Welte211219e2018-01-29 22:03:36 +0100792 [not st.rr_ass_cmpl_seen] RSL.receive(tr_RSL_DATA_REQ(g_chan_nr)) -> value rsl {
793 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[2].body.l3_info.payload);
794 log("Rx L3 from net: ", l3);
795 if (ischosen(l3.msgs.rrm.assignmentCommand)) {
796 var RslChannelNr new_chan_nr;
797 var GsmArfcn arfcn;
798 f_ChDesc2RslChanNr(l3.msgs.rrm.assignmentCommand.descrOf1stChAfterTime,
799 new_chan_nr, arfcn);
800 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
Harald Weltec1a2fff2017-12-17 11:06:19 +0100801
Harald Welte211219e2018-01-29 22:03:36 +0100802 /* register our component for this channel number at the RSL Emulation */
803 f_rslem_register(0, new_chan_nr);
Vadim Yanitskiy539e6302020-06-22 03:11:54 +0700804 /* dispatch queued messages for this channel (if any) */
805 f_rslem_dchan_queue_dispatch();
806
Harald Welte211219e2018-01-29 22:03:36 +0100807 var PDU_ML3_MS_NW l3_tx := valueof(ts_RRM_AssignmentComplete('00'O));
808 /* send assignment complete over the new channel */
Neels Hofmeyrb0e73652018-07-14 21:56:51 +0200809 RSL.send(ts_RSL_EST_IND(new_chan_nr, valueof(ts_RslLinkID_DCCH(0)),
Harald Welte211219e2018-01-29 22:03:36 +0100810 enc_PDU_ML3_MS_NW(l3_tx)));
811 /* by default, send via the new channel from now */
812 st.old_chan_nr := g_chan_nr;
813 g_chan_nr := new_chan_nr;
814 st.rr_ass_cmpl_seen := true;
Harald Welte8a9bf6f2018-05-10 22:00:49 +0200815 /* obtain channel activation from RSL_Emulation for new channel */
816 var RSL_Message chan_act := f_rslem_get_last_act(RSL_PROC, 0, g_chan_nr);
817 /* check it (e.g. for correct ciphering parameters) */
818 f_check_chan_act(st, chan_act);
Harald Welte211219e2018-01-29 22:03:36 +0100819 repeat;
820 } else {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100821 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, log2str("Unexpected L3 received", l3));
Harald Weltec1a2fff2017-12-17 11:06:19 +0100822 }
Harald Welte211219e2018-01-29 22:03:36 +0100823 }
Neels Hofmeyr861a4c12018-11-07 01:23:17 +0100824 [st.rr_ass_cmpl_seen] RSL.receive(tr_RSL_DEACT_SACCH(st.old_chan_nr)) {
Neels Hofmeyra5302c82018-11-04 23:09:58 +0100825 st.old_lchan_deact_sacch_seen := true;
Neels Hofmeyr861a4c12018-11-07 01:23:17 +0100826 repeat;
827 }
Harald Welte211219e2018-01-29 22:03:36 +0100828 [st.rr_ass_cmpl_seen] RSL.receive(tr_RSL_REL_REQ(st.old_chan_nr, tr_RslLinkID_DCCH(0))) {
Neels Hofmeyra5302c82018-11-04 23:09:58 +0100829 st.old_lchan_rll_rel_req_seen := true;
Harald Welte211219e2018-01-29 22:03:36 +0100830 RSL.send(ts_RSL_REL_CONF(st.old_chan_nr, valueof(ts_RslLinkID_DCCH(0))));
831 repeat;
832 }
833 [st.rr_ass_cmpl_seen] RSL.receive(tr_RSL_RF_CHAN_REL(st.old_chan_nr)) {
834 RSL.send(ts_RSL_RF_CHAN_REL_ACK(st.old_chan_nr));
Harald Welte1909f462018-01-29 22:29:29 +0100835 /* unregister for old channel number in RSL emulation */
836 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
837 f_rslem_unregister(0, st.old_chan_nr);
Harald Welte21583082018-01-29 22:28:26 +0100838 st.assignment_done := true;
Harald Welte211219e2018-01-29 22:03:36 +0100839 repeat;
840 }
841}
842
843altstep as_modify(inout AssignmentState st) runs on MSC_ConnHdlr {
844 /* no assignment, just mode modify */
845 var RSL_Message rsl;
846
847 [st.voice_call and not st.rr_modify_seen] RSL.receive(tr_RSL_DATA_REQ(g_chan_nr)) -> value rsl {
Harald Weltec1a2fff2017-12-17 11:06:19 +0100848 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[2].body.l3_info.payload);
849 log("Rx L3 from net: ", l3);
850 if (ischosen(l3.msgs.rrm.channelModeModify)) {
851 f_rsl_reply(ts_RRM_ModeModifyAck(l3.msgs.rrm.channelModeModify.channelDescription,
852 l3.msgs.rrm.channelModeModify.channelMode), rsl);
Harald Welte211219e2018-01-29 22:03:36 +0100853 st.rr_modify_seen := true;
Harald Weltec1a2fff2017-12-17 11:06:19 +0100854 }
855 repeat;
856 }
Harald Welte211219e2018-01-29 22:03:36 +0100857 [st.voice_call and st.rr_modify_seen] RSL.receive(tr_RSL_MsgTypeD(RSL_MT_MODE_MODIFY_REQ)) -> value rsl {
Harald Weltec1a2fff2017-12-17 11:06:19 +0100858 RSL.send(ts_RSL_MODE_MODIFY_ACK(g_chan_nr));
Harald Welte21583082018-01-29 22:28:26 +0100859 st.modify_done := true;
Harald Weltec1a2fff2017-12-17 11:06:19 +0100860 repeat;
861 }
Harald Welte211219e2018-01-29 22:03:36 +0100862}
Daniel Willmann191e0d92018-01-17 12:44:35 +0100863
Harald Welte211219e2018-01-29 22:03:36 +0100864/* Determine if given rsl_chan_nr is compatible with given BSSMAP ChannelType */
865function f_channel_compatible(BSSMAP_IE_ChannelType bssmap, RslChannelNr rsl_chan_nr)
866return boolean {
867 select (bssmap.speechOrDataIndicator) {
868 case ('0011'B) { /* Signalling */
869 /* all channels support signalling */
870 return true;
871 }
872 case else { /* Speech, Speech+CTM or CSD */
873 select (bssmap.channelRateAndType) {
874 case ('08'O) { /* TCH/F */
875 select (rsl_chan_nr) {
876 case (t_RslChanNr_Bm(?)) { return true; }
877 }
878 }
879 case ('09'O) { /* TCH/H */
880 select (rsl_chan_nr) {
881 case (t_RslChanNr_Lm(?, ?)) { return true; }
882 }
883 }
884 case else { /* full or half-rate */
885 select (rsl_chan_nr) {
886 case (t_RslChanNr_Bm(?)) { return true; }
887 case (t_RslChanNr_Lm(?, ?)) { return true; }
888 }
889 }
890 }
Harald Weltec1a2fff2017-12-17 11:06:19 +0100891 }
Harald Welte211219e2018-01-29 22:03:36 +0100892 }
893 return false;
894}
Daniel Willmann191e0d92018-01-17 12:44:35 +0100895
Philipp Maier8ef527e2018-05-18 11:12:50 +0200896/* Determine if the channel mode specified within rsl_chan_nr requires a
897 * MODE MODIFY in to match the channel mode specified by given BSSMAP
898 * ChannelType */
899function f_channel_needs_modify(BSSMAP_IE_ChannelType bssmap, RslChannelNr rsl_chan_nr)
900return boolean {
901
902 /* FIXME: This tests the rsl_chan_nr to determine if we are on a
903 * signalling channel or not. Unfortunately this may lead to false
904 * results if we are on a TCH. The problem is that a TCH may be also
905 * used in signalling mode, but this function assumes that only SDCCH4
906 * and SDCCH8 are used as signalling channels at all. */
907
908 var boolean current_signalling := false;
909 var boolean desired_signalling := false;
910
911 select (rsl_chan_nr) {
912 case (t_RslChanNr_SDCCH4(?, ?)) { current_signalling := true; }
913 case (t_RslChanNr_SDCCH8(?, ?)) { current_signalling := true; }
914 }
915
916 if (bssmap.speechOrDataIndicator == '0011'B) {
917 desired_signalling := true;
918 }
919
920 if (current_signalling == desired_signalling) {
921 /* The desired channel mode is equal to the one we currently
922 * have, there is no mode modification needed or expected */
923 return false;
924 } else {
925 /* The desired channel mode and the current channel mode do
926 * not match. A mode modification is required */
927 return true;
928 }
929}
930
Harald Weltecc0b0142018-05-29 15:19:33 +0200931/* patch an BSSMAP ASS REQ with LCLS related IEs, depending on g_params */
932function f_ass_patch_lcls(inout template (omit) PDU_BSSAP ass_tpl,
933 inout template PDU_BSSAP ass_cpl) runs on MSC_ConnHdlr {
934 if (istemplatekind(ass_tpl, "omit")) {
935 return;
936 }
937 if (ispresent(g_pars.lcls.gcr)) {
938 ass_tpl.pdu.bssmap.assignmentRequest.globalCallReference := ts_BSSMAP_IE_GCR(g_pars.lcls.gcr);
939 }
940 if (ispresent(g_pars.lcls.cfg)) {
941 ass_tpl.pdu.bssmap.assignmentRequest.lCLS_Configuration := ts_BSSMAP_IE_LclsCfg(g_pars.lcls.cfg);
942 }
943 if (ispresent(g_pars.lcls.csc)) {
944 ass_tpl.pdu.bssmap.assignmentRequest.lCLS_ConnectionStatusControl := ts_BSSMAP_IE_LclsCsc(g_pars.lcls.csc);
945 }
Harald Welte343b7742018-06-05 23:41:37 +0200946 if (ischosen(ass_cpl.pdu.bssmap.assignmentComplete)) {
947 if (ispresent(g_pars.lcls.exp_sts)) {
948 ass_cpl.pdu.bssmap.assignmentComplete.lCLS_BSS_Status := tr_BSSMAP_IE_LclsSts(g_pars.lcls.exp_sts);
949 } else {
950 ass_cpl.pdu.bssmap.assignmentComplete.lCLS_BSS_Status := omit;
951 }
Harald Weltecc0b0142018-05-29 15:19:33 +0200952 }
953}
954
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200955/* Send a MGCP request through MGCP-over-IPA from MSC side and receive a (matching!) response */
956function mgcp_transceive_mgw(template MgcpCommand cmd, template MgcpResponse resp := ?) runs on MSC_ConnHdlr {
957 template MgcpResponse resp_any := ?
958 var MgcpResponse resp_val;
959 resp.line.trans_id := cmd.line.trans_id;
960 timer T := 5.0;
961
962 BSSAP.send(cmd);
963 T.start;
964 alt {
965 [] as_Media_mgw();
966 [] BSSAP.receive(resp) -> value resp_val { }
967 [] BSSAP.receive(resp_any) {
968 setverdict(fail, "Response didn't match template");
969 mtc.stop;
970 }
971 [] BSSAP.receive { repeat; }
972 [] T.timeout {
973 setverdict(fail, "Timeout waiting for response to ", cmd);
974 mtc.stop;
975 }
976 }
977 T.stop;
978}
979
Philipp Maier3e2af5d2018-07-11 17:01:05 +0200980/* Helper function to check if the activity on the MGCP matches what we
981 * expected */
982function f_check_mgcp_expectations() runs on MSC_ConnHdlr {
983 for (var integer i:= 0; i < sizeof(g_media.mgcp_conn); i := i+1) {
Philipp Maier0a5d7e72018-07-16 15:13:11 +0200984 log(testcasename(), ": Check MGCP test expectations for g_media.mgcp_conn[", i , "]:",
985 " crcx_seen=", g_media.mgcp_conn[i].crcx_seen, ", crcx_seen_exp=", g_media.mgcp_conn[i].crcx_seen_exp,
986 ", mdcx_seen=", g_media.mgcp_conn[i].mdcx_seen, ", mdcx_seen_exp=", g_media.mgcp_conn[i].mdcx_seen_exp);
987
Philipp Maier3e2af5d2018-07-11 17:01:05 +0200988 if(g_media.mgcp_conn[i].crcx_seen != g_media.mgcp_conn[i].crcx_seen_exp) {
Max4b0f4962018-11-06 19:20:24 +0100989 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "unexpected number of MGW-CRCX transactions on g_media.mgcp_conn[" & int2str(i) & "]");
Philipp Maier3e2af5d2018-07-11 17:01:05 +0200990 }
991 if(g_media.mgcp_conn[i].mdcx_seen != g_media.mgcp_conn[i].mdcx_seen_exp) {
Max4b0f4962018-11-06 19:20:24 +0100992 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "unexpected number of MGW-MDCX transactions on g_media.mgcp_conn[" & int2str(i) & "]");
Philipp Maier3e2af5d2018-07-11 17:01:05 +0200993 }
994 }
995}
996
Harald Welte211219e2018-01-29 22:03:36 +0100997/* establish a channel fully, expecting an assignment matching 'exp' */
Harald Welte7a14fd52018-05-10 22:26:55 +0200998function f_establish_fully(template (omit) PDU_BSSAP ass_tpl, template PDU_BSSAP exp_ass_cpl)
999runs on MSC_ConnHdlr {
Philipp Maier11a58942018-06-25 16:40:48 +02001000
1001 var BSSMAP_FIELD_CodecType codecType;
Philipp Maier48aeeec2018-09-14 18:20:04 +02001002 timer T := 10.0;
Philipp Maier3e2af5d2018-07-11 17:01:05 +02001003
Philipp Maier11a58942018-06-25 16:40:48 +02001004 if (isvalue(ass_tpl.pdu.bssmap.assignmentRequest.codecList)) {
1005 codecType := valueof(ass_tpl.pdu.bssmap.assignmentRequest.codecList.codecElements[0].codecType);
1006 } else {
1007 /* Make sure a meaningful default is assigned in case the
1008 * codecList is not populated */
1009 codecType := FR_AMR;
1010 }
1011
Pau Espin Pedrol392963f2019-06-18 17:17:19 +02001012 f_MscConnHdlr_init(g_pars.media_nr, host_bts, host_mgw, codecType);
Harald Welte7a14fd52018-05-10 22:26:55 +02001013
Harald Weltecc0b0142018-05-29 15:19:33 +02001014 /* patch in the LCLS related items, as needed */
1015 f_ass_patch_lcls(ass_tpl, exp_ass_cpl);
1016
Harald Welte7a14fd52018-05-10 22:26:55 +02001017 f_create_chan_and_exp();
1018 /* we should now have a COMPL_L3 at the MSC */
Philipp Maier48aeeec2018-09-14 18:20:04 +02001019
1020 var template PDU_BSSAP exp_l3_compl;
1021 exp_l3_compl := tr_BSSMAP_ComplL3()
Philipp Maier48604732018-10-09 15:00:37 +02001022 if (g_pars.aoip == false) {
Philipp Maier48aeeec2018-09-14 18:20:04 +02001023 exp_l3_compl.pdu.bssmap.completeLayer3Information.codecList := omit;
1024 } else {
1025 exp_l3_compl.pdu.bssmap.completeLayer3Information.codecList := ?;
1026 }
1027 T.start;
1028 alt {
1029 [] BSSAP.receive(exp_l3_compl);
1030 [] BSSAP.receive(tr_BSSMAP_ComplL3) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001031 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Received non-matching COMPLETE LAYER 3 INFORMATION");
Philipp Maier48aeeec2018-09-14 18:20:04 +02001032 }
1033 [] T.timeout {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001034 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Timeout waiting for COMPLETE LAYER 3 INFORMATION");
Philipp Maier48aeeec2018-09-14 18:20:04 +02001035 }
1036 }
Harald Welte7a14fd52018-05-10 22:26:55 +02001037
1038 /* start ciphering, if requested */
1039 if (ispresent(g_pars.encr)) {
1040 f_cipher_mode(g_pars.encr.enc_alg, g_pars.encr.enc_key);
1041 }
1042
1043 /* bail out early if no assignment requested */
1044 if (istemplatekind(ass_tpl, "omit")) {
1045 return;
1046 }
1047
1048 var PDU_BSSAP ass_cmd := valueof(ass_tpl);
Harald Welte211219e2018-01-29 22:03:36 +01001049 var PDU_BSSAP bssap;
Harald Welte211219e2018-01-29 22:03:36 +01001050 var boolean exp_compl := ischosen(exp_ass_cpl.pdu.bssmap.assignmentComplete);
Philipp Maier86f39202018-02-07 14:40:09 +01001051 var boolean exp_fail := ischosen(exp_ass_cpl.pdu.bssmap.assignmentFailure);
Philipp Maier8ef527e2018-05-18 11:12:50 +02001052 var boolean exp_modify;
Philipp Maier48aeeec2018-09-14 18:20:04 +02001053
Harald Welte211219e2018-01-29 22:03:36 +01001054 var ExpectCriteria mgcpcrit := {
1055 connid := omit,
1056 endpoint := omit,
1057 transid := omit
1058 };
1059 var AssignmentState st := valueof(ts_AssignmentStateInit);
1060 /* if the channel type is SIGNAL, we're not handling a voice call */
1061 if (ass_cmd.pdu.bssmap.assignmentRequest.channelType.speechOrDataIndicator != '0011'B) {
1062 st.voice_call := true;
Philipp Maier8ef527e2018-05-18 11:12:50 +02001063 exp_modify := true;
Harald Welte211219e2018-01-29 22:03:36 +01001064 }
Philipp Maier8ef527e2018-05-18 11:12:50 +02001065
Harald Welte211219e2018-01-29 22:03:36 +01001066 /* determine if the current channel can support the given service or not */
1067 if (not f_channel_compatible(ass_cmd.pdu.bssmap.assignmentRequest.channelType, g_chan_nr)) {
1068 st.is_assignment := true;
Philipp Maier8ef527e2018-05-18 11:12:50 +02001069
1070 /* We decided to assign a new channel, so we do not expect
1071 * any mode modify messages on RSL */
1072 exp_modify := false;
1073 } else {
1074 /* We will continue working with the currently assigned
1075 * channel, we must now check if the mode of the current
1076 * channel is compatible. If not we expect the BSC to modify
1077 * the mode */
1078 exp_modify := f_channel_needs_modify(ass_cmd.pdu.bssmap.assignmentRequest.channelType, g_chan_nr);
Harald Welte211219e2018-01-29 22:03:36 +01001079 }
1080
Philipp Maier3e2af5d2018-07-11 17:01:05 +02001081 /* Some test situations will involve MGCP transactions on a media
1082 * gateway. Depending on the situation, we set up how many of each MGCP
1083 * message type are expected to be exchanged. */
1084 if (isbound(exp_ass_cpl.pdu.bssmap.assignmentFailure)) {
1085 /* For tests that expect the assignment to fail, assume that
1086 * there will be no MGW communication as well. */
1087 g_media.mgcp_conn[0].crcx_seen_exp := 0;
1088 g_media.mgcp_conn[0].mdcx_seen_exp := 0;
1089 g_media.mgcp_conn[1].crcx_seen_exp := 0;
1090 g_media.mgcp_conn[1].mdcx_seen_exp := 0;
1091 } else if (st.voice_call) {
1092 /* For voice calls we expect the following MGCP activity */
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +02001093 g_media.mgcp_conn[0].crcx_seen_exp := 1;
1094 g_media.mgcp_conn[0].mdcx_seen_exp := 1;
1095 g_media.mgcp_conn[1].crcx_seen_exp := 1;
1096 g_media.mgcp_conn[1].mdcx_seen_exp := 0;
Philipp Maier3e2af5d2018-07-11 17:01:05 +02001097 }
1098
Vadim Yanitskiy539e6302020-06-22 03:11:54 +07001099 /* On receipt of the BSSAP Assignment Command, the IUT (osmo-bsc) will allocate
1100 * a channel and send us RR Assignment Command together with ip.access CRCX.
1101 * There is a risk that the RSL Emulation component would dequeue and process
1102 * ip.access CRCX faster than we process the Assignment Command and register
1103 * the corresponding handler for the indicated RSL channel number. This would
1104 * result in a failure, because at that moment there will be no handler for
1105 * ip.access CRCX. Let's guard against this and enable additional queueing. */
1106 f_rslem_dchan_queue_enable();
1107
Harald Welte211219e2018-01-29 22:03:36 +01001108 f_create_mgcp_expect(mgcpcrit);
1109 BSSAP.send(ass_cmd);
1110
1111 T.start;
1112 alt {
1113 /* assignment related bits */
1114 [st.is_assignment] as_assignment(st);
1115
1116 /* modify related bits */
Philipp Maier8ef527e2018-05-18 11:12:50 +02001117 [not st.is_assignment and exp_modify] as_modify(st);
Harald Welte211219e2018-01-29 22:03:36 +01001118
1119 /* voice call related bits (IPA CRCX/MDCX + MGCP) */
1120 [st.voice_call] as_Media();
1121
1122 /* if we receive exactly what we expected, always return + pass */
Philipp Maier8ef527e2018-05-18 11:12:50 +02001123 [st.is_assignment and st.assignment_done or (not st.is_assignment and (st.modify_done or not exp_modify))] BSSAP.receive(exp_ass_cpl) -> value bssap {
Harald Welte211219e2018-01-29 22:03:36 +01001124 setverdict(pass);
1125 }
Philipp Maier86f39202018-02-07 14:40:09 +01001126 [exp_fail] BSSAP.receive(exp_ass_cpl) -> value bssap {
1127 setverdict(pass);
1128 }
Harald Welte21583082018-01-29 22:28:26 +01001129 [(st.is_assignment and st.assignment_done or
Philipp Maier8ef527e2018-05-18 11:12:50 +02001130 (not st.is_assignment and (st.modify_done or not exp_modify))) and
Harald Welte21583082018-01-29 22:28:26 +01001131 exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentComplete) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001132 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Received non-matching ASSIGNMENT COMPLETE");
Harald Weltec1a2fff2017-12-17 11:06:19 +01001133 }
1134 [exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentFail) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001135 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Received unexpected ASSIGNMENT FAIL");
Harald Weltec1a2fff2017-12-17 11:06:19 +01001136 }
1137 [not exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentComplete) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001138 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Received unexpected ASSIGNMENT COMPLETE");
Harald Weltec1a2fff2017-12-17 11:06:19 +01001139 }
1140 [not exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentFail) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001141 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Received non-matching ASSIGNMENT FAIL");
Harald Weltec1a2fff2017-12-17 11:06:19 +01001142 }
1143 [] T.timeout {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001144 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Timeout waiting for ASSIGNMENT COMPLETE");
Harald Weltec1a2fff2017-12-17 11:06:19 +01001145 }
1146 }
Harald Welte211219e2018-01-29 22:03:36 +01001147 log("g_media ", g_media);
1148 if (not isbound(bssap)) {
Daniel Willmannafce8662018-07-06 23:11:32 +02001149 mtc.stop;
Harald Welte211219e2018-01-29 22:03:36 +01001150 }
Philipp Maier3e2af5d2018-07-11 17:01:05 +02001151
Philipp Maiera0976e92018-07-16 15:19:42 +02001152 /* When the BSC detects that LCLS is possible it will cross the
1153 * connetions that point to the PBX side of the MGW. In our case this
1154 * is mgcp_conn[1]. The BSC performs this operation already before the
1155 * assignment complete is generated. This means we expect another MDCX
1156 * at mgcp_conn[1] when LCLS is expected. */
Max2eeb5112018-11-06 19:21:41 +01001157 if (g_pars.lcls.adjust_cx_exp and ispresent(exp_ass_cpl.pdu.bssmap.assignmentComplete.lCLS_BSS_Status.lCLS_BSS_StatusValue)) {
Philipp Maiera0976e92018-07-16 15:19:42 +02001158 if (valueof(exp_ass_cpl.pdu.bssmap.assignmentComplete.lCLS_BSS_Status.lCLS_BSS_StatusValue) == LCLS_STS_locally_switched) {
1159 g_media.mgcp_conn[1].mdcx_seen_exp := g_media.mgcp_conn[1].mdcx_seen_exp + 1;
1160
1161 }
1162 }
1163
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +02001164 if (not exp_fail and st.voice_call and not g_pars.aoip) {
1165 /* With SCCPLite, connect to BSC-located MGW using a CRCX + SDP.
1166 It is sent in MGCP over IPA in the BSC<->MSC (BSC-NAT)
1167 connection. BSC will forward it to its MGW. */
1168 var template MgcpCommand cmd;
1169 var template MgcpResponse resp;
1170 var integer cic := f_bssmap_ie_cic_2_int(ass_cmd.pdu.bssmap.assignmentRequest.circuitIdentityCode);
1171 var MgcpEndpoint ep := int2str(cic) & "@mgw"; /* 1: matches value configured in BSC_Tests.ttcn pass in AssignReq */
1172 var MgcpCallId call_id := '51234'H;
1173 var SDP_attribute_list attributes := { valueof(ts_SDP_ptime(20)) };
1174 if (g_pars.use_osmux) {
1175 cmd := ts_CRCX_osmux(get_next_trans_id(), ep, "sendrecv", call_id, cic);
1176 resp := tr_CRCX_ACK_osmux;
1177 } else {
1178 cmd := ts_CRCX(get_next_trans_id(), ep, "sendrecv", call_id);
1179 resp := tr_CRCX_ACK;
1180 }
1181 cmd.sdp := ts_SDP(host_msc, host_mgw, "23", "42",
1182 14000, { int2str(g_media.mgcp_conn[1].rtp_pt) },
1183 { valueof(ts_SDP_ptime(20)) });
1184 mgcp_transceive_mgw(cmd, resp);
1185 }
1186
Philipp Maier3e2af5d2018-07-11 17:01:05 +02001187 f_check_mgcp_expectations();
Neels Hofmeyra5302c82018-11-04 23:09:58 +01001188
1189 if (st.is_assignment and st.assignment_done) {
1190 if (not st.old_lchan_deact_sacch_seen) {
1191 setverdict(fail, "f_establish_fully(): Assignment completed, but the old lchan was not",
1192 " released properly: expected a Deact SACCH on the old lchan, but saw none.");
1193 }
1194 if (st.old_lchan_rll_rel_req_seen) {
1195 setverdict(fail, "f_establish_fully(): Assignment completed, but the old lchan was not",
1196 " released properly: saw an RLL Release on the old lchan, but expecting none.");
1197 }
1198 }
Harald Welte930d0a72018-03-22 22:08:40 +01001199}
1200
Harald Welte261af4b2018-02-12 21:20:39 +01001201type record HandoverState {
1202 /* Assignment related bits */
1203 boolean rr_ho_cmpl_seen,
Philipp Maierc1e95c82018-07-18 16:03:00 +02001204 integer mdcx_seen_before_ho,
Harald Welte261af4b2018-02-12 21:20:39 +01001205 boolean handover_done,
1206 RslChannelNr old_chan_nr
1207};
1208
1209altstep as_handover(inout HandoverState st) runs on MSC_ConnHdlr {
1210 var RSL_Message rsl;
1211 [not st.rr_ho_cmpl_seen] RSL.receive(tr_RSL_DATA_REQ(g_chan_nr)) -> value rsl {
1212 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[2].body.l3_info.payload);
1213 log("Rx L3 from net: ", l3);
1214 if (ischosen(l3.msgs.rrm.handoverCommand)) {
1215 var RslChannelNr new_chan_nr;
1216 var GsmArfcn arfcn;
1217 f_ChDesc2RslChanNr(l3.msgs.rrm.handoverCommand.channelDescription2,
1218 new_chan_nr, arfcn);
1219 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
1220
1221 /* register our component for this channel number at the RSL Emulation */
1222 f_rslem_register(0, new_chan_nr, RSL1_PROC);
1223
1224 /* resume processing of RSL DChan messages, which was temporarily suspended
1225 * before performing a hand-over */
1226 f_rslem_resume(RSL1_PROC);
1227
Neels Hofmeyr378a49c2018-06-15 22:18:43 +02001228 /* send handover detect */
1229 RSL1.send(ts_RSL_HANDO_DET(new_chan_nr));
1230 f_sleep(0.3);
1231
Harald Welte261af4b2018-02-12 21:20:39 +01001232 /* send handover complete over the new channel */
1233 var PDU_ML3_MS_NW l3_tx := valueof(ts_RRM_HandoverComplete('00'O));
Neels Hofmeyrd07ee132018-07-14 22:28:29 +02001234 RSL1.send(ts_RSL_EST_IND(new_chan_nr, valueof(ts_RslLinkID_DCCH(0)),
Harald Welte261af4b2018-02-12 21:20:39 +01001235 enc_PDU_ML3_MS_NW(l3_tx)));
1236 /* by default, send via the new channel from now */
1237 st.old_chan_nr := g_chan_nr;
1238 g_chan_nr := new_chan_nr;
1239 st.rr_ho_cmpl_seen := true;
Philipp Maierc1e95c82018-07-18 16:03:00 +02001240
1241 /* Memorize how many MDCX we have seen before. We need this number to detect
1242 * that we have received the handover related MDCX */
1243 st.mdcx_seen_before_ho := g_media.mgcp_conn[0].mdcx_seen;
Harald Welte261af4b2018-02-12 21:20:39 +01001244 repeat;
1245 } else {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001246 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, log2str("Unexpected L3 received", l3));
Harald Welte261af4b2018-02-12 21:20:39 +01001247 }
1248 }
Philipp Maierc1e95c82018-07-18 16:03:00 +02001249 [st.rr_ho_cmpl_seen] as_Media_ipacc();
Pau Espin Pedrol76ba5412019-06-10 11:00:33 +02001250 [st.rr_ho_cmpl_seen] as_Media_mgw(true);
Neels Hofmeyr861a4c12018-11-07 01:23:17 +01001251 [st.rr_ho_cmpl_seen] RSL.receive(tr_RSL_DEACT_SACCH(st.old_chan_nr)) {
1252 repeat;
1253 }
Harald Welte261af4b2018-02-12 21:20:39 +01001254 [st.rr_ho_cmpl_seen] RSL.receive(tr_RSL_REL_REQ(st.old_chan_nr, tr_RslLinkID_DCCH(0))) {
1255 RSL.send(ts_RSL_REL_CONF(st.old_chan_nr, valueof(ts_RslLinkID_DCCH(0))));
1256 repeat;
1257 }
1258 [st.rr_ho_cmpl_seen] RSL.receive(tr_RSL_RF_CHAN_REL(st.old_chan_nr)) {
1259 RSL.send(ts_RSL_RF_CHAN_REL_ACK(st.old_chan_nr));
1260 /* unregister for old channel number in RSL emulation */
1261 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
1262 f_rslem_unregister(0, st.old_chan_nr);
Philipp Maierc1e95c82018-07-18 16:03:00 +02001263
1264 /* The channel release must not necessarly be synchronized to the RSL handover
1265 * procedure since those events may happen independently nearly at the same
1266 * time. When we receive the RSL_RF_CHAN_REL command the media negotiation on
1267 * IPACC or MGCP level may be still in progress. In order to make sure that
1268 * we do only stop when we have seen an MDCX on MGCP level and another a CRCX
1269 * as well as an MDCX on IPACC level. */
1270 if (g_media.mgcp_conn[0].mdcx_seen <= st.mdcx_seen_before_ho or
1271 g_media.bts1.ipa_mdcx_seen == false or g_media.bts1.ipa_crcx_seen == false) {
1272 repeat;
1273 } else {
1274 st.handover_done := true;
1275 }
Harald Welte261af4b2018-02-12 21:20:39 +01001276 }
1277}
1278
1279
Harald Weltec1a2fff2017-12-17 11:06:19 +01001280
Harald Welte28d943e2017-11-25 15:00:50 +01001281}