blob: 76a56fc62f5e3f36f825dab00612f1154a95457c [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
Daniel Willmannebdecc02020-08-12 15:30:17 +020033import from StatsD_Checker all;
34
Harald Weltec1a2fff2017-12-17 11:06:19 +010035import from RSL_Emulation all;
36import from RSL_Types all;
37
38import from MobileL3_Types all;
39import from MobileL3_CommonIE_Types all;
Harald Welte211219e2018-01-29 22:03:36 +010040import from MobileL3_RRM_Types all;
Harald Weltec1a2fff2017-12-17 11:06:19 +010041import from L3_Templates all;
42
Harald Weltec20b1c42018-02-12 20:50:08 +010043import from TELNETasp_PortType all;
44import from Osmocom_VTY_Functions all;
45
Harald Weltec1a2fff2017-12-17 11:06:19 +010046
Harald Welte211219e2018-01-29 22:03:36 +010047/***********************************************************************
48 * Media related handling
49 ***********************************************************************/
50
Philipp Maier11a58942018-06-25 16:40:48 +020051/* Get the matching payload type for a specified BSSAP codec type
52 * (see also: BSSAP_Types.ttcn */
53private function f_get_mgcp_pt(BSSMAP_FIELD_CodecType codecType) return SDP_FIELD_PayloadType {
54 if (codecType == GSM_FR) {
55 return PT_GSM;
56 } else if (codecType == GSM_HR) {
57 return PT_GSMHR;
58 } else if (codecType == GSM_EFR) {
59 return PT_GSMEFR;
60 } else if (codecType == FR_AMR or codecType == HR_AMR) {
61 return PT_AMR;
62 } else if (codecType == FR_AMR_WB or codecType == OHR_AMR or codecType == OFR_AMR_WB or codecType == OHR_AMR_WB) {
63 return PT_AMRWB;
64 }
65
66 return PT_PCMU;
67}
68
Harald Welte211219e2018-01-29 22:03:36 +010069/* Tuple containing host/ip and port */
70type record HostPort {
71 HostName host,
72 PortNumber port_nr
73};
74
75/* State encapsulating one MGCP Connection */
76type record MgcpConnState {
Philipp Maier3e2af5d2018-07-11 17:01:05 +020077 integer crcx_seen, /* Counts how many CRCX operations happend */
78 integer mdcx_seen, /* Counts how many MDCX operations happend C */
79 integer crcx_seen_exp, /* Sets the expected number of CRCX operations */
80 integer mdcx_seen_exp, /* Sets the expected number of MDCX operations */
Harald Welte211219e2018-01-29 22:03:36 +010081 MgcpConnectionId conn_id,
82 charstring mime_type, /* e.g. AMR */
83 integer sample_rate, /* 8000 */
84 integer ptime, /* 20 */
85 uint7_t rtp_pt, /* RTP Payload Type */
86 HostPort mgw, /* MGW side */
87 HostPort peer /* CA side */
88};
89
90/* BTS media state */
91type record BtsMediaState {
92 boolean ipa_crcx_seen,
Philipp Maierc1e95c82018-07-18 16:03:00 +020093 boolean ipa_mdcx_seen,
Harald Welte211219e2018-01-29 22:03:36 +010094 uint16_t conn_id,
95 uint7_t rtp_pt,
96 HostPort bts,
97 HostPort peer
98};
99
100type record MediaState {
101 MgcpEndpoint mgcp_ep,
102 MgcpConnState mgcp_conn[2],
Harald Welte261af4b2018-02-12 21:20:39 +0100103 BtsMediaState bts,
104 BtsMediaState bts1 /* only during hand-over */
Harald Welte211219e2018-01-29 22:03:36 +0100105};
106
Philipp Maier11a58942018-06-25 16:40:48 +0200107function f_MediaState_init(inout MediaState g_media, integer nr, HostName bts, HostName mgw, BSSMAP_FIELD_CodecType codecType) {
Harald Welte211219e2018-01-29 22:03:36 +0100108 /* BTS Side */
109 g_media.bts := {
110 ipa_crcx_seen := false,
Philipp Maierc1e95c82018-07-18 16:03:00 +0200111 ipa_mdcx_seen := false,
Harald Welte211219e2018-01-29 22:03:36 +0100112 conn_id := nr,
113 rtp_pt := 0,
114 bts := {
115 host := bts,
116 port_nr := 9000 + nr*2
117 },
118 peer := -
119 }
120
Harald Welte261af4b2018-02-12 21:20:39 +0100121 g_media.bts1 := {
122 ipa_crcx_seen := false,
Philipp Maierc1e95c82018-07-18 16:03:00 +0200123 ipa_mdcx_seen := false,
Harald Welte261af4b2018-02-12 21:20:39 +0100124 conn_id := nr,
125 rtp_pt := 0,
126 bts := {
127 host := bts, /* FIXME */
128 port_nr := 9000 + nr*2
129 },
130 peer := -
131 }
132
Harald Welte363cb0a2018-01-30 19:35:53 +0100133 g_media.mgcp_ep := "rtpbridge/" & int2str(nr) & "@mgw";
Harald Welte211219e2018-01-29 22:03:36 +0100134
135 for (var integer i:= 0; i < sizeof(g_media.mgcp_conn); i := i+1) {
Philipp Maier11a58942018-06-25 16:40:48 +0200136 g_media.mgcp_conn[i].mime_type := f_encoding_name_from_pt(f_get_mgcp_pt(codecType));
Harald Welte211219e2018-01-29 22:03:36 +0100137 g_media.mgcp_conn[i].sample_rate := 8000;
138 g_media.mgcp_conn[i].ptime := 20;
Philipp Maier11a58942018-06-25 16:40:48 +0200139 g_media.mgcp_conn[i].rtp_pt := enum2int(f_get_mgcp_pt(codecType));
Philipp Maier3e2af5d2018-07-11 17:01:05 +0200140 g_media.mgcp_conn[i].crcx_seen := 0;
141 g_media.mgcp_conn[i].mdcx_seen := 0;
142 g_media.mgcp_conn[i].crcx_seen_exp := 0;
143 g_media.mgcp_conn[i].mdcx_seen_exp := 0;
Harald Welte211219e2018-01-29 22:03:36 +0100144 g_media.mgcp_conn[i].conn_id := f_mgcp_alloc_conn_id();
145 }
146
147 g_media.mgcp_conn[0].mgw := {
148 host := mgw,
149 port_nr := 10000 + nr*2
150 }
151 g_media.mgcp_conn[1].mgw := {
152 host := mgw,
153 port_nr := 11000 + nr*2
154 }
155}
156
Philipp Maier3e2af5d2018-07-11 17:01:05 +0200157/* Helper function to get the next free MGCP connection identifier. We can
158 * recognize free connection identifiers by the fact that no CRCX happend yet */
Harald Welte211219e2018-01-29 22:03:36 +0100159private function f_get_free_mgcp_conn() runs on MSC_ConnHdlr return integer {
160 for (var integer i:= 0; i < sizeof(g_media.mgcp_conn); i := i+1) {
Philipp Maier3e2af5d2018-07-11 17:01:05 +0200161 if (not g_media.mgcp_conn[i].crcx_seen >= 1) {
Harald Welte211219e2018-01-29 22:03:36 +0100162 return i;
163 }
164 }
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100165 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Only 2 Connections per EP!");
166 /* Should never be reached */
167 return -1;
Harald Welte211219e2018-01-29 22:03:36 +0100168}
169
Philipp Maier3e2af5d2018-07-11 17:01:05 +0200170/* Helper function to pick a specific connection by its cid. Since we reach out
171 * for a connection that is in-use we also check if there was already exactly
172 * one CRCX happening on that connection. */
Harald Welte211219e2018-01-29 22:03:36 +0100173private function f_get_mgcp_conn(MgcpConnectionId cid) runs on MSC_ConnHdlr return integer {
174 for (var integer i:= 0; i < sizeof(g_media.mgcp_conn); i := i+1) {
Philipp Maier3e2af5d2018-07-11 17:01:05 +0200175 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 +0100176 return i;
177 }
178 }
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100179 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, log2str("No Connection for ID ", cid));
180 /* Should not be reached */
181 return -1;
Harald Welte211219e2018-01-29 22:03:36 +0100182}
183
Philipp Maierb2422352018-07-11 10:36:57 +0200184/* altstep for handling of IPACC media related commands. Activated by as_Media() to test
185 * RSL level media handling */
186altstep as_Media_ipacc() runs on MSC_ConnHdlr {
Harald Welte211219e2018-01-29 22:03:36 +0100187 var RSL_Message rsl;
Harald Welte211219e2018-01-29 22:03:36 +0100188 var RSL_IE_Body ie;
Harald Welte930d0a72018-03-22 22:08:40 +0100189 var boolean b_unused;
Harald Welte211219e2018-01-29 22:03:36 +0100190 [not g_media.bts.ipa_crcx_seen] RSL.receive(tr_RSL_IPA_CRCX(g_chan_nr)) -> value rsl {
191 /* Extract parameters from request + use in response */
192 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
193 g_media.bts.rtp_pt := ie.ipa_rtp_pt;
194 }
195 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
196 g_media.bts.rtp_pt := ie.ipa_rtp_pt2;
197 }
198 RSL.send(ts_RSL_IPA_CRCX_ACK(g_chan_nr, g_media.bts.conn_id,
199 oct2int(f_inet_addr(g_media.bts.bts.host)),
200 g_media.bts.bts.port_nr,
201 g_media.bts.rtp_pt));
202 g_media.bts.ipa_crcx_seen := true;
203 repeat;
204 }
205 [g_media.bts.ipa_crcx_seen] RSL.receive(tr_RSL_IPA_MDCX(g_chan_nr, ?)) -> value rsl{
206 /* Extract conn_id, ip, port, rtp_pt2 from request + use in response */
Harald Welte930d0a72018-03-22 22:08:40 +0100207 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_CONN_ID, ie);
Harald Welte211219e2018-01-29 22:03:36 +0100208 if (g_media.bts.conn_id != ie.ipa_conn_id) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100209 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, log2str("IPA MDCX for unknown ConnId", rsl));
Harald Welte211219e2018-01-29 22:03:36 +0100210 }
211 /* mandatory */
Harald Welte930d0a72018-03-22 22:08:40 +0100212 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_IP, ie);
Harald Welte211219e2018-01-29 22:03:36 +0100213 g_media.bts.peer.host := f_inet_ntoa(int2oct(ie.ipa_remote_ip, 4));
Harald Welte930d0a72018-03-22 22:08:40 +0100214 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_PORT, ie);
Harald Welte211219e2018-01-29 22:03:36 +0100215 g_media.bts.peer.port_nr := ie.ipa_remote_port;
216 /* optional */
217 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
218 g_media.bts.rtp_pt := ie.ipa_rtp_pt;
219 }
220 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
221 g_media.bts.rtp_pt := ie.ipa_rtp_pt2;
222 }
223 RSL.send(ts_RSL_IPA_MDCX_ACK(g_chan_nr, g_media.bts.conn_id,
224 oct2int(f_inet_addr(g_media.bts.peer.host)),
225 g_media.bts.peer.port_nr,
226 g_media.bts.rtp_pt));
Philipp Maierc1e95c82018-07-18 16:03:00 +0200227 g_media.bts.ipa_mdcx_seen := true;
Harald Welte211219e2018-01-29 22:03:36 +0100228 repeat;
229 }
Harald Welte261af4b2018-02-12 21:20:39 +0100230
231 /* on second (new) BTS during hand-over */
232 [not g_media.bts1.ipa_crcx_seen] RSL1.receive(tr_RSL_IPA_CRCX(g_chan_nr)) -> value rsl {
233 /* Extract parameters from request + use in response */
234 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
235 g_media.bts1.rtp_pt := ie.ipa_rtp_pt;
236 }
237 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
238 g_media.bts1.rtp_pt := ie.ipa_rtp_pt2;
239 }
240 RSL1.send(ts_RSL_IPA_CRCX_ACK(g_chan_nr, g_media.bts1.conn_id,
241 oct2int(f_inet_addr(g_media.bts1.bts.host)),
242 g_media.bts1.bts.port_nr,
243 g_media.bts1.rtp_pt));
244 g_media.bts1.ipa_crcx_seen := true;
245 repeat;
246 }
247 /* on second (new) BTS during hand-over */
248 [g_media.bts1.ipa_crcx_seen] RSL1.receive(tr_RSL_IPA_MDCX(g_chan_nr, ?)) -> value rsl{
249 /* Extract conn_id, ip, port, rtp_pt2 from request + use in response */
Harald Welte930d0a72018-03-22 22:08:40 +0100250 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_CONN_ID, ie);
Harald Welte261af4b2018-02-12 21:20:39 +0100251 if (g_media.bts1.conn_id != ie.ipa_conn_id) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100252 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, log2str("IPA MDCX for unknown ConnId", rsl));
Harald Welte261af4b2018-02-12 21:20:39 +0100253 }
254 /* mandatory */
Harald Welte930d0a72018-03-22 22:08:40 +0100255 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_IP, ie);
Harald Welte261af4b2018-02-12 21:20:39 +0100256 g_media.bts1.peer.host := f_inet_ntoa(int2oct(ie.ipa_remote_ip, 4));
Harald Welte930d0a72018-03-22 22:08:40 +0100257 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_PORT, ie);
Harald Welte261af4b2018-02-12 21:20:39 +0100258 g_media.bts1.peer.port_nr := ie.ipa_remote_port;
259 /* optional */
260 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
261 g_media.bts1.rtp_pt := ie.ipa_rtp_pt;
262 }
263 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
264 g_media.bts1.rtp_pt := ie.ipa_rtp_pt2;
265 }
266 RSL1.send(ts_RSL_IPA_MDCX_ACK(g_chan_nr, g_media.bts1.conn_id,
267 oct2int(f_inet_addr(g_media.bts1.peer.host)),
268 g_media.bts1.peer.port_nr,
269 g_media.bts1.rtp_pt));
Philipp Maierc1e95c82018-07-18 16:03:00 +0200270 g_media.bts1.ipa_mdcx_seen := true;
Harald Welte261af4b2018-02-12 21:20:39 +0100271 repeat;
272 }
273
Philipp Maierb2422352018-07-11 10:36:57 +0200274
275}
276
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200277function f_rx_crcx(MgcpCommand mgcp_cmd)
278 runs on MSC_ConnHdlr return template MgcpResponse {
279 var MgcpOsmuxCID osmux_cid;
280 var SDP_Message sdp;
281 var integer cid := f_get_free_mgcp_conn();
Pau Espin Pedrol07866632020-09-03 19:10:55 +0200282 var charstring local_rtp_addr := host_mgw_rtp_v6; /* Use IPv6 by default if no remote addr is provided by client */
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200283 if (match(mgcp_cmd.line.ep, t_MGCP_EP_wildcard)) {
284 if (cid != 0) {
285 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "MGCP wildcard EP only works in first CRCX");
286 }
287 /* we keep the endpoint name allocated during MediaState_init */
288 } else {
289 /* Call Agent allocated endpoint, trust/use it always */
290 g_media.mgcp_ep := mgcp_cmd.line.ep;
291 }
292 if (isvalue(mgcp_cmd.sdp)) {
293 sdp := mgcp_cmd.sdp;
294 g_media.mgcp_conn[cid].peer.host := sdp.connection.conn_addr.addr;
295 g_media.mgcp_conn[cid].peer.port_nr := sdp.media_list[0].media_field.ports.port_number;
Pau Espin Pedrol07866632020-09-03 19:10:55 +0200296 if (sdp.connection.addr_type == "IP6") {
297 local_rtp_addr := host_mgw_rtp_v6;
298 } else {
299 local_rtp_addr := host_mgw_rtp_v4;
300 }
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200301 }
302 var MgcpConnState mgcp_conn := g_media.mgcp_conn[cid];
Pau Espin Pedrol07866632020-09-03 19:10:55 +0200303 sdp := valueof(ts_SDP(mgcp_conn.mgw.host, local_rtp_addr, "foo", "21",
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200304 mgcp_conn.mgw.port_nr, { int2str(mgcp_conn.rtp_pt) },
305 {valueof(ts_SDP_rtpmap(mgcp_conn.rtp_pt,
306 mgcp_conn.mime_type & "/" &
307 int2str(mgcp_conn.sample_rate))),
308 valueof(ts_SDP_ptime(mgcp_conn.ptime)) } ));
309 var template MgcpResponse mgcp_resp;
310 if (g_pars.use_osmux and f_MgcpCmd_contains_par(mgcp_cmd, "X-OSMUX")) {
311 osmux_cid := f_MgcpCmd_extract_osmux_cid(mgcp_cmd);
312 mgcp_resp := ts_CRCX_ACK_osmux(mgcp_cmd.line.trans_id, mgcp_conn.conn_id, osmux_cid, sdp);
313 } else {
314 mgcp_resp := ts_CRCX_ACK(mgcp_cmd.line.trans_id, mgcp_conn.conn_id, sdp);
315 }
316 f_mgcp_par_append(mgcp_resp.params, ts_MgcpParSpecEP(g_media.mgcp_ep));
317 g_media.mgcp_conn[cid].crcx_seen := g_media.mgcp_conn[cid].crcx_seen + 1;
318 return mgcp_resp;
319}
320
321function f_rx_mdcx(MgcpCommand mgcp_cmd)
322 runs on MSC_ConnHdlr return template MgcpResponse {
323 var SDP_Message sdp;
324 var integer cid := f_get_mgcp_conn(f_MgcpCmd_extract_conn_id(mgcp_cmd));
Pau Espin Pedrol07866632020-09-03 19:10:55 +0200325 var charstring local_rtp_addr;
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200326 if (isvalue(mgcp_cmd.sdp)) {
327 sdp := mgcp_cmd.sdp;
328 g_media.mgcp_conn[cid].peer.host := sdp.connection.conn_addr.addr;
329 g_media.mgcp_conn[cid].peer.port_nr := sdp.media_list[0].media_field.ports.port_number;
Pau Espin Pedrol07866632020-09-03 19:10:55 +0200330 if (sdp.connection.addr_type == "IP6") {
331 local_rtp_addr := host_mgw_rtp_v6;
332 } else {
333 local_rtp_addr := host_mgw_rtp_v4;
334 }
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200335 } else {
336 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "MDCX has no [recognizable] SDP");
337 }
338 var MgcpConnState mgcp_conn := g_media.mgcp_conn[cid];
Pau Espin Pedrol07866632020-09-03 19:10:55 +0200339 sdp := valueof(ts_SDP(mgcp_conn.peer.host, local_rtp_addr, "foo", "21",
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200340 mgcp_conn.peer.port_nr, { int2str(mgcp_conn.rtp_pt) },
341 {valueof(ts_SDP_rtpmap(mgcp_conn.rtp_pt,
342 mgcp_conn.mime_type & "/" &
343 int2str(mgcp_conn.sample_rate))),
344 valueof(ts_SDP_ptime(mgcp_conn.ptime)) } ));
345 g_media.mgcp_conn[cid].mdcx_seen := g_media.mgcp_conn[cid].mdcx_seen + 1;
346 return ts_MDCX_ACK(mgcp_cmd.line.trans_id, mgcp_conn.conn_id, sdp);
347}
348
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200349function tr_MGCP_RecvFrom_any(template MgcpMessage msg)
350runs on MSC_ConnHdlr return template MGCP_RecvFrom {
351 var template MGCP_RecvFrom mrf := {
352 connId := ?,
353 remName := ?,
354 remPort := ?,
355 locName := ?,
356 locPort := ?,
357 msg := msg
358 }
359 return mrf;
360}
361
Philipp Maierb2422352018-07-11 10:36:57 +0200362/* altstep for handling of MGCP media related commands. Activated by as_Media() to test
363 * MGW level media handling */
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200364
Philipp Maierc1e95c82018-07-18 16:03:00 +0200365altstep as_Media_mgw(boolean norepeat := false) runs on MSC_ConnHdlr {
Philipp Maierb2422352018-07-11 10:36:57 +0200366 var MgcpCommand mgcp_cmd;
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200367 var template MgcpResponse mgcp_resp;
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200368 var MGCP_RecvFrom mrf;
369 var template MgcpMessage msg_crcx := {
370 command := tr_CRCX
371 }
372 var template MgcpMessage msg_mdcx := {
373 command := tr_MDCX
374 }
375 var template MgcpMessage msg_resp;
Philipp Maierb2422352018-07-11 10:36:57 +0200376
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200377 [g_pars.aoip] MGCP.receive(tr_CRCX) -> value mgcp_cmd {
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200378 mgcp_resp := f_rx_crcx(mgcp_cmd);
Harald Welte363cb0a2018-01-30 19:35:53 +0100379 MGCP.send(mgcp_resp);
Philipp Maierc1e95c82018-07-18 16:03:00 +0200380 if(norepeat == false) {
381 repeat;
382 }
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200383 }
384
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200385 [not g_pars.aoip] MGCP_MULTI.receive(tr_MGCP_RecvFrom_any(msg_crcx)) -> value mrf {
386 mgcp_resp := f_rx_crcx(mrf.msg.command);
387 msg_resp := {
388 response := mgcp_resp
389 }
390 MGCP_MULTI.send(t_MGCP_SendToMrf(mrf, msg_resp));
391 if(norepeat == false) {
392 repeat;
393 }
394 }
395
396 [g_pars.aoip] MGCP.receive(tr_MDCX) -> value mgcp_cmd {
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200397 mgcp_resp := f_rx_mdcx(mgcp_cmd);
398 MGCP.send(mgcp_resp);
Philipp Maierc1e95c82018-07-18 16:03:00 +0200399 if(norepeat == false) {
400 repeat;
401 }
Harald Welte211219e2018-01-29 22:03:36 +0100402 }
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200403
404 [not g_pars.aoip] MGCP_MULTI.receive(tr_MGCP_RecvFrom_any(msg_mdcx)) -> value mrf {
405 mgcp_resp := f_rx_mdcx(mrf.msg.command);
406 msg_resp := {
407 response := mgcp_resp
408 }
409 MGCP_MULTI.send(t_MGCP_SendToMrf(mrf, msg_resp));
410 if(norepeat == false) {
411 repeat;
412 }
413 }
Harald Welte211219e2018-01-29 22:03:36 +0100414}
415
Philipp Maierb2422352018-07-11 10:36:57 +0200416/* Altsteps for handling of media related commands. Can be activated by a given
417 * test case if it expects to see media related handling (i.e. voice calls) */
418altstep as_Media() runs on MSC_ConnHdlr {
419 [] as_Media_ipacc();
420 [] as_Media_mgw();
421}
Harald Welte211219e2018-01-29 22:03:36 +0100422
Harald Welte28d943e2017-11-25 15:00:50 +0100423/* this component represents a single subscriber connection at the MSC.
Harald Welte6811d102019-04-14 22:23:14 +0200424 * There is a 1:1 mapping between SCCP connections and RAN_ConnHdlr components.
425 * We inherit all component variables, ports, functions, ... from RAN_ConnHdlr */
Harald Welte8cb58252020-08-31 16:50:17 +0200426type component MSC_ConnHdlr extends RAN_ConnHdlr, RSL_DchanHdlr, MGCP_ConnHdlr, StatsD_ConnHdlr {
Harald Welte28d943e2017-11-25 15:00:50 +0100427 /* SCCP Connecction Identifier for the underlying SCCP connection */
428 var integer g_sccp_conn_id;
429
Harald Welte6811d102019-04-14 22:23:14 +0200430 /* procedure port back to our parent (RAN_Emulation_CT) for control */
431 port RAN_PROC_PT RAN;
Harald Weltec20b1c42018-02-12 20:50:08 +0100432 port TELNETasp_PT BSCVTY;
Harald Welte28d943e2017-11-25 15:00:50 +0100433
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200434 /* Proxy MGCP-over-IPA and MGCP-over-UDP */
435 port IPA_MGCP_PT MGCP_MSC_CLIENT;
436 var integer g_trans_id := 0;
437
Harald Welte211219e2018-01-29 22:03:36 +0100438 var MediaState g_media;
Harald Weltea0630032018-03-20 21:09:55 +0100439 var TestHdlrParams g_pars;
Harald Weltee97eab42018-03-21 18:46:06 +0100440
Pau Espin Pedrol392963f2019-06-18 17:17:19 +0200441 var charstring host_bts := "127.0.0.2";
Pau Espin Pedrol07866632020-09-03 19:10:55 +0200442 var charstring host_mgw_mgcp := "127.0.0.3";
443 var charstring host_mgw_rtp_v4 := "127.0.0.5";
444 var charstring host_mgw_rtp_v6 := "::1";
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200445 var charstring host_msc := "127.0.0.4";
446
Harald Weltee97eab42018-03-21 18:46:06 +0100447 var boolean g_vty_initialized := false;
Harald Welte211219e2018-01-29 22:03:36 +0100448}
449
Harald Welteeddf0e92020-06-21 19:42:15 +0200450function f_MscConnHdlr_init_vty() runs on MSC_ConnHdlr {
Harald Weltee97eab42018-03-21 18:46:06 +0100451 if (not g_vty_initialized) {
452 map(self:BSCVTY, system:BSCVTY);
453 f_vty_set_prompts(BSCVTY);
454 f_vty_transceive(BSCVTY, "enable");
455 g_vty_initialized := true;
456 }
Harald Welte28d943e2017-11-25 15:00:50 +0100457}
458
Harald Welteeddf0e92020-06-21 19:42:15 +0200459/* initialize all parameters */
460function f_MscConnHdlr_init(integer i, HostName bts, HostName mgw, BSSMAP_FIELD_CodecType codecType) runs on MSC_ConnHdlr {
461 f_MediaState_init(g_media, i, bts, mgw, codecType);
462 f_MscConnHdlr_init_vty();
463}
464
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200465private function get_next_trans_id() runs on MSC_ConnHdlr return MgcpTransId {
466 var MgcpTransId tid := int2str(g_trans_id);
467 g_trans_id := g_trans_id + 1;
468 return tid;
469}
470
Harald Welte6811d102019-04-14 22:23:14 +0200471/* Callback function from general RAN_Emulation whenever a connectionless
Harald Welte28d943e2017-11-25 15:00:50 +0100472 * BSSMAP message arrives. Can retunr a PDU_BSSAP that should be sent in return */
473private function UnitdataCallback(PDU_BSSAP bssap)
Harald Welte6811d102019-04-14 22:23:14 +0200474runs on RAN_Emulation_CT return template PDU_BSSAP {
Harald Welte28d943e2017-11-25 15:00:50 +0100475 var template PDU_BSSAP resp := omit;
Pau Espin Pedrol95549182019-06-06 16:17:30 +0200476 var boolean append_osmux_support := g_ran_ops.use_osmux and
477 (g_ran_ops.transport == BSSAP_TRANSPORT_AoIP);
Harald Welte28d943e2017-11-25 15:00:50 +0100478
Harald Weltec1a2fff2017-12-17 11:06:19 +0100479 /* answer all RESET with a RESET ACK */
Pau Espin Pedrol95549182019-06-06 16:17:30 +0200480 if (match(bssap, tr_BSSMAP_Reset(append_osmux_support))) {
481 resp := ts_BSSMAP_ResetAck(append_osmux_support);
Harald Welte28d943e2017-11-25 15:00:50 +0100482 }
483
484 return resp;
485}
486
Harald Welte6811d102019-04-14 22:23:14 +0200487const RanOps MSC_RanOps := {
488 create_cb := refers(RAN_Emulation.ExpectedCreateCallback),
Harald Welte0b476062018-01-21 19:07:32 +0100489 unitdata_cb := refers(UnitdataCallback),
490 decode_dtap := false,
Harald Welte930d0a72018-03-22 22:08:40 +0100491 role_ms := false,
Harald Welte2fce7882019-04-15 11:48:05 +0200492 protocol := RAN_PROTOCOL_BSSAP,
Pau Espin Pedrolc6b78ff2019-06-06 15:58:17 +0200493 transport := BSSAP_TRANSPORT_AoIP,
Pau Espin Pedrolc6a53db2019-05-20 19:31:47 +0200494 use_osmux := false,
Harald Welte930d0a72018-03-22 22:08:40 +0100495 sccp_addr_local := omit,
496 sccp_addr_peer := omit
Harald Welte28d943e2017-11-25 15:00:50 +0100497}
498
Daniel Willmann191e0d92018-01-17 12:44:35 +0100499const MGCPOps MSC_MGCPOps := {
Harald Welte930d0a72018-03-22 22:08:40 +0100500 create_cb := refers(MGCP_Emulation.ExpectedCreateCallback),
501 unitdata_cb := refers(MGCP_Emulation.DummyUnitdataCallback)
Daniel Willmann191e0d92018-01-17 12:44:35 +0100502}
503
Harald Weltec1a2fff2017-12-17 11:06:19 +0100504/* register an expect with the BSSMAP core */
Neels Hofmeyr4f118412020-06-04 15:25:10 +0200505function f_create_bssmap_exp(octetstring l3_enc) runs on MSC_ConnHdlr {
Harald Welte6811d102019-04-14 22:23:14 +0200506 RAN.call(RAN_register:{l3_enc, self}) {
507 [] RAN.getreply(RAN_register:{?, ?}) {};
Harald Welte28d943e2017-11-25 15:00:50 +0100508 }
509}
510
Harald Welte651fcdc2018-05-10 20:23:16 +0200511type record TestHdlrEncrParams {
512 OCT1 enc_alg,
513 octetstring enc_key
514};
515
516template (value) TestHdlrEncrParams t_EncrParams(OCT1 alg, octetstring key) := {
517 enc_alg := alg,
518 enc_key := key
519}
520
Harald Weltecc0b0142018-05-29 15:19:33 +0200521type record TestHdlrParamsLcls {
522 GlobalCallReferenceValue gcr optional,
523 /* LCLS Configuration */
524 BIT4 cfg optional,
525 /* LCLS Connection Status Control */
526 BIT4 csc optional,
Max2eeb5112018-11-06 19:21:41 +0100527 BIT4 exp_sts optional,
528 /* Whether to adjust *cx_seen_exp for LCLS tests */
529 boolean adjust_cx_exp
Harald Weltecc0b0142018-05-29 15:19:33 +0200530}
531
Neels Hofmeyrf246a922020-05-13 02:27:10 +0200532type record TestHdlrParamsMSCPool {
Neels Hofmeyr4f118412020-06-04 15:25:10 +0200533 integer bssap_idx,
Neels Hofmeyr4f118412020-06-04 15:25:10 +0200534 integer rsl_idx,
535 PDU_ML3_MS_NW l3_info optional
Neels Hofmeyrf246a922020-05-13 02:27:10 +0200536}
537
Harald Weltec1a2fff2017-12-17 11:06:19 +0100538type record TestHdlrParams {
539 OCT1 ra,
540 GsmFrameNumber fn,
541 hexstring imsi,
Harald Welte60aa5762018-03-21 19:33:13 +0100542 RslLinkId link_id,
Harald Weltecbe911c2018-06-01 18:23:07 +0200543 integer media_nr, /* determins MGCP EP, port numbers */
Harald Welte651fcdc2018-05-10 20:23:16 +0200544 BSSMAP_IE_SpeechCodecList ass_codec_list optional,
Neels Hofmeyrbcf62bc2018-07-04 00:24:33 +0200545 RSL_IE_Body expect_mr_conf_ie optional, /* typically present for AMR codecs */
Philipp Maierd0e64b02019-03-13 14:15:23 +0100546 bitstring expect_mr_s0_s7 optional, /* typically present for AMR codecs */
Harald Weltecc0b0142018-05-29 15:19:33 +0200547 TestHdlrEncrParams encr optional,
Neels Hofmeyrbd0ef932018-03-19 14:58:46 +0100548 TestHdlrParamsLcls lcls,
Neels Hofmeyr90f80962020-06-12 16:16:55 +0200549 SCCP_PAR_Address sccp_addr_msc optional,
550 SCCP_PAR_Address sccp_addr_bsc optional,
Pau Espin Pedrolf7630a62019-10-28 15:07:08 +0100551 uint5_t exp_ms_power_level,
Pau Espin Pedrol8f773632019-11-05 11:46:53 +0100552 boolean exp_ms_power_params,
Pau Espin Pedrolc6a53db2019-05-20 19:31:47 +0200553 boolean aoip,
Neels Hofmeyrf246a922020-05-13 02:27:10 +0200554 boolean use_osmux,
Pau Espin Pedrol07866632020-09-03 19:10:55 +0200555 charstring host_aoip_tla,
Neels Hofmeyrf246a922020-05-13 02:27:10 +0200556 TestHdlrParamsMSCPool mscpool
Harald Weltec1a2fff2017-12-17 11:06:19 +0100557};
558
Philipp Maier48604732018-10-09 15:00:37 +0200559/* Note: Do not use valueof() to get a value of this template, use
560 * f_gen_test_hdlr_pars() instead in order to get a configuration that is
Pau Espin Pedrol8df10112020-01-09 18:21:53 +0100561 * matched to the current test situation (aoip vs. sccplite) */
Harald Weltec1a2fff2017-12-17 11:06:19 +0100562template (value) TestHdlrParams t_def_TestHdlrPars := {
563 ra := '23'O,
564 fn := 23,
565 imsi := '001019876543210'H,
Harald Welte60aa5762018-03-21 19:33:13 +0100566 link_id := valueof(ts_RslLinkID_DCCH(0)),
Harald Weltecbe911c2018-06-01 18:23:07 +0200567 media_nr := 1,
Harald Welte651fcdc2018-05-10 20:23:16 +0200568 ass_codec_list := omit,
Neels Hofmeyrbcf62bc2018-07-04 00:24:33 +0200569 expect_mr_conf_ie := omit,
Philipp Maierd0e64b02019-03-13 14:15:23 +0100570 expect_mr_s0_s7 := omit,
Harald Weltecc0b0142018-05-29 15:19:33 +0200571 encr := omit,
572 lcls := {
573 gcr := omit,
574 cfg := omit,
575 csc := omit,
Max2eeb5112018-11-06 19:21:41 +0100576 exp_sts := omit,
577 adjust_cx_exp := true
Neels Hofmeyrbd0ef932018-03-19 14:58:46 +0100578 },
Neels Hofmeyr90f80962020-06-12 16:16:55 +0200579 sccp_addr_msc := omit,
580 sccp_addr_bsc := omit,
Pau Espin Pedrolf7630a62019-10-28 15:07:08 +0100581 exp_ms_power_level := 7, /* calculated from osmo-bsc.cfg "ms max power" */
Pau Espin Pedrol8f773632019-11-05 11:46:53 +0100582 exp_ms_power_params := false,
Pau Espin Pedrolc6a53db2019-05-20 19:31:47 +0200583 aoip := true,
Neels Hofmeyrf246a922020-05-13 02:27:10 +0200584 use_osmux := false,
Pau Espin Pedrol07866632020-09-03 19:10:55 +0200585 host_aoip_tla := "1.2.3.4",
Neels Hofmeyrf246a922020-05-13 02:27:10 +0200586 mscpool := {
Neels Hofmeyr4f118412020-06-04 15:25:10 +0200587 bssap_idx := 0,
Neels Hofmeyr4f118412020-06-04 15:25:10 +0200588 rsl_idx := 0,
589 l3_info := omit
Neels Hofmeyrf246a922020-05-13 02:27:10 +0200590 }
Harald Weltec1a2fff2017-12-17 11:06:19 +0100591}
592
Harald Weltea0630032018-03-20 21:09:55 +0100593function f_create_chan_and_exp() runs on MSC_ConnHdlr {
594 var MobileIdentityLV mi := valueof(ts_MI_IMSI_LV(g_pars.imsi));
Harald Welte6ed6bf92018-01-24 21:09:15 +0100595 var PDU_ML3_MS_NW l3_info := valueof(ts_CM_SERV_REQ(CM_TYPE_MO_CALL, mi));
Harald Weltec1a2fff2017-12-17 11:06:19 +0100596 var octetstring l3_enc := enc_PDU_ML3_MS_NW(l3_info);
597
598 /* call helper function for CHAN_RQD -> IMM ASS ->EST_IND */
Harald Weltea0630032018-03-20 21:09:55 +0100599 RSL_Emulation.f_chan_est(g_pars.ra, l3_enc, g_pars.link_id, g_pars.fn);
Daniel Willmann191e0d92018-01-17 12:44:35 +0100600 f_create_bssmap_exp(l3_enc);
Harald Weltec1a2fff2017-12-17 11:06:19 +0100601}
602
Harald Welte898113b2018-01-31 18:32:21 +0100603function f_rsl_send_l3(template PDU_ML3_MS_NW l3, template (omit) RslLinkId link_id := omit,
604 template (omit) RslChannelNr chan_nr := omit) runs on MSC_ConnHdlr {
605 if (not isvalue(link_id)) {
606 link_id := ts_RslLinkID_DCCH(0);
607 }
608 if (not isvalue(chan_nr)) {
609 chan_nr := g_chan_nr;
610 }
611 RSL.send(ts_RSL_DATA_IND(valueof(chan_nr), valueof(link_id), enc_PDU_ML3_MS_NW(valueof(l3))));
612}
613
Harald Weltec1a2fff2017-12-17 11:06:19 +0100614function f_rsl_reply(template PDU_ML3_MS_NW l3, RSL_Message orig) runs on MSC_ConnHdlr {
615 var RslChannelNr chan_nr := orig.ies[0].body.chan_nr;
Harald Welte1a40de62017-12-23 02:28:34 +0100616 var RslLinkId link_id;
Harald Welte8d5eead2017-12-17 18:56:45 +0100617 if (orig.msg_type == RSL_MT_ENCR_CMD) {
618 link_id := orig.ies[2].body.link_id;
619 } else {
620 link_id := orig.ies[1].body.link_id;
621 }
Harald Welte898113b2018-01-31 18:32:21 +0100622 f_rsl_send_l3(l3, link_id, chan_nr);
Harald Weltec1a2fff2017-12-17 11:06:19 +0100623}
624
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100625/* Convert the chipher representation on BSSMAP to the representation used on RSL */
Harald Weltee613f962018-04-18 22:38:16 +0200626function f_chipher_mode_bssmap_to_rsl(OCT1 alg_bssmap) return RSL_AlgId
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100627{
628 /* A5 0 */
629 if (alg_bssmap == '01'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200630 return RSL_ALG_ID_A5_0;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100631 }
632 /* A5 1 */
633 else if (alg_bssmap == '02'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200634 return RSL_ALG_ID_A5_1;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100635 }
636 /* A5 2 */
637 else if (alg_bssmap == '04'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200638 return RSL_ALG_ID_A5_2;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100639 }
640 /* A5 3 */
641 else if (alg_bssmap == '08'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200642 return RSL_ALG_ID_A5_3;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100643 }
644 /* A5 4 */
645 else if (alg_bssmap == '10'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200646 return RSL_ALG_ID_A5_4;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100647 }
648 /* A5 5 */
649 else if (alg_bssmap == '20'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200650 return RSL_ALG_ID_A5_5;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100651 }
652 /* A5 6 */
653 else if (alg_bssmap == '40'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200654 return RSL_ALG_ID_A5_6;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100655 }
656 /* A5 7 */
657 else if (alg_bssmap == '80'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200658 return RSL_ALG_ID_A5_7;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100659 } else {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100660 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Unexpected Encryption Algorithm");
Harald Weltee613f962018-04-18 22:38:16 +0200661 return RSL_ALG_ID_A5_0;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100662 }
663}
664
Harald Welte38b2a102017-12-23 02:42:58 +0100665function f_cipher_mode(OCT1 alg, OCT8 key, template OCT16 kc128 := omit, boolean exp_fail := false)
666runs on MSC_ConnHdlr {
Harald Welte73cd2712017-12-17 00:44:52 +0100667 var PDU_BSSAP bssap;
668 var RSL_Message rsl;
Harald Weltee613f962018-04-18 22:38:16 +0200669 var RSL_AlgId alg_rsl;
Harald Welte73cd2712017-12-17 00:44:52 +0100670
671 if (isvalue(kc128)) {
672 BSSAP.send(ts_BSSMAP_CipherModeCmdKc128(alg, key, valueof(kc128)));
673 } else {
674 BSSAP.send(ts_BSSMAP_CipherModeCmd(alg, key));
675 }
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100676
677 /* RSL uses a different representation of the encryption algorithm,
678 * so we need to convert first */
679 alg_rsl := f_chipher_mode_bssmap_to_rsl(alg);
680
Harald Welte73cd2712017-12-17 00:44:52 +0100681 alt {
682 /* RSL/UE Side */
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100683 [] RSL.receive(tr_RSL_ENCR_CMD(g_chan_nr, ?, alg_rsl, key)) -> value rsl {
Harald Welte73cd2712017-12-17 00:44:52 +0100684 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[3].body.l3_info.payload);
685 log("Rx L3 from net: ", l3);
686 if (ischosen(l3.msgs.rrm.cipheringModeCommand)) {
687 f_rsl_reply(ts_RRM_CiphModeCompl, rsl);
688 }
689 repeat;
690 }
691 [] BSSAP.receive(tr_BSSMAP_CipherModeCompl) -> value bssap {
692 // bssap.bssmap.cipherModeComplete.chosenEncryptionAlgorithm.algoritmhIdentifier
Harald Welte38b2a102017-12-23 02:42:58 +0100693 if (exp_fail == true) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100694 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Unexpected Cipher Mode Complete");
Harald Welte38b2a102017-12-23 02:42:58 +0100695 } else {
696 setverdict(pass);
697 }
Harald Welte73cd2712017-12-17 00:44:52 +0100698 }
699 [] BSSAP.receive(tr_BSSMAP_CipherModeRej) -> value bssap {
Harald Welte38b2a102017-12-23 02:42:58 +0100700 if (exp_fail == false) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100701 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Ciphering Mode Reject");
Harald Welte38b2a102017-12-23 02:42:58 +0100702 } else {
703 setverdict(pass);
704 }
Harald Welte73cd2712017-12-17 00:44:52 +0100705 }
706 }
707}
708
Harald Welte211219e2018-01-29 22:03:36 +0100709/* Convert from Ericsson ChanDesc2 format to Osmocom RslChannelNr format */
710function f_ChDesc2RslChanNr(ChannelDescription2_V ch_desc, out RslChannelNr chan_nr, out GsmArfcn arfcn) {
711 var BIT5 inp := ch_desc.channelTypeandTDMAOffset;
Harald Welte6fa1f732018-03-21 22:46:16 +0100712 var uint3_t tn := bit2int(ch_desc.timeslotNumber);
Harald Welte211219e2018-01-29 22:03:36 +0100713
714 if (match(inp, '00001'B)) { /* TCH/F */
Harald Welte6fa1f732018-03-21 22:46:16 +0100715 chan_nr := valueof(t_RslChanNr_Bm(tn));
Harald Welte211219e2018-01-29 22:03:36 +0100716 }
717 else if (match(inp, '0001?'B)) { /* TCH/H */
Harald Welte6fa1f732018-03-21 22:46:16 +0100718 chan_nr := valueof(t_RslChanNr_Lm(tn, bit2int(substr(inp, 4, 1))));
Harald Welte211219e2018-01-29 22:03:36 +0100719 }
720 else if (match(inp, '001??'B)) { /* SDCCH/4 */
Harald Welte6fa1f732018-03-21 22:46:16 +0100721 chan_nr := valueof(t_RslChanNr_SDCCH4(tn, bit2int(substr(inp, 3, 2))));
Harald Welte211219e2018-01-29 22:03:36 +0100722 }
723 else if (match(inp, '01???'B)) { /* SDCCH/8 */
Harald Welte6fa1f732018-03-21 22:46:16 +0100724 chan_nr := valueof(t_RslChanNr_SDCCH8(tn, bit2int(substr(inp, 2, 3))));
Harald Welte211219e2018-01-29 22:03:36 +0100725 }
726 else {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100727 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Unknown ChDesc!");
Harald Welte211219e2018-01-29 22:03:36 +0100728 }
729
730 if (ch_desc.octet3 and4b '10'O == '10'O) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100731 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "No support for Hopping");
Harald Welte211219e2018-01-29 22:03:36 +0100732 } else {
733 var OCT2 concat := ch_desc.octet3 & ch_desc.octet4;
734 arfcn := oct2int(concat);
735 }
736}
737
738type record AssignmentState {
739 /* global */
740 boolean voice_call,
741 boolean is_assignment,
742 /* Assignment related bits */
743 boolean rr_ass_cmpl_seen,
Neels Hofmeyra5302c82018-11-04 23:09:58 +0100744 boolean old_lchan_deact_sacch_seen,
745 boolean old_lchan_rll_rel_req_seen,
Harald Welte21583082018-01-29 22:28:26 +0100746 boolean assignment_done,
Harald Welte211219e2018-01-29 22:03:36 +0100747 RslChannelNr old_chan_nr,
748 /* Modify related bits */
749 boolean rr_modify_seen,
Harald Welte21583082018-01-29 22:28:26 +0100750 boolean modify_done
Harald Welte211219e2018-01-29 22:03:36 +0100751}
752
753template (value) AssignmentState ts_AssignmentStateInit := {
754 voice_call := false,
755 is_assignment := false,
756 rr_ass_cmpl_seen := false,
Neels Hofmeyra5302c82018-11-04 23:09:58 +0100757 old_lchan_deact_sacch_seen := false,
758 old_lchan_rll_rel_req_seen := false,
Harald Welte21583082018-01-29 22:28:26 +0100759 assignment_done := false,
Harald Welte211219e2018-01-29 22:03:36 +0100760 old_chan_nr := -,
761 rr_modify_seen := false,
Harald Welte21583082018-01-29 22:28:26 +0100762 modify_done := false
Harald Welte211219e2018-01-29 22:03:36 +0100763}
764
Harald Welte8a9bf6f2018-05-10 22:00:49 +0200765private template RSL_IE_Body tr_EncrInfo(template RSL_AlgId alg, template octetstring key) := {
766 encr_info := {
767 len := ?,
768 alg_id := alg,
769 key := key
770 }
771}
772
773/* ensure the RSL CHAN ACT (during assignment) contains values we expect depending on test case */
774private function f_check_chan_act(AssignmentState st, RSL_Message chan_act) runs on MSC_ConnHdlr {
775 var RSL_IE_Body encr_info;
Pau Espin Pedrol3d008ae2019-10-28 13:35:46 +0100776 var RSL_IE_Body ms_power_param;
Pau Espin Pedrolf7630a62019-10-28 15:07:08 +0100777 var RSL_IE_Body ms_power;
Pau Espin Pedrol3d008ae2019-10-28 13:35:46 +0100778
Harald Welte8a9bf6f2018-05-10 22:00:49 +0200779 if (ispresent(g_pars.encr) and g_pars.encr.enc_alg != '01'O) {
780 if (not f_rsl_find_ie(chan_act, RSL_IE_ENCR_INFO, encr_info)) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100781 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Missing Encryption IE in CHAN ACT");
Harald Welte8a9bf6f2018-05-10 22:00:49 +0200782 } else {
783 var RSL_AlgId alg := f_chipher_mode_bssmap_to_rsl(g_pars.encr.enc_alg);
784 if (not match(encr_info, tr_EncrInfo(alg, g_pars.encr.enc_key))) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100785 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Wrong Encryption IE in CHAN ACT");
Harald Welte8a9bf6f2018-05-10 22:00:49 +0200786 }
787 }
788 } else {
789 if (f_rsl_find_ie(chan_act, RSL_IE_ENCR_INFO, encr_info)) {
790 if (encr_info.encr_info.alg_id != RSL_ALG_ID_A5_0) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100791 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Unexpected Encryption in CHAN ACT");
Harald Welte8a9bf6f2018-05-10 22:00:49 +0200792 }
793 }
794 }
795 /* 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 +0100796 * RSL_IE_TIMING_ADVANCE */
Pau Espin Pedrol3d008ae2019-10-28 13:35:46 +0100797
Pau Espin Pedrol8f773632019-11-05 11:46:53 +0100798 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 +0100799 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "IE MS Power Parameters not found in CHAN ACT");
800 }
801
Pau Espin Pedrolf7630a62019-10-28 15:07:08 +0100802 if (not f_rsl_find_ie(chan_act, RSL_IE_MS_POWER, ms_power)) {
803 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "IE MS Power not found in CHAN ACT");
804 } else {
805 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 +0100806 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 +0100807 }
808 }
809
Harald Welte8a9bf6f2018-05-10 22:00:49 +0200810}
811
Harald Welte211219e2018-01-29 22:03:36 +0100812altstep as_assignment(inout AssignmentState st) runs on MSC_ConnHdlr {
Harald Weltec1a2fff2017-12-17 11:06:19 +0100813 var RSL_Message rsl;
Harald Welte211219e2018-01-29 22:03:36 +0100814 [not st.rr_ass_cmpl_seen] RSL.receive(tr_RSL_DATA_REQ(g_chan_nr)) -> value rsl {
815 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[2].body.l3_info.payload);
816 log("Rx L3 from net: ", l3);
817 if (ischosen(l3.msgs.rrm.assignmentCommand)) {
818 var RslChannelNr new_chan_nr;
819 var GsmArfcn arfcn;
820 f_ChDesc2RslChanNr(l3.msgs.rrm.assignmentCommand.descrOf1stChAfterTime,
821 new_chan_nr, arfcn);
822 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
Harald Weltec1a2fff2017-12-17 11:06:19 +0100823
Harald Welte211219e2018-01-29 22:03:36 +0100824 /* register our component for this channel number at the RSL Emulation */
825 f_rslem_register(0, new_chan_nr);
Vadim Yanitskiy539e6302020-06-22 03:11:54 +0700826 /* dispatch queued messages for this channel (if any) */
827 f_rslem_dchan_queue_dispatch();
828
Harald Welte211219e2018-01-29 22:03:36 +0100829 var PDU_ML3_MS_NW l3_tx := valueof(ts_RRM_AssignmentComplete('00'O));
830 /* send assignment complete over the new channel */
Neels Hofmeyrb0e73652018-07-14 21:56:51 +0200831 RSL.send(ts_RSL_EST_IND(new_chan_nr, valueof(ts_RslLinkID_DCCH(0)),
Harald Welte211219e2018-01-29 22:03:36 +0100832 enc_PDU_ML3_MS_NW(l3_tx)));
833 /* by default, send via the new channel from now */
834 st.old_chan_nr := g_chan_nr;
835 g_chan_nr := new_chan_nr;
836 st.rr_ass_cmpl_seen := true;
Harald Welte8a9bf6f2018-05-10 22:00:49 +0200837 /* obtain channel activation from RSL_Emulation for new channel */
838 var RSL_Message chan_act := f_rslem_get_last_act(RSL_PROC, 0, g_chan_nr);
839 /* check it (e.g. for correct ciphering parameters) */
840 f_check_chan_act(st, chan_act);
Harald Welte211219e2018-01-29 22:03:36 +0100841 repeat;
842 } else {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100843 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, log2str("Unexpected L3 received", l3));
Harald Weltec1a2fff2017-12-17 11:06:19 +0100844 }
Harald Welte211219e2018-01-29 22:03:36 +0100845 }
Neels Hofmeyr861a4c12018-11-07 01:23:17 +0100846 [st.rr_ass_cmpl_seen] RSL.receive(tr_RSL_DEACT_SACCH(st.old_chan_nr)) {
Neels Hofmeyra5302c82018-11-04 23:09:58 +0100847 st.old_lchan_deact_sacch_seen := true;
Neels Hofmeyr861a4c12018-11-07 01:23:17 +0100848 repeat;
849 }
Harald Welte211219e2018-01-29 22:03:36 +0100850 [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 +0100851 st.old_lchan_rll_rel_req_seen := true;
Harald Welte211219e2018-01-29 22:03:36 +0100852 RSL.send(ts_RSL_REL_CONF(st.old_chan_nr, valueof(ts_RslLinkID_DCCH(0))));
853 repeat;
854 }
855 [st.rr_ass_cmpl_seen] RSL.receive(tr_RSL_RF_CHAN_REL(st.old_chan_nr)) {
856 RSL.send(ts_RSL_RF_CHAN_REL_ACK(st.old_chan_nr));
Harald Welte1909f462018-01-29 22:29:29 +0100857 /* unregister for old channel number in RSL emulation */
858 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
859 f_rslem_unregister(0, st.old_chan_nr);
Harald Welte21583082018-01-29 22:28:26 +0100860 st.assignment_done := true;
Harald Welte211219e2018-01-29 22:03:36 +0100861 repeat;
862 }
863}
864
865altstep as_modify(inout AssignmentState st) runs on MSC_ConnHdlr {
866 /* no assignment, just mode modify */
867 var RSL_Message rsl;
868
869 [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 +0100870 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[2].body.l3_info.payload);
871 log("Rx L3 from net: ", l3);
872 if (ischosen(l3.msgs.rrm.channelModeModify)) {
873 f_rsl_reply(ts_RRM_ModeModifyAck(l3.msgs.rrm.channelModeModify.channelDescription,
874 l3.msgs.rrm.channelModeModify.channelMode), rsl);
Harald Welte211219e2018-01-29 22:03:36 +0100875 st.rr_modify_seen := true;
Harald Weltec1a2fff2017-12-17 11:06:19 +0100876 }
877 repeat;
878 }
Harald Welte211219e2018-01-29 22:03:36 +0100879 [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 +0100880 RSL.send(ts_RSL_MODE_MODIFY_ACK(g_chan_nr));
Harald Welte21583082018-01-29 22:28:26 +0100881 st.modify_done := true;
Harald Weltec1a2fff2017-12-17 11:06:19 +0100882 repeat;
883 }
Harald Welte211219e2018-01-29 22:03:36 +0100884}
Daniel Willmann191e0d92018-01-17 12:44:35 +0100885
Harald Welte211219e2018-01-29 22:03:36 +0100886/* Determine if given rsl_chan_nr is compatible with given BSSMAP ChannelType */
887function f_channel_compatible(BSSMAP_IE_ChannelType bssmap, RslChannelNr rsl_chan_nr)
888return boolean {
889 select (bssmap.speechOrDataIndicator) {
890 case ('0011'B) { /* Signalling */
891 /* all channels support signalling */
892 return true;
893 }
894 case else { /* Speech, Speech+CTM or CSD */
895 select (bssmap.channelRateAndType) {
896 case ('08'O) { /* TCH/F */
897 select (rsl_chan_nr) {
898 case (t_RslChanNr_Bm(?)) { return true; }
899 }
900 }
901 case ('09'O) { /* TCH/H */
902 select (rsl_chan_nr) {
903 case (t_RslChanNr_Lm(?, ?)) { return true; }
904 }
905 }
906 case else { /* full or half-rate */
907 select (rsl_chan_nr) {
908 case (t_RslChanNr_Bm(?)) { return true; }
909 case (t_RslChanNr_Lm(?, ?)) { return true; }
910 }
911 }
912 }
Harald Weltec1a2fff2017-12-17 11:06:19 +0100913 }
Harald Welte211219e2018-01-29 22:03:36 +0100914 }
915 return false;
916}
Daniel Willmann191e0d92018-01-17 12:44:35 +0100917
Philipp Maier8ef527e2018-05-18 11:12:50 +0200918/* Determine if the channel mode specified within rsl_chan_nr requires a
919 * MODE MODIFY in to match the channel mode specified by given BSSMAP
920 * ChannelType */
921function f_channel_needs_modify(BSSMAP_IE_ChannelType bssmap, RslChannelNr rsl_chan_nr)
922return boolean {
923
924 /* FIXME: This tests the rsl_chan_nr to determine if we are on a
925 * signalling channel or not. Unfortunately this may lead to false
926 * results if we are on a TCH. The problem is that a TCH may be also
927 * used in signalling mode, but this function assumes that only SDCCH4
928 * and SDCCH8 are used as signalling channels at all. */
929
930 var boolean current_signalling := false;
931 var boolean desired_signalling := false;
932
933 select (rsl_chan_nr) {
934 case (t_RslChanNr_SDCCH4(?, ?)) { current_signalling := true; }
935 case (t_RslChanNr_SDCCH8(?, ?)) { current_signalling := true; }
936 }
937
938 if (bssmap.speechOrDataIndicator == '0011'B) {
939 desired_signalling := true;
940 }
941
942 if (current_signalling == desired_signalling) {
943 /* The desired channel mode is equal to the one we currently
944 * have, there is no mode modification needed or expected */
945 return false;
946 } else {
947 /* The desired channel mode and the current channel mode do
948 * not match. A mode modification is required */
949 return true;
950 }
951}
952
Harald Weltecc0b0142018-05-29 15:19:33 +0200953/* patch an BSSMAP ASS REQ with LCLS related IEs, depending on g_params */
954function f_ass_patch_lcls(inout template (omit) PDU_BSSAP ass_tpl,
955 inout template PDU_BSSAP ass_cpl) runs on MSC_ConnHdlr {
956 if (istemplatekind(ass_tpl, "omit")) {
957 return;
958 }
959 if (ispresent(g_pars.lcls.gcr)) {
960 ass_tpl.pdu.bssmap.assignmentRequest.globalCallReference := ts_BSSMAP_IE_GCR(g_pars.lcls.gcr);
961 }
962 if (ispresent(g_pars.lcls.cfg)) {
963 ass_tpl.pdu.bssmap.assignmentRequest.lCLS_Configuration := ts_BSSMAP_IE_LclsCfg(g_pars.lcls.cfg);
964 }
965 if (ispresent(g_pars.lcls.csc)) {
966 ass_tpl.pdu.bssmap.assignmentRequest.lCLS_ConnectionStatusControl := ts_BSSMAP_IE_LclsCsc(g_pars.lcls.csc);
967 }
Harald Welte343b7742018-06-05 23:41:37 +0200968 if (ischosen(ass_cpl.pdu.bssmap.assignmentComplete)) {
969 if (ispresent(g_pars.lcls.exp_sts)) {
970 ass_cpl.pdu.bssmap.assignmentComplete.lCLS_BSS_Status := tr_BSSMAP_IE_LclsSts(g_pars.lcls.exp_sts);
971 } else {
972 ass_cpl.pdu.bssmap.assignmentComplete.lCLS_BSS_Status := omit;
973 }
Harald Weltecc0b0142018-05-29 15:19:33 +0200974 }
975}
976
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200977/* Send a MGCP request through MGCP-over-IPA from MSC side and receive a (matching!) response */
978function mgcp_transceive_mgw(template MgcpCommand cmd, template MgcpResponse resp := ?) runs on MSC_ConnHdlr {
979 template MgcpResponse resp_any := ?
980 var MgcpResponse resp_val;
981 resp.line.trans_id := cmd.line.trans_id;
982 timer T := 5.0;
983
984 BSSAP.send(cmd);
985 T.start;
986 alt {
987 [] as_Media_mgw();
988 [] BSSAP.receive(resp) -> value resp_val { }
989 [] BSSAP.receive(resp_any) {
990 setverdict(fail, "Response didn't match template");
991 mtc.stop;
992 }
993 [] BSSAP.receive { repeat; }
994 [] T.timeout {
995 setverdict(fail, "Timeout waiting for response to ", cmd);
996 mtc.stop;
997 }
998 }
999 T.stop;
1000}
1001
Philipp Maier3e2af5d2018-07-11 17:01:05 +02001002/* Helper function to check if the activity on the MGCP matches what we
1003 * expected */
1004function f_check_mgcp_expectations() runs on MSC_ConnHdlr {
1005 for (var integer i:= 0; i < sizeof(g_media.mgcp_conn); i := i+1) {
Philipp Maier0a5d7e72018-07-16 15:13:11 +02001006 log(testcasename(), ": Check MGCP test expectations for g_media.mgcp_conn[", i , "]:",
1007 " crcx_seen=", g_media.mgcp_conn[i].crcx_seen, ", crcx_seen_exp=", g_media.mgcp_conn[i].crcx_seen_exp,
1008 ", mdcx_seen=", g_media.mgcp_conn[i].mdcx_seen, ", mdcx_seen_exp=", g_media.mgcp_conn[i].mdcx_seen_exp);
1009
Philipp Maier3e2af5d2018-07-11 17:01:05 +02001010 if(g_media.mgcp_conn[i].crcx_seen != g_media.mgcp_conn[i].crcx_seen_exp) {
Max4b0f4962018-11-06 19:20:24 +01001011 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 +02001012 }
1013 if(g_media.mgcp_conn[i].mdcx_seen != g_media.mgcp_conn[i].mdcx_seen_exp) {
Max4b0f4962018-11-06 19:20:24 +01001014 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 +02001015 }
1016 }
1017}
1018
Harald Welte211219e2018-01-29 22:03:36 +01001019/* establish a channel fully, expecting an assignment matching 'exp' */
Harald Welte7a14fd52018-05-10 22:26:55 +02001020function f_establish_fully(template (omit) PDU_BSSAP ass_tpl, template PDU_BSSAP exp_ass_cpl)
1021runs on MSC_ConnHdlr {
Philipp Maier11a58942018-06-25 16:40:48 +02001022
1023 var BSSMAP_FIELD_CodecType codecType;
Philipp Maier48aeeec2018-09-14 18:20:04 +02001024 timer T := 10.0;
Philipp Maier3e2af5d2018-07-11 17:01:05 +02001025
Philipp Maier4ce978c2020-08-11 22:54:07 +02001026 if (not istemplatekind(ass_tpl, "omit") and isvalue(ass_tpl.pdu.bssmap.assignmentRequest.codecList)) {
Philipp Maier11a58942018-06-25 16:40:48 +02001027 codecType := valueof(ass_tpl.pdu.bssmap.assignmentRequest.codecList.codecElements[0].codecType);
1028 } else {
1029 /* Make sure a meaningful default is assigned in case the
1030 * codecList is not populated */
1031 codecType := FR_AMR;
1032 }
1033
Pau Espin Pedrol07866632020-09-03 19:10:55 +02001034 f_MscConnHdlr_init(g_pars.media_nr, host_bts, host_mgw_mgcp, codecType);
Harald Welte7a14fd52018-05-10 22:26:55 +02001035
Harald Weltecc0b0142018-05-29 15:19:33 +02001036 /* patch in the LCLS related items, as needed */
1037 f_ass_patch_lcls(ass_tpl, exp_ass_cpl);
1038
Harald Welte7a14fd52018-05-10 22:26:55 +02001039 f_create_chan_and_exp();
1040 /* we should now have a COMPL_L3 at the MSC */
Philipp Maier48aeeec2018-09-14 18:20:04 +02001041
1042 var template PDU_BSSAP exp_l3_compl;
1043 exp_l3_compl := tr_BSSMAP_ComplL3()
Philipp Maier48604732018-10-09 15:00:37 +02001044 if (g_pars.aoip == false) {
Philipp Maier48aeeec2018-09-14 18:20:04 +02001045 exp_l3_compl.pdu.bssmap.completeLayer3Information.codecList := omit;
1046 } else {
1047 exp_l3_compl.pdu.bssmap.completeLayer3Information.codecList := ?;
1048 }
1049 T.start;
1050 alt {
1051 [] BSSAP.receive(exp_l3_compl);
1052 [] BSSAP.receive(tr_BSSMAP_ComplL3) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001053 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Received non-matching COMPLETE LAYER 3 INFORMATION");
Philipp Maier48aeeec2018-09-14 18:20:04 +02001054 }
1055 [] T.timeout {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001056 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Timeout waiting for COMPLETE LAYER 3 INFORMATION");
Philipp Maier48aeeec2018-09-14 18:20:04 +02001057 }
1058 }
Harald Welte7a14fd52018-05-10 22:26:55 +02001059
1060 /* start ciphering, if requested */
1061 if (ispresent(g_pars.encr)) {
1062 f_cipher_mode(g_pars.encr.enc_alg, g_pars.encr.enc_key);
1063 }
1064
1065 /* bail out early if no assignment requested */
1066 if (istemplatekind(ass_tpl, "omit")) {
1067 return;
1068 }
1069
1070 var PDU_BSSAP ass_cmd := valueof(ass_tpl);
Harald Welte211219e2018-01-29 22:03:36 +01001071 var PDU_BSSAP bssap;
Harald Welte211219e2018-01-29 22:03:36 +01001072 var boolean exp_compl := ischosen(exp_ass_cpl.pdu.bssmap.assignmentComplete);
Philipp Maier86f39202018-02-07 14:40:09 +01001073 var boolean exp_fail := ischosen(exp_ass_cpl.pdu.bssmap.assignmentFailure);
Philipp Maier8ef527e2018-05-18 11:12:50 +02001074 var boolean exp_modify;
Philipp Maier48aeeec2018-09-14 18:20:04 +02001075
Harald Welte211219e2018-01-29 22:03:36 +01001076 var ExpectCriteria mgcpcrit := {
1077 connid := omit,
1078 endpoint := omit,
1079 transid := omit
1080 };
1081 var AssignmentState st := valueof(ts_AssignmentStateInit);
1082 /* if the channel type is SIGNAL, we're not handling a voice call */
1083 if (ass_cmd.pdu.bssmap.assignmentRequest.channelType.speechOrDataIndicator != '0011'B) {
1084 st.voice_call := true;
Philipp Maier8ef527e2018-05-18 11:12:50 +02001085 exp_modify := true;
Harald Welte211219e2018-01-29 22:03:36 +01001086 }
Philipp Maier8ef527e2018-05-18 11:12:50 +02001087
Harald Welte211219e2018-01-29 22:03:36 +01001088 /* determine if the current channel can support the given service or not */
1089 if (not f_channel_compatible(ass_cmd.pdu.bssmap.assignmentRequest.channelType, g_chan_nr)) {
1090 st.is_assignment := true;
Philipp Maier8ef527e2018-05-18 11:12:50 +02001091
1092 /* We decided to assign a new channel, so we do not expect
1093 * any mode modify messages on RSL */
1094 exp_modify := false;
1095 } else {
1096 /* We will continue working with the currently assigned
1097 * channel, we must now check if the mode of the current
1098 * channel is compatible. If not we expect the BSC to modify
1099 * the mode */
1100 exp_modify := f_channel_needs_modify(ass_cmd.pdu.bssmap.assignmentRequest.channelType, g_chan_nr);
Harald Welte211219e2018-01-29 22:03:36 +01001101 }
1102
Philipp Maier3e2af5d2018-07-11 17:01:05 +02001103 /* Some test situations will involve MGCP transactions on a media
1104 * gateway. Depending on the situation, we set up how many of each MGCP
1105 * message type are expected to be exchanged. */
1106 if (isbound(exp_ass_cpl.pdu.bssmap.assignmentFailure)) {
1107 /* For tests that expect the assignment to fail, assume that
1108 * there will be no MGW communication as well. */
1109 g_media.mgcp_conn[0].crcx_seen_exp := 0;
1110 g_media.mgcp_conn[0].mdcx_seen_exp := 0;
1111 g_media.mgcp_conn[1].crcx_seen_exp := 0;
1112 g_media.mgcp_conn[1].mdcx_seen_exp := 0;
1113 } else if (st.voice_call) {
1114 /* For voice calls we expect the following MGCP activity */
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +02001115 g_media.mgcp_conn[0].crcx_seen_exp := 1;
1116 g_media.mgcp_conn[0].mdcx_seen_exp := 1;
1117 g_media.mgcp_conn[1].crcx_seen_exp := 1;
1118 g_media.mgcp_conn[1].mdcx_seen_exp := 0;
Philipp Maier3e2af5d2018-07-11 17:01:05 +02001119 }
1120
Vadim Yanitskiy539e6302020-06-22 03:11:54 +07001121 /* On receipt of the BSSAP Assignment Command, the IUT (osmo-bsc) will allocate
1122 * a channel and send us RR Assignment Command together with ip.access CRCX.
1123 * There is a risk that the RSL Emulation component would dequeue and process
1124 * ip.access CRCX faster than we process the Assignment Command and register
1125 * the corresponding handler for the indicated RSL channel number. This would
1126 * result in a failure, because at that moment there will be no handler for
1127 * ip.access CRCX. Let's guard against this and enable additional queueing. */
1128 f_rslem_dchan_queue_enable();
1129
Harald Welte211219e2018-01-29 22:03:36 +01001130 f_create_mgcp_expect(mgcpcrit);
1131 BSSAP.send(ass_cmd);
1132
1133 T.start;
1134 alt {
1135 /* assignment related bits */
1136 [st.is_assignment] as_assignment(st);
1137
1138 /* modify related bits */
Philipp Maier8ef527e2018-05-18 11:12:50 +02001139 [not st.is_assignment and exp_modify] as_modify(st);
Harald Welte211219e2018-01-29 22:03:36 +01001140
1141 /* voice call related bits (IPA CRCX/MDCX + MGCP) */
1142 [st.voice_call] as_Media();
1143
1144 /* if we receive exactly what we expected, always return + pass */
Philipp Maier8ef527e2018-05-18 11:12:50 +02001145 [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 +01001146 setverdict(pass);
1147 }
Philipp Maier86f39202018-02-07 14:40:09 +01001148 [exp_fail] BSSAP.receive(exp_ass_cpl) -> value bssap {
1149 setverdict(pass);
1150 }
Harald Welte21583082018-01-29 22:28:26 +01001151 [(st.is_assignment and st.assignment_done or
Philipp Maier8ef527e2018-05-18 11:12:50 +02001152 (not st.is_assignment and (st.modify_done or not exp_modify))) and
Harald Welte21583082018-01-29 22:28:26 +01001153 exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentComplete) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001154 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Received non-matching ASSIGNMENT COMPLETE");
Harald Weltec1a2fff2017-12-17 11:06:19 +01001155 }
1156 [exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentFail) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001157 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Received unexpected ASSIGNMENT FAIL");
Harald Weltec1a2fff2017-12-17 11:06:19 +01001158 }
1159 [not exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentComplete) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001160 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Received unexpected ASSIGNMENT COMPLETE");
Harald Weltec1a2fff2017-12-17 11:06:19 +01001161 }
1162 [not exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentFail) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001163 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Received non-matching ASSIGNMENT FAIL");
Harald Weltec1a2fff2017-12-17 11:06:19 +01001164 }
1165 [] T.timeout {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001166 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Timeout waiting for ASSIGNMENT COMPLETE");
Harald Weltec1a2fff2017-12-17 11:06:19 +01001167 }
1168 }
Harald Welte211219e2018-01-29 22:03:36 +01001169 log("g_media ", g_media);
1170 if (not isbound(bssap)) {
Daniel Willmannafce8662018-07-06 23:11:32 +02001171 mtc.stop;
Harald Welte211219e2018-01-29 22:03:36 +01001172 }
Philipp Maier3e2af5d2018-07-11 17:01:05 +02001173
Philipp Maiera0976e92018-07-16 15:19:42 +02001174 /* When the BSC detects that LCLS is possible it will cross the
1175 * connetions that point to the PBX side of the MGW. In our case this
1176 * is mgcp_conn[1]. The BSC performs this operation already before the
1177 * assignment complete is generated. This means we expect another MDCX
1178 * at mgcp_conn[1] when LCLS is expected. */
Max2eeb5112018-11-06 19:21:41 +01001179 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 +02001180 if (valueof(exp_ass_cpl.pdu.bssmap.assignmentComplete.lCLS_BSS_Status.lCLS_BSS_StatusValue) == LCLS_STS_locally_switched) {
1181 g_media.mgcp_conn[1].mdcx_seen_exp := g_media.mgcp_conn[1].mdcx_seen_exp + 1;
1182
1183 }
1184 }
1185
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +02001186 if (not exp_fail and st.voice_call and not g_pars.aoip) {
1187 /* With SCCPLite, connect to BSC-located MGW using a CRCX + SDP.
1188 It is sent in MGCP over IPA in the BSC<->MSC (BSC-NAT)
1189 connection. BSC will forward it to its MGW. */
1190 var template MgcpCommand cmd;
1191 var template MgcpResponse resp;
1192 var integer cic := f_bssmap_ie_cic_2_int(ass_cmd.pdu.bssmap.assignmentRequest.circuitIdentityCode);
1193 var MgcpEndpoint ep := int2str(cic) & "@mgw"; /* 1: matches value configured in BSC_Tests.ttcn pass in AssignReq */
1194 var MgcpCallId call_id := '51234'H;
1195 var SDP_attribute_list attributes := { valueof(ts_SDP_ptime(20)) };
1196 if (g_pars.use_osmux) {
1197 cmd := ts_CRCX_osmux(get_next_trans_id(), ep, "sendrecv", call_id, cic);
1198 resp := tr_CRCX_ACK_osmux;
1199 } else {
1200 cmd := ts_CRCX(get_next_trans_id(), ep, "sendrecv", call_id);
1201 resp := tr_CRCX_ACK;
1202 }
Pau Espin Pedrol07866632020-09-03 19:10:55 +02001203 cmd.sdp := ts_SDP(host_msc, host_mgw_rtp_v4, "23", "42",
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +02001204 14000, { int2str(g_media.mgcp_conn[1].rtp_pt) },
1205 { valueof(ts_SDP_ptime(20)) });
1206 mgcp_transceive_mgw(cmd, resp);
1207 }
1208
Philipp Maier3e2af5d2018-07-11 17:01:05 +02001209 f_check_mgcp_expectations();
Neels Hofmeyra5302c82018-11-04 23:09:58 +01001210
1211 if (st.is_assignment and st.assignment_done) {
1212 if (not st.old_lchan_deact_sacch_seen) {
1213 setverdict(fail, "f_establish_fully(): Assignment completed, but the old lchan was not",
1214 " released properly: expected a Deact SACCH on the old lchan, but saw none.");
1215 }
1216 if (st.old_lchan_rll_rel_req_seen) {
1217 setverdict(fail, "f_establish_fully(): Assignment completed, but the old lchan was not",
1218 " released properly: saw an RLL Release on the old lchan, but expecting none.");
1219 }
1220 }
Harald Welte930d0a72018-03-22 22:08:40 +01001221}
1222
Harald Welte261af4b2018-02-12 21:20:39 +01001223type record HandoverState {
1224 /* Assignment related bits */
1225 boolean rr_ho_cmpl_seen,
Philipp Maierc1e95c82018-07-18 16:03:00 +02001226 integer mdcx_seen_before_ho,
Harald Welte261af4b2018-02-12 21:20:39 +01001227 boolean handover_done,
1228 RslChannelNr old_chan_nr
1229};
1230
1231altstep as_handover(inout HandoverState st) runs on MSC_ConnHdlr {
1232 var RSL_Message rsl;
1233 [not st.rr_ho_cmpl_seen] RSL.receive(tr_RSL_DATA_REQ(g_chan_nr)) -> value rsl {
1234 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[2].body.l3_info.payload);
1235 log("Rx L3 from net: ", l3);
1236 if (ischosen(l3.msgs.rrm.handoverCommand)) {
1237 var RslChannelNr new_chan_nr;
1238 var GsmArfcn arfcn;
1239 f_ChDesc2RslChanNr(l3.msgs.rrm.handoverCommand.channelDescription2,
1240 new_chan_nr, arfcn);
1241 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
1242
1243 /* register our component for this channel number at the RSL Emulation */
1244 f_rslem_register(0, new_chan_nr, RSL1_PROC);
1245
1246 /* resume processing of RSL DChan messages, which was temporarily suspended
1247 * before performing a hand-over */
1248 f_rslem_resume(RSL1_PROC);
1249
Neels Hofmeyr378a49c2018-06-15 22:18:43 +02001250 /* send handover detect */
1251 RSL1.send(ts_RSL_HANDO_DET(new_chan_nr));
1252 f_sleep(0.3);
1253
Harald Welte261af4b2018-02-12 21:20:39 +01001254 /* send handover complete over the new channel */
1255 var PDU_ML3_MS_NW l3_tx := valueof(ts_RRM_HandoverComplete('00'O));
Neels Hofmeyrd07ee132018-07-14 22:28:29 +02001256 RSL1.send(ts_RSL_EST_IND(new_chan_nr, valueof(ts_RslLinkID_DCCH(0)),
Harald Welte261af4b2018-02-12 21:20:39 +01001257 enc_PDU_ML3_MS_NW(l3_tx)));
1258 /* by default, send via the new channel from now */
1259 st.old_chan_nr := g_chan_nr;
1260 g_chan_nr := new_chan_nr;
1261 st.rr_ho_cmpl_seen := true;
Philipp Maierc1e95c82018-07-18 16:03:00 +02001262
1263 /* Memorize how many MDCX we have seen before. We need this number to detect
1264 * that we have received the handover related MDCX */
1265 st.mdcx_seen_before_ho := g_media.mgcp_conn[0].mdcx_seen;
Harald Welte261af4b2018-02-12 21:20:39 +01001266 repeat;
1267 } else {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001268 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, log2str("Unexpected L3 received", l3));
Harald Welte261af4b2018-02-12 21:20:39 +01001269 }
1270 }
Philipp Maierc1e95c82018-07-18 16:03:00 +02001271 [st.rr_ho_cmpl_seen] as_Media_ipacc();
Pau Espin Pedrol76ba5412019-06-10 11:00:33 +02001272 [st.rr_ho_cmpl_seen] as_Media_mgw(true);
Neels Hofmeyr861a4c12018-11-07 01:23:17 +01001273 [st.rr_ho_cmpl_seen] RSL.receive(tr_RSL_DEACT_SACCH(st.old_chan_nr)) {
1274 repeat;
1275 }
Harald Welte261af4b2018-02-12 21:20:39 +01001276 [st.rr_ho_cmpl_seen] RSL.receive(tr_RSL_REL_REQ(st.old_chan_nr, tr_RslLinkID_DCCH(0))) {
1277 RSL.send(ts_RSL_REL_CONF(st.old_chan_nr, valueof(ts_RslLinkID_DCCH(0))));
1278 repeat;
1279 }
1280 [st.rr_ho_cmpl_seen] RSL.receive(tr_RSL_RF_CHAN_REL(st.old_chan_nr)) {
1281 RSL.send(ts_RSL_RF_CHAN_REL_ACK(st.old_chan_nr));
1282 /* unregister for old channel number in RSL emulation */
1283 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
1284 f_rslem_unregister(0, st.old_chan_nr);
Philipp Maierc1e95c82018-07-18 16:03:00 +02001285
1286 /* The channel release must not necessarly be synchronized to the RSL handover
1287 * procedure since those events may happen independently nearly at the same
1288 * time. When we receive the RSL_RF_CHAN_REL command the media negotiation on
1289 * IPACC or MGCP level may be still in progress. In order to make sure that
1290 * we do only stop when we have seen an MDCX on MGCP level and another a CRCX
1291 * as well as an MDCX on IPACC level. */
1292 if (g_media.mgcp_conn[0].mdcx_seen <= st.mdcx_seen_before_ho or
1293 g_media.bts1.ipa_mdcx_seen == false or g_media.bts1.ipa_crcx_seen == false) {
1294 repeat;
1295 } else {
1296 st.handover_done := true;
1297 }
Harald Welte261af4b2018-02-12 21:20:39 +01001298 }
1299}
1300
1301
Harald Weltec1a2fff2017-12-17 11:06:19 +01001302
Harald Welte28d943e2017-11-25 15:00:50 +01001303}