blob: e492ee03f462670b7baed8766b9b1cd0c554cf46 [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 Welte47cd0e32020-08-21 12:39:11 +020022import from BSSAP_LE_Emulation all;
23import from BSSAP_LE_Types all;
24import from BSSMAP_LE_Templates all;
Harald Welte28d943e2017-11-25 15:00:50 +010025import from BSSMAP_Templates all;
26
Harald Welte211219e2018-01-29 22:03:36 +010027import from IPL4asp_Types all;
28import from Native_Functions all;
29
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +020030import from MGCP_CodecPort all;
Harald Welte28d943e2017-11-25 15:00:50 +010031import from MGCP_Types all;
32import from MGCP_Templates all;
Daniel Willmann191e0d92018-01-17 12:44:35 +010033import from MGCP_Emulation all;
Harald Welte28d943e2017-11-25 15:00:50 +010034import from SDP_Types all;
35
Daniel Willmannebdecc02020-08-12 15:30:17 +020036import from StatsD_Checker all;
37
Harald Weltec1a2fff2017-12-17 11:06:19 +010038import from RSL_Emulation all;
39import from RSL_Types all;
40
41import from MobileL3_Types all;
42import from MobileL3_CommonIE_Types all;
Harald Welte211219e2018-01-29 22:03:36 +010043import from MobileL3_RRM_Types all;
Harald Weltec1a2fff2017-12-17 11:06:19 +010044import from L3_Templates all;
45
Harald Weltec20b1c42018-02-12 20:50:08 +010046import from TELNETasp_PortType all;
47import from Osmocom_VTY_Functions all;
Neels Hofmeyrc2425cc2021-04-19 13:19:55 +000048import from TCCConversion_Functions all;
Harald Weltec20b1c42018-02-12 20:50:08 +010049
Harald Weltec1a2fff2017-12-17 11:06:19 +010050
Harald Welte211219e2018-01-29 22:03:36 +010051/***********************************************************************
52 * Media related handling
53 ***********************************************************************/
54
Philipp Maier11a58942018-06-25 16:40:48 +020055/* Get the matching payload type for a specified BSSAP codec type
56 * (see also: BSSAP_Types.ttcn */
57private function f_get_mgcp_pt(BSSMAP_FIELD_CodecType codecType) return SDP_FIELD_PayloadType {
58 if (codecType == GSM_FR) {
59 return PT_GSM;
60 } else if (codecType == GSM_HR) {
61 return PT_GSMHR;
62 } else if (codecType == GSM_EFR) {
63 return PT_GSMEFR;
64 } else if (codecType == FR_AMR or codecType == HR_AMR) {
65 return PT_AMR;
66 } else if (codecType == FR_AMR_WB or codecType == OHR_AMR or codecType == OFR_AMR_WB or codecType == OHR_AMR_WB) {
67 return PT_AMRWB;
68 }
69
70 return PT_PCMU;
71}
72
Harald Welte211219e2018-01-29 22:03:36 +010073/* Tuple containing host/ip and port */
74type record HostPort {
75 HostName host,
76 PortNumber port_nr
77};
78
79/* State encapsulating one MGCP Connection */
80type record MgcpConnState {
Philipp Maier3e2af5d2018-07-11 17:01:05 +020081 integer crcx_seen, /* Counts how many CRCX operations happend */
82 integer mdcx_seen, /* Counts how many MDCX operations happend C */
83 integer crcx_seen_exp, /* Sets the expected number of CRCX operations */
84 integer mdcx_seen_exp, /* Sets the expected number of MDCX operations */
Harald Welte211219e2018-01-29 22:03:36 +010085 MgcpConnectionId conn_id,
86 charstring mime_type, /* e.g. AMR */
87 integer sample_rate, /* 8000 */
88 integer ptime, /* 20 */
89 uint7_t rtp_pt, /* RTP Payload Type */
90 HostPort mgw, /* MGW side */
91 HostPort peer /* CA side */
92};
93
94/* BTS media state */
95type record BtsMediaState {
96 boolean ipa_crcx_seen,
Philipp Maierc1e95c82018-07-18 16:03:00 +020097 boolean ipa_mdcx_seen,
Harald Welte211219e2018-01-29 22:03:36 +010098 uint16_t conn_id,
99 uint7_t rtp_pt,
100 HostPort bts,
101 HostPort peer
102};
103
104type record MediaState {
105 MgcpEndpoint mgcp_ep,
106 MgcpConnState mgcp_conn[2],
Harald Welte261af4b2018-02-12 21:20:39 +0100107 BtsMediaState bts,
108 BtsMediaState bts1 /* only during hand-over */
Harald Welte211219e2018-01-29 22:03:36 +0100109};
110
Philipp Maier11a58942018-06-25 16:40:48 +0200111function f_MediaState_init(inout MediaState g_media, integer nr, HostName bts, HostName mgw, BSSMAP_FIELD_CodecType codecType) {
Harald Welte211219e2018-01-29 22:03:36 +0100112 /* BTS Side */
113 g_media.bts := {
114 ipa_crcx_seen := false,
Philipp Maierc1e95c82018-07-18 16:03:00 +0200115 ipa_mdcx_seen := false,
Harald Welte211219e2018-01-29 22:03:36 +0100116 conn_id := nr,
117 rtp_pt := 0,
118 bts := {
119 host := bts,
120 port_nr := 9000 + nr*2
121 },
122 peer := -
123 }
124
Harald Welte261af4b2018-02-12 21:20:39 +0100125 g_media.bts1 := {
126 ipa_crcx_seen := false,
Philipp Maierc1e95c82018-07-18 16:03:00 +0200127 ipa_mdcx_seen := false,
Harald Welte261af4b2018-02-12 21:20:39 +0100128 conn_id := nr,
129 rtp_pt := 0,
130 bts := {
131 host := bts, /* FIXME */
132 port_nr := 9000 + nr*2
133 },
134 peer := -
135 }
136
Harald Welte363cb0a2018-01-30 19:35:53 +0100137 g_media.mgcp_ep := "rtpbridge/" & int2str(nr) & "@mgw";
Harald Welte211219e2018-01-29 22:03:36 +0100138
139 for (var integer i:= 0; i < sizeof(g_media.mgcp_conn); i := i+1) {
Philipp Maier11a58942018-06-25 16:40:48 +0200140 g_media.mgcp_conn[i].mime_type := f_encoding_name_from_pt(f_get_mgcp_pt(codecType));
Harald Welte211219e2018-01-29 22:03:36 +0100141 g_media.mgcp_conn[i].sample_rate := 8000;
142 g_media.mgcp_conn[i].ptime := 20;
Philipp Maier11a58942018-06-25 16:40:48 +0200143 g_media.mgcp_conn[i].rtp_pt := enum2int(f_get_mgcp_pt(codecType));
Philipp Maier3e2af5d2018-07-11 17:01:05 +0200144 g_media.mgcp_conn[i].crcx_seen := 0;
145 g_media.mgcp_conn[i].mdcx_seen := 0;
146 g_media.mgcp_conn[i].crcx_seen_exp := 0;
147 g_media.mgcp_conn[i].mdcx_seen_exp := 0;
Harald Welte211219e2018-01-29 22:03:36 +0100148 g_media.mgcp_conn[i].conn_id := f_mgcp_alloc_conn_id();
149 }
150
151 g_media.mgcp_conn[0].mgw := {
152 host := mgw,
153 port_nr := 10000 + nr*2
154 }
155 g_media.mgcp_conn[1].mgw := {
156 host := mgw,
157 port_nr := 11000 + nr*2
158 }
159}
160
Philipp Maier3e2af5d2018-07-11 17:01:05 +0200161/* Helper function to get the next free MGCP connection identifier. We can
162 * recognize free connection identifiers by the fact that no CRCX happend yet */
Harald Welte211219e2018-01-29 22:03:36 +0100163private function f_get_free_mgcp_conn() runs on MSC_ConnHdlr return integer {
164 for (var integer i:= 0; i < sizeof(g_media.mgcp_conn); i := i+1) {
Philipp Maier3e2af5d2018-07-11 17:01:05 +0200165 if (not g_media.mgcp_conn[i].crcx_seen >= 1) {
Harald Welte211219e2018-01-29 22:03:36 +0100166 return i;
167 }
168 }
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100169 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Only 2 Connections per EP!");
170 /* Should never be reached */
171 return -1;
Harald Welte211219e2018-01-29 22:03:36 +0100172}
173
Philipp Maier3e2af5d2018-07-11 17:01:05 +0200174/* Helper function to pick a specific connection by its cid. Since we reach out
175 * for a connection that is in-use we also check if there was already exactly
176 * one CRCX happening on that connection. */
Harald Welte211219e2018-01-29 22:03:36 +0100177private function f_get_mgcp_conn(MgcpConnectionId cid) runs on MSC_ConnHdlr return integer {
178 for (var integer i:= 0; i < sizeof(g_media.mgcp_conn); i := i+1) {
Philipp Maier3e2af5d2018-07-11 17:01:05 +0200179 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 +0100180 return i;
181 }
182 }
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100183 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, log2str("No Connection for ID ", cid));
184 /* Should not be reached */
185 return -1;
Harald Welte211219e2018-01-29 22:03:36 +0100186}
187
Philipp Maierb2422352018-07-11 10:36:57 +0200188/* altstep for handling of IPACC media related commands. Activated by as_Media() to test
189 * RSL level media handling */
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +0200190altstep as_Media_ipacc(RSL_DCHAN_PT rsl_pt := RSL, RSL_DCHAN_PT rsl_pt_ho_target := RSL1) runs on MSC_ConnHdlr {
Harald Welte211219e2018-01-29 22:03:36 +0100191 var RSL_Message rsl;
Harald Welte211219e2018-01-29 22:03:36 +0100192 var RSL_IE_Body ie;
Harald Welte930d0a72018-03-22 22:08:40 +0100193 var boolean b_unused;
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +0200194 [not g_media.bts.ipa_crcx_seen] rsl_pt.receive(tr_RSL_IPA_CRCX(g_chan_nr)) -> value rsl {
Harald Welte211219e2018-01-29 22:03:36 +0100195 /* Extract parameters from request + use in response */
196 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
197 g_media.bts.rtp_pt := ie.ipa_rtp_pt;
198 }
199 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
200 g_media.bts.rtp_pt := ie.ipa_rtp_pt2;
201 }
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +0200202 rsl_pt.send(ts_RSL_IPA_CRCX_ACK(g_chan_nr, g_media.bts.conn_id,
Vadim Yanitskiyfc631642021-07-03 02:42:45 +0200203 f_inet_addr(g_media.bts.bts.host),
Harald Welte211219e2018-01-29 22:03:36 +0100204 g_media.bts.bts.port_nr,
205 g_media.bts.rtp_pt));
206 g_media.bts.ipa_crcx_seen := true;
207 repeat;
208 }
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +0200209 [g_media.bts.ipa_crcx_seen] rsl_pt.receive(tr_RSL_IPA_MDCX(g_chan_nr, ?)) -> value rsl{
Harald Welte211219e2018-01-29 22:03:36 +0100210 /* Extract conn_id, ip, port, rtp_pt2 from request + use in response */
Harald Welte930d0a72018-03-22 22:08:40 +0100211 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_CONN_ID, ie);
Harald Welte211219e2018-01-29 22:03:36 +0100212 if (g_media.bts.conn_id != ie.ipa_conn_id) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100213 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, log2str("IPA MDCX for unknown ConnId", rsl));
Harald Welte211219e2018-01-29 22:03:36 +0100214 }
215 /* mandatory */
Harald Welte930d0a72018-03-22 22:08:40 +0100216 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_IP, ie);
Vadim Yanitskiyfc631642021-07-03 02:42:45 +0200217 g_media.bts.peer.host := f_inet_ntoa(ie.ipa_remote_ip);
Harald Welte930d0a72018-03-22 22:08:40 +0100218 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_PORT, ie);
Harald Welte211219e2018-01-29 22:03:36 +0100219 g_media.bts.peer.port_nr := ie.ipa_remote_port;
220 /* optional */
221 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
222 g_media.bts.rtp_pt := ie.ipa_rtp_pt;
223 }
224 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
225 g_media.bts.rtp_pt := ie.ipa_rtp_pt2;
226 }
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +0200227 rsl_pt.send(ts_RSL_IPA_MDCX_ACK(g_chan_nr, g_media.bts.conn_id,
Vadim Yanitskiyfc631642021-07-03 02:42:45 +0200228 f_inet_addr(g_media.bts.peer.host),
Harald Welte211219e2018-01-29 22:03:36 +0100229 g_media.bts.peer.port_nr,
230 g_media.bts.rtp_pt));
Philipp Maierc1e95c82018-07-18 16:03:00 +0200231 g_media.bts.ipa_mdcx_seen := true;
Harald Welte211219e2018-01-29 22:03:36 +0100232 repeat;
233 }
Harald Welte261af4b2018-02-12 21:20:39 +0100234
235 /* on second (new) BTS during hand-over */
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +0200236 [not g_media.bts1.ipa_crcx_seen] rsl_pt_ho_target.receive(tr_RSL_IPA_CRCX(g_chan_nr)) -> value rsl {
Harald Welte261af4b2018-02-12 21:20:39 +0100237 /* Extract parameters from request + use in response */
238 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
239 g_media.bts1.rtp_pt := ie.ipa_rtp_pt;
240 }
241 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
242 g_media.bts1.rtp_pt := ie.ipa_rtp_pt2;
243 }
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +0200244 rsl_pt_ho_target.send(ts_RSL_IPA_CRCX_ACK(g_chan_nr, g_media.bts1.conn_id,
Vadim Yanitskiyfc631642021-07-03 02:42:45 +0200245 f_inet_addr(g_media.bts1.bts.host),
Harald Welte261af4b2018-02-12 21:20:39 +0100246 g_media.bts1.bts.port_nr,
247 g_media.bts1.rtp_pt));
248 g_media.bts1.ipa_crcx_seen := true;
249 repeat;
250 }
251 /* on second (new) BTS during hand-over */
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +0200252 [g_media.bts1.ipa_crcx_seen] rsl_pt_ho_target.receive(tr_RSL_IPA_MDCX(g_chan_nr, ?)) -> value rsl{
Harald Welte261af4b2018-02-12 21:20:39 +0100253 /* Extract conn_id, ip, port, rtp_pt2 from request + use in response */
Harald Welte930d0a72018-03-22 22:08:40 +0100254 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_CONN_ID, ie);
Harald Welte261af4b2018-02-12 21:20:39 +0100255 if (g_media.bts1.conn_id != ie.ipa_conn_id) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100256 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, log2str("IPA MDCX for unknown ConnId", rsl));
Harald Welte261af4b2018-02-12 21:20:39 +0100257 }
258 /* mandatory */
Harald Welte930d0a72018-03-22 22:08:40 +0100259 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_IP, ie);
Vadim Yanitskiyfc631642021-07-03 02:42:45 +0200260 g_media.bts1.peer.host := f_inet_ntoa(ie.ipa_remote_ip);
Harald Welte930d0a72018-03-22 22:08:40 +0100261 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_PORT, ie);
Harald Welte261af4b2018-02-12 21:20:39 +0100262 g_media.bts1.peer.port_nr := ie.ipa_remote_port;
263 /* optional */
264 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
265 g_media.bts1.rtp_pt := ie.ipa_rtp_pt;
266 }
267 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
268 g_media.bts1.rtp_pt := ie.ipa_rtp_pt2;
269 }
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +0200270 rsl_pt_ho_target.send(ts_RSL_IPA_MDCX_ACK(g_chan_nr, g_media.bts1.conn_id,
Vadim Yanitskiyfc631642021-07-03 02:42:45 +0200271 f_inet_addr(g_media.bts1.peer.host),
Harald Welte261af4b2018-02-12 21:20:39 +0100272 g_media.bts1.peer.port_nr,
273 g_media.bts1.rtp_pt));
Philipp Maierc1e95c82018-07-18 16:03:00 +0200274 g_media.bts1.ipa_mdcx_seen := true;
Harald Welte261af4b2018-02-12 21:20:39 +0100275 repeat;
276 }
277
Philipp Maierb2422352018-07-11 10:36:57 +0200278
279}
280
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200281function f_rx_crcx(MgcpCommand mgcp_cmd)
282 runs on MSC_ConnHdlr return template MgcpResponse {
283 var MgcpOsmuxCID osmux_cid;
284 var SDP_Message sdp;
285 var integer cid := f_get_free_mgcp_conn();
Philipp Maiera2083892020-09-21 14:18:36 +0200286 var charstring local_rtp_addr;
287
288 if (g_pars.media_mgw_offer_ipv6 == true) {
289 local_rtp_addr := host_mgw_rtp_v6; /* Use IPv6 by default if no remote addr is provided by client */
290 } else {
291 local_rtp_addr := host_mgw_rtp_v4; /* Use IPv4 by default if no remote addr is provided by client */
292 }
293
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200294 if (match(mgcp_cmd.line.ep, t_MGCP_EP_wildcard)) {
295 if (cid != 0) {
296 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "MGCP wildcard EP only works in first CRCX");
297 }
298 /* we keep the endpoint name allocated during MediaState_init */
299 } else {
300 /* Call Agent allocated endpoint, trust/use it always */
301 g_media.mgcp_ep := mgcp_cmd.line.ep;
302 }
303 if (isvalue(mgcp_cmd.sdp)) {
304 sdp := mgcp_cmd.sdp;
305 g_media.mgcp_conn[cid].peer.host := sdp.connection.conn_addr.addr;
306 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 +0200307 if (sdp.connection.addr_type == "IP6") {
308 local_rtp_addr := host_mgw_rtp_v6;
309 } else {
310 local_rtp_addr := host_mgw_rtp_v4;
311 }
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200312 }
313 var MgcpConnState mgcp_conn := g_media.mgcp_conn[cid];
Pau Espin Pedrol07866632020-09-03 19:10:55 +0200314 sdp := valueof(ts_SDP(mgcp_conn.mgw.host, local_rtp_addr, "foo", "21",
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200315 mgcp_conn.mgw.port_nr, { int2str(mgcp_conn.rtp_pt) },
316 {valueof(ts_SDP_rtpmap(mgcp_conn.rtp_pt,
317 mgcp_conn.mime_type & "/" &
318 int2str(mgcp_conn.sample_rate))),
319 valueof(ts_SDP_ptime(mgcp_conn.ptime)) } ));
320 var template MgcpResponse mgcp_resp;
321 if (g_pars.use_osmux and f_MgcpCmd_contains_par(mgcp_cmd, "X-OSMUX")) {
322 osmux_cid := f_MgcpCmd_extract_osmux_cid(mgcp_cmd);
323 mgcp_resp := ts_CRCX_ACK_osmux(mgcp_cmd.line.trans_id, mgcp_conn.conn_id, osmux_cid, sdp);
324 } else {
325 mgcp_resp := ts_CRCX_ACK(mgcp_cmd.line.trans_id, mgcp_conn.conn_id, sdp);
326 }
327 f_mgcp_par_append(mgcp_resp.params, ts_MgcpParSpecEP(g_media.mgcp_ep));
328 g_media.mgcp_conn[cid].crcx_seen := g_media.mgcp_conn[cid].crcx_seen + 1;
329 return mgcp_resp;
330}
331
332function f_rx_mdcx(MgcpCommand mgcp_cmd)
333 runs on MSC_ConnHdlr return template MgcpResponse {
334 var SDP_Message sdp;
335 var integer cid := f_get_mgcp_conn(f_MgcpCmd_extract_conn_id(mgcp_cmd));
Pau Espin Pedrol07866632020-09-03 19:10:55 +0200336 var charstring local_rtp_addr;
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200337 if (isvalue(mgcp_cmd.sdp)) {
338 sdp := mgcp_cmd.sdp;
339 g_media.mgcp_conn[cid].peer.host := sdp.connection.conn_addr.addr;
340 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 +0200341 if (sdp.connection.addr_type == "IP6") {
342 local_rtp_addr := host_mgw_rtp_v6;
343 } else {
344 local_rtp_addr := host_mgw_rtp_v4;
345 }
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200346 } else {
347 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "MDCX has no [recognizable] SDP");
348 }
349 var MgcpConnState mgcp_conn := g_media.mgcp_conn[cid];
Pau Espin Pedrol07866632020-09-03 19:10:55 +0200350 sdp := valueof(ts_SDP(mgcp_conn.peer.host, local_rtp_addr, "foo", "21",
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200351 mgcp_conn.peer.port_nr, { int2str(mgcp_conn.rtp_pt) },
352 {valueof(ts_SDP_rtpmap(mgcp_conn.rtp_pt,
353 mgcp_conn.mime_type & "/" &
354 int2str(mgcp_conn.sample_rate))),
355 valueof(ts_SDP_ptime(mgcp_conn.ptime)) } ));
356 g_media.mgcp_conn[cid].mdcx_seen := g_media.mgcp_conn[cid].mdcx_seen + 1;
357 return ts_MDCX_ACK(mgcp_cmd.line.trans_id, mgcp_conn.conn_id, sdp);
358}
359
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200360function tr_MGCP_RecvFrom_any(template MgcpMessage msg)
361runs on MSC_ConnHdlr return template MGCP_RecvFrom {
362 var template MGCP_RecvFrom mrf := {
363 connId := ?,
364 remName := ?,
365 remPort := ?,
366 locName := ?,
367 locPort := ?,
368 msg := msg
369 }
370 return mrf;
371}
372
Philipp Maierb2422352018-07-11 10:36:57 +0200373/* altstep for handling of MGCP media related commands. Activated by as_Media() to test
374 * MGW level media handling */
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200375
Philipp Maierc1e95c82018-07-18 16:03:00 +0200376altstep as_Media_mgw(boolean norepeat := false) runs on MSC_ConnHdlr {
Philipp Maierb2422352018-07-11 10:36:57 +0200377 var MgcpCommand mgcp_cmd;
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200378 var template MgcpResponse mgcp_resp;
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200379 var MGCP_RecvFrom mrf;
380 var template MgcpMessage msg_crcx := {
381 command := tr_CRCX
382 }
383 var template MgcpMessage msg_mdcx := {
384 command := tr_MDCX
385 }
386 var template MgcpMessage msg_resp;
Philipp Maierb2422352018-07-11 10:36:57 +0200387
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200388 [g_pars.aoip] MGCP.receive(tr_CRCX) -> value mgcp_cmd {
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200389 mgcp_resp := f_rx_crcx(mgcp_cmd);
Harald Welte363cb0a2018-01-30 19:35:53 +0100390 MGCP.send(mgcp_resp);
Philipp Maierc1e95c82018-07-18 16:03:00 +0200391 if(norepeat == false) {
392 repeat;
393 }
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200394 }
395
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200396 [not g_pars.aoip] MGCP_MULTI.receive(tr_MGCP_RecvFrom_any(msg_crcx)) -> value mrf {
397 mgcp_resp := f_rx_crcx(mrf.msg.command);
398 msg_resp := {
399 response := mgcp_resp
400 }
401 MGCP_MULTI.send(t_MGCP_SendToMrf(mrf, msg_resp));
402 if(norepeat == false) {
403 repeat;
404 }
405 }
406
407 [g_pars.aoip] MGCP.receive(tr_MDCX) -> value mgcp_cmd {
Pau Espin Pedrol513b8312019-06-18 17:37:36 +0200408 mgcp_resp := f_rx_mdcx(mgcp_cmd);
409 MGCP.send(mgcp_resp);
Philipp Maierc1e95c82018-07-18 16:03:00 +0200410 if(norepeat == false) {
411 repeat;
412 }
Harald Welte211219e2018-01-29 22:03:36 +0100413 }
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200414
415 [not g_pars.aoip] MGCP_MULTI.receive(tr_MGCP_RecvFrom_any(msg_mdcx)) -> value mrf {
416 mgcp_resp := f_rx_mdcx(mrf.msg.command);
417 msg_resp := {
418 response := mgcp_resp
419 }
420 MGCP_MULTI.send(t_MGCP_SendToMrf(mrf, msg_resp));
421 if(norepeat == false) {
422 repeat;
423 }
424 }
Harald Welte211219e2018-01-29 22:03:36 +0100425}
426
Philipp Maierb2422352018-07-11 10:36:57 +0200427/* Altsteps for handling of media related commands. Can be activated by a given
428 * test case if it expects to see media related handling (i.e. voice calls) */
429altstep as_Media() runs on MSC_ConnHdlr {
430 [] as_Media_ipacc();
431 [] as_Media_mgw();
432}
Harald Welte211219e2018-01-29 22:03:36 +0100433
Neels Hofmeyrd36a82f2021-07-20 22:10:49 +0200434type port Coord_PT message
435{
436 inout charstring;
437} with { extension "internal" };
438
Harald Welte28d943e2017-11-25 15:00:50 +0100439/* this component represents a single subscriber connection at the MSC.
Harald Welte6811d102019-04-14 22:23:14 +0200440 * There is a 1:1 mapping between SCCP connections and RAN_ConnHdlr components.
441 * We inherit all component variables, ports, functions, ... from RAN_ConnHdlr */
Harald Welte47cd0e32020-08-21 12:39:11 +0200442type component MSC_ConnHdlr extends RAN_ConnHdlr, RSL_DchanHdlr, MGCP_ConnHdlr, BSSAP_LE_ConnHdlr, StatsD_ConnHdlr {
Harald Welte28d943e2017-11-25 15:00:50 +0100443 /* SCCP Connecction Identifier for the underlying SCCP connection */
444 var integer g_sccp_conn_id;
445
Harald Welte6811d102019-04-14 22:23:14 +0200446 /* procedure port back to our parent (RAN_Emulation_CT) for control */
447 port RAN_PROC_PT RAN;
Harald Weltec20b1c42018-02-12 20:50:08 +0100448 port TELNETasp_PT BSCVTY;
Neels Hofmeyrd36a82f2021-07-20 22:10:49 +0200449 port Coord_PT COORD;
Vadim Yanitskiy5f14d342022-02-07 14:18:38 +0600450 port Coord_PT COORD2;
Harald Welte28d943e2017-11-25 15:00:50 +0100451
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200452 /* Proxy MGCP-over-IPA and MGCP-over-UDP */
453 port IPA_MGCP_PT MGCP_MSC_CLIENT;
454 var integer g_trans_id := 0;
455
Harald Welte211219e2018-01-29 22:03:36 +0100456 var MediaState g_media;
Harald Weltea0630032018-03-20 21:09:55 +0100457 var TestHdlrParams g_pars;
Harald Weltee97eab42018-03-21 18:46:06 +0100458
Pau Espin Pedrol392963f2019-06-18 17:17:19 +0200459 var charstring host_bts := "127.0.0.2";
Pau Espin Pedrol07866632020-09-03 19:10:55 +0200460 var charstring host_mgw_mgcp := "127.0.0.3";
461 var charstring host_mgw_rtp_v4 := "127.0.0.5";
462 var charstring host_mgw_rtp_v6 := "::1";
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200463 var charstring host_msc := "127.0.0.4";
464
Harald Weltee97eab42018-03-21 18:46:06 +0100465 var boolean g_vty_initialized := false;
Harald Welte211219e2018-01-29 22:03:36 +0100466}
467
Harald Welteeddf0e92020-06-21 19:42:15 +0200468function f_MscConnHdlr_init_vty() runs on MSC_ConnHdlr {
Harald Weltee97eab42018-03-21 18:46:06 +0100469 if (not g_vty_initialized) {
470 map(self:BSCVTY, system:BSCVTY);
471 f_vty_set_prompts(BSCVTY);
472 f_vty_transceive(BSCVTY, "enable");
473 g_vty_initialized := true;
474 }
Harald Welte28d943e2017-11-25 15:00:50 +0100475}
476
Harald Welteeddf0e92020-06-21 19:42:15 +0200477/* initialize all parameters */
478function f_MscConnHdlr_init(integer i, HostName bts, HostName mgw, BSSMAP_FIELD_CodecType codecType) runs on MSC_ConnHdlr {
479 f_MediaState_init(g_media, i, bts, mgw, codecType);
480 f_MscConnHdlr_init_vty();
481}
482
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +0200483private function get_next_trans_id() runs on MSC_ConnHdlr return MgcpTransId {
484 var MgcpTransId tid := int2str(g_trans_id);
485 g_trans_id := g_trans_id + 1;
486 return tid;
487}
488
Harald Welte6811d102019-04-14 22:23:14 +0200489/* Callback function from general RAN_Emulation whenever a connectionless
Harald Welte28d943e2017-11-25 15:00:50 +0100490 * BSSMAP message arrives. Can retunr a PDU_BSSAP that should be sent in return */
491private function UnitdataCallback(PDU_BSSAP bssap)
Harald Welte6811d102019-04-14 22:23:14 +0200492runs on RAN_Emulation_CT return template PDU_BSSAP {
Harald Welte28d943e2017-11-25 15:00:50 +0100493 var template PDU_BSSAP resp := omit;
Pau Espin Pedrol95549182019-06-06 16:17:30 +0200494 var boolean append_osmux_support := g_ran_ops.use_osmux and
495 (g_ran_ops.transport == BSSAP_TRANSPORT_AoIP);
Harald Welte28d943e2017-11-25 15:00:50 +0100496
Harald Weltec1a2fff2017-12-17 11:06:19 +0100497 /* answer all RESET with a RESET ACK */
Pau Espin Pedrol95549182019-06-06 16:17:30 +0200498 if (match(bssap, tr_BSSMAP_Reset(append_osmux_support))) {
499 resp := ts_BSSMAP_ResetAck(append_osmux_support);
Harald Welte28d943e2017-11-25 15:00:50 +0100500 }
501
502 return resp;
503}
504
Harald Welte47cd0e32020-08-21 12:39:11 +0200505/* Callback function from general BSSAP_LE_Emulation whenever a connectionless
506 * BSSAP_LE message arrives. Can return a PDU_BSSAP_LE that should be sent in return */
507private function BSSAP_LE_UnitdataCallback(PDU_BSSAP_LE bssap)
508runs on BSSAP_LE_Emulation_CT return template PDU_BSSAP_LE {
509 var template PDU_BSSAP_LE resp := omit;
510
511 /* answer all RESET with a RESET ACK */
512 if (match(bssap, tr_BSSMAP_LE_Reset)) {
513 resp := ts_BSSMAP_LE_ResetAck;
514 }
515
516 return resp;
517}
518
Harald Welte6811d102019-04-14 22:23:14 +0200519const RanOps MSC_RanOps := {
520 create_cb := refers(RAN_Emulation.ExpectedCreateCallback),
Harald Welte0b476062018-01-21 19:07:32 +0100521 unitdata_cb := refers(UnitdataCallback),
522 decode_dtap := false,
Harald Welte930d0a72018-03-22 22:08:40 +0100523 role_ms := false,
Harald Welte2fce7882019-04-15 11:48:05 +0200524 protocol := RAN_PROTOCOL_BSSAP,
Pau Espin Pedrolc6b78ff2019-06-06 15:58:17 +0200525 transport := BSSAP_TRANSPORT_AoIP,
Pau Espin Pedrolc6a53db2019-05-20 19:31:47 +0200526 use_osmux := false,
Harald Welte930d0a72018-03-22 22:08:40 +0100527 sccp_addr_local := omit,
528 sccp_addr_peer := omit
Harald Welte28d943e2017-11-25 15:00:50 +0100529}
530
Harald Welte47cd0e32020-08-21 12:39:11 +0200531const BssapLeOps SMLC_BssapLeOps := {
532 create_cb := refers(BSSAP_LE_Emulation.ExpectedCreateCallback),
533 unitdata_cb := refers(BSSAP_LE_UnitdataCallback),
534 decode_dtap := false,
535 role_ms := false,
536 sccp_addr_local := omit,
537 sccp_addr_peer := omit
538}
539
Daniel Willmann191e0d92018-01-17 12:44:35 +0100540const MGCPOps MSC_MGCPOps := {
Harald Welte930d0a72018-03-22 22:08:40 +0100541 create_cb := refers(MGCP_Emulation.ExpectedCreateCallback),
542 unitdata_cb := refers(MGCP_Emulation.DummyUnitdataCallback)
Daniel Willmann191e0d92018-01-17 12:44:35 +0100543}
544
Harald Weltec1a2fff2017-12-17 11:06:19 +0100545/* register an expect with the BSSMAP core */
Neels Hofmeyr4f118412020-06-04 15:25:10 +0200546function f_create_bssmap_exp(octetstring l3_enc) runs on MSC_ConnHdlr {
Harald Welte6811d102019-04-14 22:23:14 +0200547 RAN.call(RAN_register:{l3_enc, self}) {
548 [] RAN.getreply(RAN_register:{?, ?}) {};
Harald Welte28d943e2017-11-25 15:00:50 +0100549 }
550}
551
Harald Welte651fcdc2018-05-10 20:23:16 +0200552type record TestHdlrEncrParams {
Neels Hofmeyrd23e8a02022-02-17 01:55:59 +0100553 /* A mask of multiple encryption algorithms, for Encryption Information IE. */
554 OCT1 enc_alg_permitted,
555 /* Expect this encryption algorithm in Channel Activation from the BSC.
556 * To expect no encryption, set to '01'O == A5/0. */
557 OCT1 enc_alg_expect,
558 /* In BSSMAP, the Chosen Encryption Algorithm IE that the test sends to the BSC.
559 * When set to omit, the MSC will not send a Chosen Encryption Algorithm IE. */
560 OCT1 enc_alg_chosen optional,
Neels Hofmeyr6c388f22021-06-11 02:36:56 +0200561 octetstring enc_key,
562 octetstring enc_kc128 optional
Harald Welte651fcdc2018-05-10 20:23:16 +0200563};
564
Neels Hofmeyrd23e8a02022-02-17 01:55:59 +0100565template (value) TestHdlrEncrParams t_EncrParams(OCT1 alg_permitted,
566 octetstring key, template (omit) octetstring kc128 := omit) := {
567 enc_alg_permitted := alg_permitted,
568 enc_alg_expect := alg_permitted, /* <- for compat with tests before enc_alg_expect was added */
569 enc_alg_chosen := alg_permitted, /* <- for compat with tests before enc_alg_chosen was added */
Neels Hofmeyr6c388f22021-06-11 02:36:56 +0200570 enc_key := key,
571 enc_kc128 := kc128
Harald Welte651fcdc2018-05-10 20:23:16 +0200572}
573
Neels Hofmeyrd23e8a02022-02-17 01:55:59 +0100574template (value) TestHdlrEncrParams t_EncrParams2(OCT1 alg_permitted,
575 OCT1 alg_expect,
576 template(omit) OCT1 alg_chosen,
577 octetstring key,
578 template (omit) octetstring kc128 := omit) := {
579 enc_alg_permitted := alg_permitted,
580 enc_alg_expect := alg_expect,
581 enc_alg_chosen := alg_chosen,
582 enc_key := key,
583 enc_kc128 := kc128
584}
585
586/* Convenience for common t_EncrParams2 usage.
587 *
588 * To test a scenario where only A5/3 is permitted:
589 * f_encr_params('08'O);
590 * To test a scenario where A5/3 is chosen from A5/0,A5/1,A5/3 (1 | 2 | 8 = 11 = 0xb):
591 * f_encr_params('0b'O, '08'O);
592 * To test the same, but the Chosen Encryption Algorithm IE should reflect A5/1:
593 * f_encr_params('0b'O, '08'O, '02'O);
594 * To test the same, but the MSC sends no Chosen Encryption Algorithm IE:
595 * f_encr_params('0b'O, '08'O, omit);
596 *
597 * Set alg_chosen and alg_expect magically when == '00'O:
598 * - enc_alg_expect is set to alg_chosen if present, else to alg_permitted.
599 * - enc_alg_chosen is set to alg_permitted.
600 * When only alg_permitted is given, alg_permitted must reflect only one algorithm, or f_cipher_mode_bssmap_to_rsl()
601 * will fail.
602 * When alg_chosen is passed as omit, the messages from the MSC will not contain a Chosen Encryption Algorithm IE.
603 */
604function f_encr_params(OCT1 alg_permitted, OCT1 alg_expect := '00'O, template (omit) OCT1 alg_chosen := '00'O,
605 boolean kc128 := false)
606 return TestHdlrEncrParams
607{
608 if (not istemplatekind(alg_chosen, "omit")) {
609 if (valueof(alg_chosen) == '00'O) {
610 if (alg_expect != '00'O) {
611 alg_chosen := alg_expect;
612 } else {
613 /* In this case, alg_permitted should have only one permitted algo */
614 alg_chosen := alg_permitted;
615 }
616 }
617 if (alg_expect == '00'O) {
618 alg_expect := valueof(alg_chosen);
619 }
620 }
621 if (alg_expect == '00'O) {
622 /* In this case, alg_permitted should have only one permitted algo */
623 alg_expect := valueof(alg_permitted);
624 }
625 var template octetstring kc := omit;
626 if (kc128) {
627 kc := f_rnd_octstring(16);
628 }
629 return valueof(t_EncrParams2(alg_permitted, alg_expect, alg_chosen, f_rnd_octstring(8), kc));
630}
631
Harald Weltecc0b0142018-05-29 15:19:33 +0200632type record TestHdlrParamsLcls {
633 GlobalCallReferenceValue gcr optional,
634 /* LCLS Configuration */
635 BIT4 cfg optional,
636 /* LCLS Connection Status Control */
637 BIT4 csc optional,
Max2eeb5112018-11-06 19:21:41 +0100638 BIT4 exp_sts optional,
639 /* Whether to adjust *cx_seen_exp for LCLS tests */
640 boolean adjust_cx_exp
Harald Weltecc0b0142018-05-29 15:19:33 +0200641}
642
Neels Hofmeyrf246a922020-05-13 02:27:10 +0200643type record TestHdlrParamsMSCPool {
Neels Hofmeyr4f118412020-06-04 15:25:10 +0200644 integer bssap_idx,
Neels Hofmeyr4f118412020-06-04 15:25:10 +0200645 integer rsl_idx,
646 PDU_ML3_MS_NW l3_info optional
Neels Hofmeyrf246a922020-05-13 02:27:10 +0200647}
648
Harald Weltec1a2fff2017-12-17 11:06:19 +0100649type record TestHdlrParams {
650 OCT1 ra,
651 GsmFrameNumber fn,
652 hexstring imsi,
Harald Welte60aa5762018-03-21 19:33:13 +0100653 RslLinkId link_id,
Harald Weltecbe911c2018-06-01 18:23:07 +0200654 integer media_nr, /* determins MGCP EP, port numbers */
Harald Welte651fcdc2018-05-10 20:23:16 +0200655 BSSMAP_IE_SpeechCodecList ass_codec_list optional,
Neels Hofmeyrbcf62bc2018-07-04 00:24:33 +0200656 RSL_IE_Body expect_mr_conf_ie optional, /* typically present for AMR codecs */
Philipp Maierd0e64b02019-03-13 14:15:23 +0100657 bitstring expect_mr_s0_s7 optional, /* typically present for AMR codecs */
Harald Weltecc0b0142018-05-29 15:19:33 +0200658 TestHdlrEncrParams encr optional,
Neels Hofmeyrbd0ef932018-03-19 14:58:46 +0100659 TestHdlrParamsLcls lcls,
Neels Hofmeyr90f80962020-06-12 16:16:55 +0200660 SCCP_PAR_Address sccp_addr_msc optional,
661 SCCP_PAR_Address sccp_addr_bsc optional,
Pau Espin Pedrolf7630a62019-10-28 15:07:08 +0100662 uint5_t exp_ms_power_level,
Pau Espin Pedrol8f773632019-11-05 11:46:53 +0100663 boolean exp_ms_power_params,
Pau Espin Pedrolc6a53db2019-05-20 19:31:47 +0200664 boolean aoip,
Neels Hofmeyrf246a922020-05-13 02:27:10 +0200665 boolean use_osmux,
Pau Espin Pedrol07866632020-09-03 19:10:55 +0200666 charstring host_aoip_tla,
Philipp Maiera2083892020-09-21 14:18:36 +0200667 TestHdlrParamsMSCPool mscpool,
Pau Espin Pedrolc08d5522021-04-16 15:40:38 +0200668 boolean media_mgw_offer_ipv6,
Neels Hofmeyr559d5d02021-04-16 16:50:49 +0200669 OCT3 last_used_eutran_plmn optional,
Pau Espin Pedrol9ae36d52021-06-15 17:29:43 +0200670 boolean exp_fast_return, /* RR Release expected to contain CellSelectInd ? */
Neels Hofmeyrb5b7a6e2021-06-04 19:03:45 +0200671 boolean expect_channel_mode_modify,
Pau Espin Pedrola8ef3be2022-02-16 16:21:17 +0100672 uint3_t expect_tsc optional,
673 BSSMAP_IE_CellIdentifier cell_id_source
Harald Weltec1a2fff2017-12-17 11:06:19 +0100674};
675
Philipp Maier48604732018-10-09 15:00:37 +0200676/* Note: Do not use valueof() to get a value of this template, use
677 * f_gen_test_hdlr_pars() instead in order to get a configuration that is
Pau Espin Pedrol8df10112020-01-09 18:21:53 +0100678 * matched to the current test situation (aoip vs. sccplite) */
Harald Weltec1a2fff2017-12-17 11:06:19 +0100679template (value) TestHdlrParams t_def_TestHdlrPars := {
680 ra := '23'O,
681 fn := 23,
682 imsi := '001019876543210'H,
Harald Welte60aa5762018-03-21 19:33:13 +0100683 link_id := valueof(ts_RslLinkID_DCCH(0)),
Harald Weltecbe911c2018-06-01 18:23:07 +0200684 media_nr := 1,
Harald Welte651fcdc2018-05-10 20:23:16 +0200685 ass_codec_list := omit,
Neels Hofmeyrbcf62bc2018-07-04 00:24:33 +0200686 expect_mr_conf_ie := omit,
Philipp Maierd0e64b02019-03-13 14:15:23 +0100687 expect_mr_s0_s7 := omit,
Harald Weltecc0b0142018-05-29 15:19:33 +0200688 encr := omit,
689 lcls := {
690 gcr := omit,
691 cfg := omit,
692 csc := omit,
Max2eeb5112018-11-06 19:21:41 +0100693 exp_sts := omit,
694 adjust_cx_exp := true
Neels Hofmeyrbd0ef932018-03-19 14:58:46 +0100695 },
Neels Hofmeyr90f80962020-06-12 16:16:55 +0200696 sccp_addr_msc := omit,
697 sccp_addr_bsc := omit,
Pau Espin Pedrolf7630a62019-10-28 15:07:08 +0100698 exp_ms_power_level := 7, /* calculated from osmo-bsc.cfg "ms max power" */
Pau Espin Pedrol8f773632019-11-05 11:46:53 +0100699 exp_ms_power_params := false,
Pau Espin Pedrolc6a53db2019-05-20 19:31:47 +0200700 aoip := true,
Neels Hofmeyrf246a922020-05-13 02:27:10 +0200701 use_osmux := false,
Pau Espin Pedrol07866632020-09-03 19:10:55 +0200702 host_aoip_tla := "1.2.3.4",
Neels Hofmeyrf246a922020-05-13 02:27:10 +0200703 mscpool := {
Neels Hofmeyr4f118412020-06-04 15:25:10 +0200704 bssap_idx := 0,
Neels Hofmeyr4f118412020-06-04 15:25:10 +0200705 rsl_idx := 0,
706 l3_info := omit
Philipp Maiera2083892020-09-21 14:18:36 +0200707 },
Pau Espin Pedrolc08d5522021-04-16 15:40:38 +0200708 media_mgw_offer_ipv6 := true,
Neels Hofmeyr559d5d02021-04-16 16:50:49 +0200709 last_used_eutran_plmn := omit,
Pau Espin Pedrol9ae36d52021-06-15 17:29:43 +0200710 exp_fast_return := false,
Neels Hofmeyrb5b7a6e2021-06-04 19:03:45 +0200711 expect_channel_mode_modify := false,
Pau Espin Pedrola8ef3be2022-02-16 16:21:17 +0100712 expect_tsc := omit,
713 cell_id_source := valueof(ts_CellID_LAC_CI(1, 1))
Harald Weltec1a2fff2017-12-17 11:06:19 +0100714}
715
Vadim Yanitskiya7fc5a62021-12-04 20:10:08 +0300716function f_create_chan_and_exp(template (present) PDU_BSSAP exp_l3_compl := ?)
717runs on MSC_ConnHdlr {
Harald Weltea0630032018-03-20 21:09:55 +0100718 var MobileIdentityLV mi := valueof(ts_MI_IMSI_LV(g_pars.imsi));
Harald Welte6ed6bf92018-01-24 21:09:15 +0100719 var PDU_ML3_MS_NW l3_info := valueof(ts_CM_SERV_REQ(CM_TYPE_MO_CALL, mi));
Harald Weltec1a2fff2017-12-17 11:06:19 +0100720 var octetstring l3_enc := enc_PDU_ML3_MS_NW(l3_info);
Neels Hofmeyrb5b7a6e2021-06-04 19:03:45 +0200721 var template uint3_t tsc := ?;
Vadim Yanitskiya7fc5a62021-12-04 20:10:08 +0300722 timer T;
Neels Hofmeyrb5b7a6e2021-06-04 19:03:45 +0200723
724 if (not istemplatekind(g_pars.expect_tsc, "omit")) {
725 tsc := g_pars.expect_tsc;
726 }
Harald Weltec1a2fff2017-12-17 11:06:19 +0100727
Vadim Yanitskiya7fc5a62021-12-04 20:10:08 +0300728 if (istemplatekind(exp_l3_compl, "?")) {
729 if (g_pars.aoip == false) {
730 exp_l3_compl := tr_BSSMAP_ComplL3(l3_enc, codec_list := omit);
731 } else {
732 exp_l3_compl := tr_BSSMAP_ComplL3(l3_enc, codec_list := ?);
733 }
734 }
735
Neels Hofmeyrd601f9c2021-06-04 22:46:06 +0200736 f_create_bssmap_exp(l3_enc);
Harald Weltec1a2fff2017-12-17 11:06:19 +0100737 /* call helper function for CHAN_RQD -> IMM ASS ->EST_IND */
Neels Hofmeyrb5b7a6e2021-06-04 19:03:45 +0200738 RSL_Emulation.f_chan_est(g_pars.ra, l3_enc, g_pars.link_id, g_pars.fn, tsc);
Vadim Yanitskiya7fc5a62021-12-04 20:10:08 +0300739 /* wait for a COMPL_L3 from the BSC to ensure that the SCCP connection is up */
740 T.start(2.0);
741 alt {
742 [] BSSAP.receive(exp_l3_compl);
743 [] BSSAP.receive(tr_BSSMAP_ComplL3) {
744 setverdict(fail, "Received non-matching COMPLETE LAYER 3 INFORMATION");
745 Misc_Helpers.f_shutdown(__BFILE__, __LINE__);
746 }
747 [] T.timeout {
748 setverdict(fail, "Timeout waiting for COMPLETE LAYER 3 INFORMATION");
749 Misc_Helpers.f_shutdown(__BFILE__, __LINE__);
750 }
751 }
Harald Weltec1a2fff2017-12-17 11:06:19 +0100752}
753
Harald Welte898113b2018-01-31 18:32:21 +0100754function f_rsl_send_l3(template PDU_ML3_MS_NW l3, template (omit) RslLinkId link_id := omit,
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +0200755 template (omit) RslChannelNr chan_nr := omit, RSL_DCHAN_PT rsl_pt := RSL) runs on MSC_ConnHdlr {
Harald Welte898113b2018-01-31 18:32:21 +0100756 if (not isvalue(link_id)) {
757 link_id := ts_RslLinkID_DCCH(0);
758 }
759 if (not isvalue(chan_nr)) {
760 chan_nr := g_chan_nr;
761 }
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +0200762 rsl_pt.send(ts_RSL_DATA_IND(valueof(chan_nr), valueof(link_id), enc_PDU_ML3_MS_NW(valueof(l3))));
Harald Welte898113b2018-01-31 18:32:21 +0100763}
764
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +0200765function f_rsl_reply(template PDU_ML3_MS_NW l3, RSL_Message orig, RSL_DCHAN_PT rsl_pt := RSL) runs on MSC_ConnHdlr {
Harald Weltec1a2fff2017-12-17 11:06:19 +0100766 var RslChannelNr chan_nr := orig.ies[0].body.chan_nr;
Harald Welte1a40de62017-12-23 02:28:34 +0100767 var RslLinkId link_id;
Harald Welte8d5eead2017-12-17 18:56:45 +0100768 if (orig.msg_type == RSL_MT_ENCR_CMD) {
769 link_id := orig.ies[2].body.link_id;
770 } else {
771 link_id := orig.ies[1].body.link_id;
772 }
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +0200773 f_rsl_send_l3(l3, link_id, chan_nr, rsl_pt := rsl_pt);
Harald Weltec1a2fff2017-12-17 11:06:19 +0100774}
775
Oliver Smith598e1ed2021-07-09 10:28:40 +0200776/* Convert the cipher representation on BSSMAP to the representation used on RSL */
777function f_cipher_mode_bssmap_to_rsl(OCT1 alg_bssmap) return RSL_AlgId
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100778{
779 /* A5 0 */
780 if (alg_bssmap == '01'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200781 return RSL_ALG_ID_A5_0;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100782 }
783 /* A5 1 */
784 else if (alg_bssmap == '02'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200785 return RSL_ALG_ID_A5_1;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100786 }
787 /* A5 2 */
788 else if (alg_bssmap == '04'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200789 return RSL_ALG_ID_A5_2;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100790 }
791 /* A5 3 */
792 else if (alg_bssmap == '08'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200793 return RSL_ALG_ID_A5_3;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100794 }
795 /* A5 4 */
796 else if (alg_bssmap == '10'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200797 return RSL_ALG_ID_A5_4;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100798 }
799 /* A5 5 */
800 else if (alg_bssmap == '20'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200801 return RSL_ALG_ID_A5_5;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100802 }
803 /* A5 6 */
804 else if (alg_bssmap == '40'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200805 return RSL_ALG_ID_A5_6;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100806 }
807 /* A5 7 */
808 else if (alg_bssmap == '80'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200809 return RSL_ALG_ID_A5_7;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100810 } else {
Neels Hofmeyrd23e8a02022-02-17 01:55:59 +0100811 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Unexpected Encryption Algorithm: " &
812 oct2str(alg_bssmap));
Harald Weltee613f962018-04-18 22:38:16 +0200813 return RSL_ALG_ID_A5_0;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100814 }
815}
816
Neels Hofmeyr58ffceb2021-06-21 02:17:30 +0200817function f_verify_encr_info(RSL_Message rsl) runs on MSC_ConnHdlr {
818 var RSL_IE_Body encr_info;
819 var RSL_AlgId alg_rsl;
820 var template octetstring expect_kc;
821
822 /* If no encryption is enabled, then make sure there is no RSL_IE_ENCR_INFO */
823 if (not ispresent(g_pars.encr)) {
824 if (f_rsl_find_ie(rsl, RSL_IE_ENCR_INFO, encr_info)) {
825 setverdict(fail, "Found Encryption IE, but expected no encryption in ", rsl.msg_type);
826 Misc_Helpers.f_shutdown(__BFILE__, __LINE__);
827 return;
828 }
829 setverdict(pass);
830 return;
831 }
832
833 /* RSL uses a different representation of the encryption algorithm,
834 * so we need to convert first */
Neels Hofmeyrd23e8a02022-02-17 01:55:59 +0100835 alg_rsl := f_cipher_mode_bssmap_to_rsl(g_pars.encr.enc_alg_expect);
Neels Hofmeyr58ffceb2021-06-21 02:17:30 +0200836
837 if (alg_rsl == RSL_ALG_ID_A5_4 and ispresent(g_pars.encr.enc_kc128)) {
838 expect_kc := g_pars.encr.enc_kc128;
839 } else if (alg_rsl == RSL_ALG_ID_A5_0) {
840 /* When A5/0 is chosen, no encryption is active, so technically, no key is needed. However, 3GPP TS
841 * 48.058 9.3.7 Encryption Information stays quite silent about presence or absence of a key for A5/0.
842 * The only thing specified is how to indicate the length of the key; the possibility that the key may
843 * be zero length is not explicitly mentioned. So it seems that we should always send the key along,
844 * even for A5/0. Still, let's also allow a zero length key for A5/0. */
845 expect_kc := (g_pars.encr.enc_key, ''O);
846 } else {
847 expect_kc := g_pars.encr.enc_key;
848 }
849 log("for encryption algo ", alg_rsl, " expect kc = ", expect_kc);
850
851 if (not f_rsl_find_ie(rsl, RSL_IE_ENCR_INFO, encr_info)) {
852 if (alg_rsl == RSL_ALG_ID_A5_0) {
853 /* For A5/0, encryption is not active. It is fine to omit the Encryption Information in this
854 * case. Note that the first channel may see an RSL Encryption Command with A5/0 indicated, and
855 * a subsequent handover may activate a new channel without any Encryption Information. */
856 setverdict(pass);
857 return;
858 }
859 setverdict(fail, "Missing Encryption Information IE in ", rsl.msg_type);
860 Misc_Helpers.f_shutdown(__BFILE__, __LINE__);
861 return;
862 }
863
864 if (not match(encr_info, tr_EncrInfo(alg_rsl, expect_kc))) {
865 setverdict(fail, "Unexpected Kc in Encryption Information IE in ", rsl.msg_type);
866 Misc_Helpers.f_shutdown(__BFILE__, __LINE__);
867 return;
868 }
869 setverdict(pass);
870}
871
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +0200872function f_cipher_mode(TestHdlrEncrParams enc, boolean exp_fail := false,
873 RSL_DCHAN_PT rsl_pt := RSL, RSLEM_PROC_PT rsl_proc_pt := RSL_PROC)
Harald Welte38b2a102017-12-23 02:42:58 +0100874runs on MSC_ConnHdlr {
Harald Welte73cd2712017-12-17 00:44:52 +0100875 var PDU_BSSAP bssap;
876 var RSL_Message rsl;
877
Neels Hofmeyr6c388f22021-06-11 02:36:56 +0200878 if (isvalue(enc.enc_kc128)) {
Neels Hofmeyrd23e8a02022-02-17 01:55:59 +0100879 BSSAP.send(ts_BSSMAP_CipherModeCmdKc128(enc.enc_alg_permitted, enc.enc_key, valueof(enc.enc_kc128)));
Harald Welte73cd2712017-12-17 00:44:52 +0100880 } else {
Neels Hofmeyrd23e8a02022-02-17 01:55:59 +0100881 BSSAP.send(ts_BSSMAP_CipherModeCmd(enc.enc_alg_permitted, enc.enc_key));
Harald Welte73cd2712017-12-17 00:44:52 +0100882 }
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100883
Harald Welte73cd2712017-12-17 00:44:52 +0100884 alt {
885 /* RSL/UE Side */
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +0200886 [] rsl_pt.receive(tr_RSL_ENCR_CMD(g_chan_nr)) -> value rsl {
Harald Welte73cd2712017-12-17 00:44:52 +0100887 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[3].body.l3_info.payload);
888 log("Rx L3 from net: ", l3);
Neels Hofmeyr72749342021-06-11 02:41:37 +0200889
Neels Hofmeyr58ffceb2021-06-21 02:17:30 +0200890 f_verify_encr_info(rsl);
891
Harald Welte73cd2712017-12-17 00:44:52 +0100892 if (ischosen(l3.msgs.rrm.cipheringModeCommand)) {
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +0200893 f_rsl_reply(ts_RRM_CiphModeCompl, rsl, rsl_pt := rsl_pt);
Harald Welte73cd2712017-12-17 00:44:52 +0100894 }
895 repeat;
896 }
897 [] BSSAP.receive(tr_BSSMAP_CipherModeCompl) -> value bssap {
Harald Welte38b2a102017-12-23 02:42:58 +0100898 if (exp_fail == true) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100899 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Unexpected Cipher Mode Complete");
Harald Welte38b2a102017-12-23 02:42:58 +0100900 } else {
901 setverdict(pass);
Neels Hofmeyrd23e8a02022-02-17 01:55:59 +0100902 var RSL_AlgId alg_rsl := f_cipher_mode_bssmap_to_rsl(g_pars.encr.enc_alg_expect);
Neels Hofmeyr5e31cfc2021-06-11 02:42:11 +0200903 if (oct2int(bssap.pdu.bssmap.cipherModeComplete.chosenEncryptionAlgorithm.algorithmIdentifier) != enum2int(alg_rsl)) {
904 setverdict(fail, "Unexpected Encryption Algorithm ID in BSSMAP Cipher Mode Complete");
905 }
Harald Welte38b2a102017-12-23 02:42:58 +0100906 }
Harald Welte73cd2712017-12-17 00:44:52 +0100907 }
908 [] BSSAP.receive(tr_BSSMAP_CipherModeRej) -> value bssap {
Harald Welte38b2a102017-12-23 02:42:58 +0100909 if (exp_fail == false) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100910 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Ciphering Mode Reject");
Harald Welte38b2a102017-12-23 02:42:58 +0100911 } else {
912 setverdict(pass);
913 }
Harald Welte73cd2712017-12-17 00:44:52 +0100914 }
915 }
916}
917
Harald Welte211219e2018-01-29 22:03:36 +0100918/* Convert from Ericsson ChanDesc2 format to Osmocom RslChannelNr format */
919function f_ChDesc2RslChanNr(ChannelDescription2_V ch_desc, out RslChannelNr chan_nr, out GsmArfcn arfcn) {
920 var BIT5 inp := ch_desc.channelTypeandTDMAOffset;
Harald Welte6fa1f732018-03-21 22:46:16 +0100921 var uint3_t tn := bit2int(ch_desc.timeslotNumber);
Harald Welte211219e2018-01-29 22:03:36 +0100922
Vadim Yanitskiy2bcea3d2021-11-18 19:13:48 +0300923 select (inp) {
924 case ('00001'B) { /* TCH/F */
Harald Welte6fa1f732018-03-21 22:46:16 +0100925 chan_nr := valueof(t_RslChanNr_Bm(tn));
Vadim Yanitskiy2bcea3d2021-11-18 19:13:48 +0300926 }
927 case ('11101'B) { /* VAMOS TCH/F */
Neels Hofmeyr9c3b82f2021-05-27 00:38:59 +0200928 chan_nr := valueof(t_RslChanNr_Osmo_VAMOS_Bm(tn));
Vadim Yanitskiy2bcea3d2021-11-18 19:13:48 +0300929 }
930 case ('0001?'B) { /* TCH/H */
Harald Welte6fa1f732018-03-21 22:46:16 +0100931 chan_nr := valueof(t_RslChanNr_Lm(tn, bit2int(substr(inp, 4, 1))));
Vadim Yanitskiy2bcea3d2021-11-18 19:13:48 +0300932 }
933 case ('1111?'B) { /* VAMOS TCH/H */
Neels Hofmeyr9c3b82f2021-05-27 00:38:59 +0200934 chan_nr := valueof(t_RslChanNr_Osmo_VAMOS_Lm(tn, bit2int(substr(inp, 4, 1))));
Vadim Yanitskiy2bcea3d2021-11-18 19:13:48 +0300935 }
936 case ('001??'B) { /* SDCCH/4 */
Harald Welte6fa1f732018-03-21 22:46:16 +0100937 chan_nr := valueof(t_RslChanNr_SDCCH4(tn, bit2int(substr(inp, 3, 2))));
Vadim Yanitskiy2bcea3d2021-11-18 19:13:48 +0300938 }
939 case ('01???'B) { /* SDCCH/8 */
Harald Welte6fa1f732018-03-21 22:46:16 +0100940 chan_nr := valueof(t_RslChanNr_SDCCH8(tn, bit2int(substr(inp, 2, 3))));
Vadim Yanitskiy2bcea3d2021-11-18 19:13:48 +0300941 }
942 case else {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100943 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Unknown ChDesc!");
Vadim Yanitskiy2bcea3d2021-11-18 19:13:48 +0300944 }
Harald Welte211219e2018-01-29 22:03:36 +0100945 }
946
947 if (ch_desc.octet3 and4b '10'O == '10'O) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +0100948 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "No support for Hopping");
Harald Welte211219e2018-01-29 22:03:36 +0100949 } else {
950 var OCT2 concat := ch_desc.octet3 & ch_desc.octet4;
951 arfcn := oct2int(concat);
952 }
953}
954
955type record AssignmentState {
956 /* global */
957 boolean voice_call,
958 boolean is_assignment,
959 /* Assignment related bits */
960 boolean rr_ass_cmpl_seen,
Neels Hofmeyra5302c82018-11-04 23:09:58 +0100961 boolean old_lchan_deact_sacch_seen,
962 boolean old_lchan_rll_rel_req_seen,
Harald Welte21583082018-01-29 22:28:26 +0100963 boolean assignment_done,
Harald Welte211219e2018-01-29 22:03:36 +0100964 RslChannelNr old_chan_nr,
965 /* Modify related bits */
Neels Hofmeyr559d5d02021-04-16 16:50:49 +0200966 PDU_ML3_NW_MS rr_channel_mode_modify_msg optional,
Harald Welte211219e2018-01-29 22:03:36 +0100967 boolean rr_modify_seen,
Neels Hofmeyr559d5d02021-04-16 16:50:49 +0200968 RSL_Message rsl_mode_modify_msg optional,
Harald Welte21583082018-01-29 22:28:26 +0100969 boolean modify_done
Harald Welte211219e2018-01-29 22:03:36 +0100970}
971
972template (value) AssignmentState ts_AssignmentStateInit := {
973 voice_call := false,
974 is_assignment := false,
975 rr_ass_cmpl_seen := false,
Neels Hofmeyra5302c82018-11-04 23:09:58 +0100976 old_lchan_deact_sacch_seen := false,
977 old_lchan_rll_rel_req_seen := false,
Harald Welte21583082018-01-29 22:28:26 +0100978 assignment_done := false,
Harald Welte211219e2018-01-29 22:03:36 +0100979 old_chan_nr := -,
Neels Hofmeyr559d5d02021-04-16 16:50:49 +0200980 rr_channel_mode_modify_msg := omit,
Harald Welte211219e2018-01-29 22:03:36 +0100981 rr_modify_seen := false,
Neels Hofmeyr559d5d02021-04-16 16:50:49 +0200982 rsl_mode_modify_msg := omit,
Harald Welte21583082018-01-29 22:28:26 +0100983 modify_done := false
Harald Welte211219e2018-01-29 22:03:36 +0100984}
985
Harald Welte8a9bf6f2018-05-10 22:00:49 +0200986private template RSL_IE_Body tr_EncrInfo(template RSL_AlgId alg, template octetstring key) := {
987 encr_info := {
988 len := ?,
989 alg_id := alg,
990 key := key
991 }
992}
993
994/* ensure the RSL CHAN ACT (during assignment) contains values we expect depending on test case */
995private function f_check_chan_act(AssignmentState st, RSL_Message chan_act) runs on MSC_ConnHdlr {
996 var RSL_IE_Body encr_info;
Pau Espin Pedrol3d008ae2019-10-28 13:35:46 +0100997 var RSL_IE_Body ms_power_param;
Pau Espin Pedrolf7630a62019-10-28 15:07:08 +0100998 var RSL_IE_Body ms_power;
Pau Espin Pedrol3d008ae2019-10-28 13:35:46 +0100999
Neels Hofmeyrd23e8a02022-02-17 01:55:59 +01001000 if (ispresent(g_pars.encr) and g_pars.encr.enc_alg_permitted != '01'O) {
Harald Welte8a9bf6f2018-05-10 22:00:49 +02001001 if (not f_rsl_find_ie(chan_act, RSL_IE_ENCR_INFO, encr_info)) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001002 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Missing Encryption IE in CHAN ACT");
Harald Welte8a9bf6f2018-05-10 22:00:49 +02001003 } else {
Neels Hofmeyrd23e8a02022-02-17 01:55:59 +01001004 var RSL_AlgId alg := f_cipher_mode_bssmap_to_rsl(g_pars.encr.enc_alg_expect);
Neels Hofmeyr0588cad2021-06-11 01:38:18 +02001005 var octetstring expect_key;
1006 if (alg == RSL_ALG_ID_A5_4) {
1007 expect_key := g_pars.encr.enc_kc128;
1008 } else {
1009 expect_key := g_pars.encr.enc_key;
1010 }
1011 if (not match(encr_info, tr_EncrInfo(alg, expect_key))) {
1012 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
1013 "Unexpected Kc in Encryption IE in RSL ENCR CMD");
Harald Welte8a9bf6f2018-05-10 22:00:49 +02001014 }
1015 }
1016 } else {
1017 if (f_rsl_find_ie(chan_act, RSL_IE_ENCR_INFO, encr_info)) {
1018 if (encr_info.encr_info.alg_id != RSL_ALG_ID_A5_0) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001019 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Unexpected Encryption in CHAN ACT");
Harald Welte8a9bf6f2018-05-10 22:00:49 +02001020 }
1021 }
1022 }
1023 /* 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 +01001024 * RSL_IE_TIMING_ADVANCE */
Pau Espin Pedrol3d008ae2019-10-28 13:35:46 +01001025
Pau Espin Pedrol8f773632019-11-05 11:46:53 +01001026 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 +01001027 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "IE MS Power Parameters not found in CHAN ACT");
1028 }
1029
Pau Espin Pedrolf7630a62019-10-28 15:07:08 +01001030 if (not f_rsl_find_ie(chan_act, RSL_IE_MS_POWER, ms_power)) {
1031 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "IE MS Power not found in CHAN ACT");
1032 } else {
1033 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 +01001034 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 +01001035 }
1036 }
1037
Harald Welte8a9bf6f2018-05-10 22:00:49 +02001038}
1039
Neels Hofmeyr6a955cc2021-10-02 14:53:48 +02001040function rr_chan_desc_tsc(ChannelDescription2_V cd2)
Neels Hofmeyrb5b7a6e2021-06-04 19:03:45 +02001041 return uint3_t
1042{
1043 var uint3_t tsc := oct2int(cd2.octet3);
1044 tsc := tsc / 32; /* shl 5 */
1045 return tsc;
1046}
1047
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +02001048altstep as_assignment(inout AssignmentState st, RSL_DCHAN_PT rsl_pt := RSL, RSLEM_PROC_PT rsl_proc_pt := RSL_PROC) runs on MSC_ConnHdlr {
Harald Weltec1a2fff2017-12-17 11:06:19 +01001049 var RSL_Message rsl;
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +02001050 [not st.rr_ass_cmpl_seen] rsl_pt.receive(tr_RSL_DATA_REQ(g_chan_nr)) -> value rsl {
Harald Welte211219e2018-01-29 22:03:36 +01001051 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[2].body.l3_info.payload);
1052 log("Rx L3 from net: ", l3);
1053 if (ischosen(l3.msgs.rrm.assignmentCommand)) {
1054 var RslChannelNr new_chan_nr;
1055 var GsmArfcn arfcn;
Neels Hofmeyrb5b7a6e2021-06-04 19:03:45 +02001056
1057 if (not istemplatekind(g_pars.expect_tsc, "omit")) {
1058 var uint3_t got_tsc := rr_chan_desc_tsc(l3.msgs.rrm.assignmentCommand.descrOf1stChAfterTime);
1059 if (not match(got_tsc, g_pars.expect_tsc)) {
1060 setverdict(fail, "RR Assignment: unexpected TSC in Channel Description: expected ",
1061 g_pars.expect_tsc, " got ", got_tsc);
1062 mtc.stop;
1063 }
1064 }
1065
Harald Welte211219e2018-01-29 22:03:36 +01001066 f_ChDesc2RslChanNr(l3.msgs.rrm.assignmentCommand.descrOf1stChAfterTime,
1067 new_chan_nr, arfcn);
1068 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
Harald Weltec1a2fff2017-12-17 11:06:19 +01001069
Harald Welte211219e2018-01-29 22:03:36 +01001070 /* register our component for this channel number at the RSL Emulation */
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +02001071 f_rslem_register(0, new_chan_nr, PT := rsl_proc_pt);
Vadim Yanitskiy539e6302020-06-22 03:11:54 +07001072 /* dispatch queued messages for this channel (if any) */
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +02001073 f_rslem_dchan_queue_dispatch(PT := rsl_proc_pt);
Vadim Yanitskiy539e6302020-06-22 03:11:54 +07001074
Harald Welte211219e2018-01-29 22:03:36 +01001075 var PDU_ML3_MS_NW l3_tx := valueof(ts_RRM_AssignmentComplete('00'O));
1076 /* send assignment complete over the new channel */
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +02001077 rsl_pt.send(ts_RSL_EST_IND(new_chan_nr, valueof(ts_RslLinkID_DCCH(0)),
Harald Welte211219e2018-01-29 22:03:36 +01001078 enc_PDU_ML3_MS_NW(l3_tx)));
1079 /* by default, send via the new channel from now */
1080 st.old_chan_nr := g_chan_nr;
1081 g_chan_nr := new_chan_nr;
1082 st.rr_ass_cmpl_seen := true;
Harald Welte8a9bf6f2018-05-10 22:00:49 +02001083 /* obtain channel activation from RSL_Emulation for new channel */
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +02001084 var RSL_Message chan_act := f_rslem_get_last_act(rsl_proc_pt, 0, g_chan_nr);
Harald Welte8a9bf6f2018-05-10 22:00:49 +02001085 /* check it (e.g. for correct ciphering parameters) */
1086 f_check_chan_act(st, chan_act);
Harald Welte211219e2018-01-29 22:03:36 +01001087 repeat;
1088 } else {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001089 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, log2str("Unexpected L3 received", l3));
Harald Weltec1a2fff2017-12-17 11:06:19 +01001090 }
Harald Welte211219e2018-01-29 22:03:36 +01001091 }
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +02001092 [st.rr_ass_cmpl_seen] rsl_pt.receive(tr_RSL_DEACT_SACCH(st.old_chan_nr)) {
Neels Hofmeyra5302c82018-11-04 23:09:58 +01001093 st.old_lchan_deact_sacch_seen := true;
Neels Hofmeyr861a4c12018-11-07 01:23:17 +01001094 repeat;
1095 }
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +02001096 [st.rr_ass_cmpl_seen] rsl_pt.receive(tr_RSL_REL_REQ(st.old_chan_nr, tr_RslLinkID_DCCH(0))) {
Neels Hofmeyra5302c82018-11-04 23:09:58 +01001097 st.old_lchan_rll_rel_req_seen := true;
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +02001098 rsl_pt.send(ts_RSL_REL_CONF(st.old_chan_nr, valueof(ts_RslLinkID_DCCH(0))));
Harald Welte211219e2018-01-29 22:03:36 +01001099 repeat;
1100 }
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +02001101 [st.rr_ass_cmpl_seen] rsl_pt.receive(tr_RSL_RF_CHAN_REL(st.old_chan_nr)) {
1102 rsl_pt.send(ts_RSL_RF_CHAN_REL_ACK(st.old_chan_nr));
Harald Welte1909f462018-01-29 22:29:29 +01001103 /* unregister for old channel number in RSL emulation */
1104 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
Neels Hofmeyr3222e0e2021-07-20 22:25:38 +02001105 f_rslem_unregister(0, st.old_chan_nr, PT := rsl_proc_pt);
Harald Welte21583082018-01-29 22:28:26 +01001106 st.assignment_done := true;
Harald Welte211219e2018-01-29 22:03:36 +01001107 repeat;
1108 }
1109}
1110
1111altstep as_modify(inout AssignmentState st) runs on MSC_ConnHdlr {
1112 /* no assignment, just mode modify */
1113 var RSL_Message rsl;
1114
1115 [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 +01001116 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[2].body.l3_info.payload);
1117 log("Rx L3 from net: ", l3);
1118 if (ischosen(l3.msgs.rrm.channelModeModify)) {
Neels Hofmeyr559d5d02021-04-16 16:50:49 +02001119 st.rr_channel_mode_modify_msg := l3;
Harald Weltec1a2fff2017-12-17 11:06:19 +01001120 f_rsl_reply(ts_RRM_ModeModifyAck(l3.msgs.rrm.channelModeModify.channelDescription,
1121 l3.msgs.rrm.channelModeModify.channelMode), rsl);
Harald Welte211219e2018-01-29 22:03:36 +01001122 st.rr_modify_seen := true;
Harald Weltec1a2fff2017-12-17 11:06:19 +01001123 }
1124 repeat;
1125 }
Harald Welte211219e2018-01-29 22:03:36 +01001126 [st.voice_call and st.rr_modify_seen] RSL.receive(tr_RSL_MsgTypeD(RSL_MT_MODE_MODIFY_REQ)) -> value rsl {
Neels Hofmeyr559d5d02021-04-16 16:50:49 +02001127 st.rsl_mode_modify_msg := rsl;
Harald Weltec1a2fff2017-12-17 11:06:19 +01001128 RSL.send(ts_RSL_MODE_MODIFY_ACK(g_chan_nr));
Harald Welte21583082018-01-29 22:28:26 +01001129 st.modify_done := true;
Harald Weltec1a2fff2017-12-17 11:06:19 +01001130 repeat;
1131 }
Harald Welte211219e2018-01-29 22:03:36 +01001132}
Daniel Willmann191e0d92018-01-17 12:44:35 +01001133
Harald Welte211219e2018-01-29 22:03:36 +01001134/* Determine if given rsl_chan_nr is compatible with given BSSMAP ChannelType */
1135function f_channel_compatible(BSSMAP_IE_ChannelType bssmap, RslChannelNr rsl_chan_nr)
1136return boolean {
1137 select (bssmap.speechOrDataIndicator) {
1138 case ('0011'B) { /* Signalling */
1139 /* all channels support signalling */
1140 return true;
1141 }
1142 case else { /* Speech, Speech+CTM or CSD */
1143 select (bssmap.channelRateAndType) {
1144 case ('08'O) { /* TCH/F */
1145 select (rsl_chan_nr) {
1146 case (t_RslChanNr_Bm(?)) { return true; }
1147 }
1148 }
1149 case ('09'O) { /* TCH/H */
1150 select (rsl_chan_nr) {
1151 case (t_RslChanNr_Lm(?, ?)) { return true; }
1152 }
1153 }
1154 case else { /* full or half-rate */
1155 select (rsl_chan_nr) {
1156 case (t_RslChanNr_Bm(?)) { return true; }
1157 case (t_RslChanNr_Lm(?, ?)) { return true; }
1158 }
1159 }
1160 }
Harald Weltec1a2fff2017-12-17 11:06:19 +01001161 }
Harald Welte211219e2018-01-29 22:03:36 +01001162 }
1163 return false;
1164}
Daniel Willmann191e0d92018-01-17 12:44:35 +01001165
Philipp Maier8ef527e2018-05-18 11:12:50 +02001166/* Determine if the channel mode specified within rsl_chan_nr requires a
1167 * MODE MODIFY in to match the channel mode specified by given BSSMAP
1168 * ChannelType */
Neels Hofmeyrc2425cc2021-04-19 13:19:55 +00001169function f_channel_needs_modify(TELNETasp_PT vty, BSSMAP_IE_ChannelType bssmap, RslChannelNr rsl_chan_nr)
Philipp Maier8ef527e2018-05-18 11:12:50 +02001170return boolean {
1171
Philipp Maier8ef527e2018-05-18 11:12:50 +02001172 var boolean current_signalling := false;
1173 var boolean desired_signalling := false;
1174
1175 select (rsl_chan_nr) {
1176 case (t_RslChanNr_SDCCH4(?, ?)) { current_signalling := true; }
1177 case (t_RslChanNr_SDCCH8(?, ?)) { current_signalling := true; }
Neels Hofmeyrc2425cc2021-04-19 13:19:55 +00001178 case (t_RslChanNr_Bm(?)) {
1179 /* TCH/F, always subslot 0 */
1180 var charstring res := f_vty_transceive_ret(vty, "show lchan 0 0 " & int2str(rsl_chan_nr.tn) & " 0");
1181 if (f_strstr(res, "Channel Mode / Codec: SIGNALLING", 0) >= 0) {
1182 current_signalling := true;
1183 }
1184 }
1185 case (t_RslChanNr_Lm(?, ?)) {
1186 /* TCH/H */
1187 var charstring res := f_vty_transceive_ret(vty, "show lchan 0 0 " & int2str(rsl_chan_nr.tn)
1188 & " " & int2str(rsl_chan_nr.u.lm.sub_chan));
1189 if (f_strstr(res, "Channel Mode / Codec: SIGNALLING", 0) >= 0) {
1190 current_signalling := true;
1191 }
1192 }
Philipp Maier8ef527e2018-05-18 11:12:50 +02001193 }
1194
1195 if (bssmap.speechOrDataIndicator == '0011'B) {
1196 desired_signalling := true;
1197 }
1198
1199 if (current_signalling == desired_signalling) {
1200 /* The desired channel mode is equal to the one we currently
1201 * have, there is no mode modification needed or expected */
1202 return false;
1203 } else {
1204 /* The desired channel mode and the current channel mode do
1205 * not match. A mode modification is required */
1206 return true;
1207 }
1208}
1209
Harald Weltecc0b0142018-05-29 15:19:33 +02001210/* patch an BSSMAP ASS REQ with LCLS related IEs, depending on g_params */
1211function f_ass_patch_lcls(inout template (omit) PDU_BSSAP ass_tpl,
1212 inout template PDU_BSSAP ass_cpl) runs on MSC_ConnHdlr {
1213 if (istemplatekind(ass_tpl, "omit")) {
1214 return;
1215 }
1216 if (ispresent(g_pars.lcls.gcr)) {
1217 ass_tpl.pdu.bssmap.assignmentRequest.globalCallReference := ts_BSSMAP_IE_GCR(g_pars.lcls.gcr);
1218 }
1219 if (ispresent(g_pars.lcls.cfg)) {
1220 ass_tpl.pdu.bssmap.assignmentRequest.lCLS_Configuration := ts_BSSMAP_IE_LclsCfg(g_pars.lcls.cfg);
1221 }
1222 if (ispresent(g_pars.lcls.csc)) {
1223 ass_tpl.pdu.bssmap.assignmentRequest.lCLS_ConnectionStatusControl := ts_BSSMAP_IE_LclsCsc(g_pars.lcls.csc);
1224 }
Harald Welte343b7742018-06-05 23:41:37 +02001225 if (ischosen(ass_cpl.pdu.bssmap.assignmentComplete)) {
1226 if (ispresent(g_pars.lcls.exp_sts)) {
1227 ass_cpl.pdu.bssmap.assignmentComplete.lCLS_BSS_Status := tr_BSSMAP_IE_LclsSts(g_pars.lcls.exp_sts);
1228 } else {
1229 ass_cpl.pdu.bssmap.assignmentComplete.lCLS_BSS_Status := omit;
1230 }
Harald Weltecc0b0142018-05-29 15:19:33 +02001231 }
1232}
1233
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +02001234/* Send a MGCP request through MGCP-over-IPA from MSC side and receive a (matching!) response */
1235function mgcp_transceive_mgw(template MgcpCommand cmd, template MgcpResponse resp := ?) runs on MSC_ConnHdlr {
1236 template MgcpResponse resp_any := ?
1237 var MgcpResponse resp_val;
1238 resp.line.trans_id := cmd.line.trans_id;
1239 timer T := 5.0;
1240
1241 BSSAP.send(cmd);
1242 T.start;
1243 alt {
1244 [] as_Media_mgw();
1245 [] BSSAP.receive(resp) -> value resp_val { }
1246 [] BSSAP.receive(resp_any) {
1247 setverdict(fail, "Response didn't match template");
1248 mtc.stop;
1249 }
1250 [] BSSAP.receive { repeat; }
1251 [] T.timeout {
1252 setverdict(fail, "Timeout waiting for response to ", cmd);
1253 mtc.stop;
1254 }
1255 }
1256 T.stop;
1257}
1258
Philipp Maier3e2af5d2018-07-11 17:01:05 +02001259/* Helper function to check if the activity on the MGCP matches what we
1260 * expected */
1261function f_check_mgcp_expectations() runs on MSC_ConnHdlr {
1262 for (var integer i:= 0; i < sizeof(g_media.mgcp_conn); i := i+1) {
Philipp Maier0a5d7e72018-07-16 15:13:11 +02001263 log(testcasename(), ": Check MGCP test expectations for g_media.mgcp_conn[", i , "]:",
1264 " crcx_seen=", g_media.mgcp_conn[i].crcx_seen, ", crcx_seen_exp=", g_media.mgcp_conn[i].crcx_seen_exp,
1265 ", mdcx_seen=", g_media.mgcp_conn[i].mdcx_seen, ", mdcx_seen_exp=", g_media.mgcp_conn[i].mdcx_seen_exp);
1266
Philipp Maier3e2af5d2018-07-11 17:01:05 +02001267 if(g_media.mgcp_conn[i].crcx_seen != g_media.mgcp_conn[i].crcx_seen_exp) {
Max4b0f4962018-11-06 19:20:24 +01001268 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 +02001269 }
1270 if(g_media.mgcp_conn[i].mdcx_seen != g_media.mgcp_conn[i].mdcx_seen_exp) {
Max4b0f4962018-11-06 19:20:24 +01001271 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 +02001272 }
1273 }
1274}
1275
Harald Welte211219e2018-01-29 22:03:36 +01001276/* establish a channel fully, expecting an assignment matching 'exp' */
Harald Welte7a14fd52018-05-10 22:26:55 +02001277function f_establish_fully(template (omit) PDU_BSSAP ass_tpl, template PDU_BSSAP exp_ass_cpl)
1278runs on MSC_ConnHdlr {
Philipp Maier11a58942018-06-25 16:40:48 +02001279
1280 var BSSMAP_FIELD_CodecType codecType;
Philipp Maier48aeeec2018-09-14 18:20:04 +02001281 timer T := 10.0;
Philipp Maier3e2af5d2018-07-11 17:01:05 +02001282
Philipp Maier4ce978c2020-08-11 22:54:07 +02001283 if (not istemplatekind(ass_tpl, "omit") and isvalue(ass_tpl.pdu.bssmap.assignmentRequest.codecList)) {
Philipp Maier11a58942018-06-25 16:40:48 +02001284 codecType := valueof(ass_tpl.pdu.bssmap.assignmentRequest.codecList.codecElements[0].codecType);
1285 } else {
1286 /* Make sure a meaningful default is assigned in case the
1287 * codecList is not populated */
1288 codecType := FR_AMR;
1289 }
1290
Pau Espin Pedrol07866632020-09-03 19:10:55 +02001291 f_MscConnHdlr_init(g_pars.media_nr, host_bts, host_mgw_mgcp, codecType);
Harald Welte7a14fd52018-05-10 22:26:55 +02001292
Harald Weltecc0b0142018-05-29 15:19:33 +02001293 /* patch in the LCLS related items, as needed */
1294 f_ass_patch_lcls(ass_tpl, exp_ass_cpl);
1295
Harald Welte7a14fd52018-05-10 22:26:55 +02001296 f_create_chan_and_exp();
Harald Welte7a14fd52018-05-10 22:26:55 +02001297
1298 /* start ciphering, if requested */
1299 if (ispresent(g_pars.encr)) {
Neels Hofmeyr6c388f22021-06-11 02:36:56 +02001300 f_cipher_mode(g_pars.encr);
Harald Welte7a14fd52018-05-10 22:26:55 +02001301 }
1302
1303 /* bail out early if no assignment requested */
1304 if (istemplatekind(ass_tpl, "omit")) {
1305 return;
1306 }
1307
1308 var PDU_BSSAP ass_cmd := valueof(ass_tpl);
Harald Welte211219e2018-01-29 22:03:36 +01001309 var PDU_BSSAP bssap;
Harald Welte211219e2018-01-29 22:03:36 +01001310 var boolean exp_compl := ischosen(exp_ass_cpl.pdu.bssmap.assignmentComplete);
Philipp Maier86f39202018-02-07 14:40:09 +01001311 var boolean exp_fail := ischosen(exp_ass_cpl.pdu.bssmap.assignmentFailure);
Philipp Maier8ef527e2018-05-18 11:12:50 +02001312 var boolean exp_modify;
Philipp Maier48aeeec2018-09-14 18:20:04 +02001313
Harald Welte211219e2018-01-29 22:03:36 +01001314 var ExpectCriteria mgcpcrit := {
1315 connid := omit,
1316 endpoint := omit,
1317 transid := omit
1318 };
1319 var AssignmentState st := valueof(ts_AssignmentStateInit);
1320 /* if the channel type is SIGNAL, we're not handling a voice call */
1321 if (ass_cmd.pdu.bssmap.assignmentRequest.channelType.speechOrDataIndicator != '0011'B) {
1322 st.voice_call := true;
Philipp Maier8ef527e2018-05-18 11:12:50 +02001323 exp_modify := true;
Harald Welte211219e2018-01-29 22:03:36 +01001324 }
Philipp Maier8ef527e2018-05-18 11:12:50 +02001325
Harald Welte211219e2018-01-29 22:03:36 +01001326 /* determine if the current channel can support the given service or not */
1327 if (not f_channel_compatible(ass_cmd.pdu.bssmap.assignmentRequest.channelType, g_chan_nr)) {
1328 st.is_assignment := true;
Philipp Maier8ef527e2018-05-18 11:12:50 +02001329
1330 /* We decided to assign a new channel, so we do not expect
1331 * any mode modify messages on RSL */
1332 exp_modify := false;
1333 } else {
1334 /* We will continue working with the currently assigned
1335 * channel, we must now check if the mode of the current
1336 * channel is compatible. If not we expect the BSC to modify
1337 * the mode */
Neels Hofmeyr559d5d02021-04-16 16:50:49 +02001338 st.is_assignment := false;
Neels Hofmeyrc2425cc2021-04-19 13:19:55 +00001339 exp_modify := f_channel_needs_modify(BSCVTY, ass_cmd.pdu.bssmap.assignmentRequest.channelType, g_chan_nr);
Harald Welte211219e2018-01-29 22:03:36 +01001340 }
1341
Philipp Maier3e2af5d2018-07-11 17:01:05 +02001342 /* Some test situations will involve MGCP transactions on a media
1343 * gateway. Depending on the situation, we set up how many of each MGCP
1344 * message type are expected to be exchanged. */
1345 if (isbound(exp_ass_cpl.pdu.bssmap.assignmentFailure)) {
1346 /* For tests that expect the assignment to fail, assume that
1347 * there will be no MGW communication as well. */
1348 g_media.mgcp_conn[0].crcx_seen_exp := 0;
1349 g_media.mgcp_conn[0].mdcx_seen_exp := 0;
1350 g_media.mgcp_conn[1].crcx_seen_exp := 0;
1351 g_media.mgcp_conn[1].mdcx_seen_exp := 0;
1352 } else if (st.voice_call) {
1353 /* For voice calls we expect the following MGCP activity */
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +02001354 g_media.mgcp_conn[0].crcx_seen_exp := 1;
1355 g_media.mgcp_conn[0].mdcx_seen_exp := 1;
1356 g_media.mgcp_conn[1].crcx_seen_exp := 1;
1357 g_media.mgcp_conn[1].mdcx_seen_exp := 0;
Philipp Maier3e2af5d2018-07-11 17:01:05 +02001358 }
1359
Vadim Yanitskiy539e6302020-06-22 03:11:54 +07001360 /* On receipt of the BSSAP Assignment Command, the IUT (osmo-bsc) will allocate
1361 * a channel and send us RR Assignment Command together with ip.access CRCX.
1362 * There is a risk that the RSL Emulation component would dequeue and process
1363 * ip.access CRCX faster than we process the Assignment Command and register
1364 * the corresponding handler for the indicated RSL channel number. This would
1365 * result in a failure, because at that moment there will be no handler for
1366 * ip.access CRCX. Let's guard against this and enable additional queueing. */
1367 f_rslem_dchan_queue_enable();
1368
Harald Welte211219e2018-01-29 22:03:36 +01001369 f_create_mgcp_expect(mgcpcrit);
1370 BSSAP.send(ass_cmd);
1371
1372 T.start;
1373 alt {
1374 /* assignment related bits */
1375 [st.is_assignment] as_assignment(st);
1376
1377 /* modify related bits */
Philipp Maier8ef527e2018-05-18 11:12:50 +02001378 [not st.is_assignment and exp_modify] as_modify(st);
Harald Welte211219e2018-01-29 22:03:36 +01001379
1380 /* voice call related bits (IPA CRCX/MDCX + MGCP) */
1381 [st.voice_call] as_Media();
1382
1383 /* if we receive exactly what we expected, always return + pass */
Philipp Maier8ef527e2018-05-18 11:12:50 +02001384 [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 +01001385 setverdict(pass);
1386 }
Philipp Maier86f39202018-02-07 14:40:09 +01001387 [exp_fail] BSSAP.receive(exp_ass_cpl) -> value bssap {
1388 setverdict(pass);
1389 }
Harald Welte21583082018-01-29 22:28:26 +01001390 [(st.is_assignment and st.assignment_done or
Philipp Maier8ef527e2018-05-18 11:12:50 +02001391 (not st.is_assignment and (st.modify_done or not exp_modify))) and
Harald Welte21583082018-01-29 22:28:26 +01001392 exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentComplete) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001393 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Received non-matching ASSIGNMENT COMPLETE");
Harald Weltec1a2fff2017-12-17 11:06:19 +01001394 }
1395 [exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentFail) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001396 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Received unexpected ASSIGNMENT FAIL");
Harald Weltec1a2fff2017-12-17 11:06:19 +01001397 }
1398 [not exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentComplete) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001399 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Received unexpected ASSIGNMENT COMPLETE");
Harald Weltec1a2fff2017-12-17 11:06:19 +01001400 }
1401 [not exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentFail) {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001402 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Received non-matching ASSIGNMENT FAIL");
Harald Weltec1a2fff2017-12-17 11:06:19 +01001403 }
1404 [] T.timeout {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001405 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, "Timeout waiting for ASSIGNMENT COMPLETE");
Harald Weltec1a2fff2017-12-17 11:06:19 +01001406 }
1407 }
Harald Welte211219e2018-01-29 22:03:36 +01001408 log("g_media ", g_media);
1409 if (not isbound(bssap)) {
Daniel Willmannafce8662018-07-06 23:11:32 +02001410 mtc.stop;
Harald Welte211219e2018-01-29 22:03:36 +01001411 }
Philipp Maier3e2af5d2018-07-11 17:01:05 +02001412
Neels Hofmeyr559d5d02021-04-16 16:50:49 +02001413 if (exp_modify) {
1414 /* Verify that the RR Channel Mode Modify and RSL MODE MODIFY message asked for the expected channel
1415 * mode. */
1416 /* TODO: more precisely expect the different types of speech? */
1417 var OCT1 rr_channel_mode := st.rr_channel_mode_modify_msg.msgs.rrm.channelModeModify.channelMode.mode;
1418
1419 if (st.voice_call and rr_channel_mode == '00'O) {
1420 setverdict(fail, "f_establish_fully(): Expected RR Channel Mode Modify",
1421 " to a speech mode, but got channelMode == ", rr_channel_mode);
1422 mtc.stop;
1423 } else if (not st.voice_call and rr_channel_mode != '00'O) {
1424 setverdict(fail, "f_establish_fully(): Expected RR Channel Mode Modify",
1425 " to signalling mode, but got channelMode == ", rr_channel_mode);
1426 mtc.stop;
1427 }
1428
1429 var RSL_IE_Body chan_mode_ie;
1430 if (not f_rsl_find_ie(st.rsl_mode_modify_msg, RSL_IE_CHAN_MODE, chan_mode_ie)) {
1431 setverdict(fail, "RSL MODE MODIFY message lacks a Channel Mode IE");
1432 mtc.stop;
1433 }
1434 var RSL_SpeechDataInd rsl_spd_ind := chan_mode_ie.chan_mode.spd_ind;
1435 if (st.voice_call and rsl_spd_ind != RSL_SPDI_SPEECH) {
1436 setverdict(fail, "f_establish_fully(): Expected RSL MODE MODIFY",
1437 " to a speech mode, but got spd_ind == ", rsl_spd_ind);
1438 mtc.stop;
1439 } else if (not st.voice_call and rsl_spd_ind != RSL_SPDI_SIGN) {
1440 setverdict(fail, "f_establish_fully(): Expected RSL MODE MODIFY",
1441 " to signalling mode, but got spd_ind == ", rsl_spd_ind);
1442 mtc.stop;
1443 }
Neels Hofmeyrb5b7a6e2021-06-04 19:03:45 +02001444
1445 if (not istemplatekind(g_pars.expect_tsc, "omit")) {
1446 var uint3_t got_tsc := rr_chan_desc_tsc(st.rr_channel_mode_modify_msg.msgs.rrm.channelModeModify.channelDescription);
1447 if (not match(got_tsc, g_pars.expect_tsc)) {
1448 setverdict(fail, "RR Channel Mode Modify: unexpected TSC in Channel Description: expected ",
1449 g_pars.expect_tsc, " got ", got_tsc);
1450 mtc.stop;
1451 }
1452 }
1453
1454 } else {
1455 /* not exp_modify, so this did a Channel Activate */
1456
1457 /* Check the TSC */
1458 if (not istemplatekind(g_pars.expect_tsc, "omit")) {
1459 var RSL_Message chan_act := f_rslem_get_last_act(RSL_PROC, 0, g_chan_nr);
1460 var RSL_IE_Body ie;
1461 if (f_rsl_find_ie(chan_act, RSL_IE_CHAN_IDENT, ie)) {
1462 var uint3_t got_tsc := ie.chan_ident.ch_desc.v.tsc;
1463 if (not match(got_tsc, g_pars.expect_tsc)) {
1464 setverdict(fail, "RSL CHANnel ACTIVation: unexpected TSC in Channel Description: expected ",
1465 g_pars.expect_tsc, " got ", got_tsc);
1466 mtc.stop;
1467 }
1468 }
1469 }
Neels Hofmeyr559d5d02021-04-16 16:50:49 +02001470 }
1471
Philipp Maiera0976e92018-07-16 15:19:42 +02001472 /* When the BSC detects that LCLS is possible it will cross the
1473 * connetions that point to the PBX side of the MGW. In our case this
1474 * is mgcp_conn[1]. The BSC performs this operation already before the
1475 * assignment complete is generated. This means we expect another MDCX
1476 * at mgcp_conn[1] when LCLS is expected. */
Max2eeb5112018-11-06 19:21:41 +01001477 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 +02001478 if (valueof(exp_ass_cpl.pdu.bssmap.assignmentComplete.lCLS_BSS_Status.lCLS_BSS_StatusValue) == LCLS_STS_locally_switched) {
1479 g_media.mgcp_conn[1].mdcx_seen_exp := g_media.mgcp_conn[1].mdcx_seen_exp + 1;
1480
1481 }
1482 }
1483
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +02001484 if (not exp_fail and st.voice_call and not g_pars.aoip) {
1485 /* With SCCPLite, connect to BSC-located MGW using a CRCX + SDP.
1486 It is sent in MGCP over IPA in the BSC<->MSC (BSC-NAT)
1487 connection. BSC will forward it to its MGW. */
1488 var template MgcpCommand cmd;
1489 var template MgcpResponse resp;
1490 var integer cic := f_bssmap_ie_cic_2_int(ass_cmd.pdu.bssmap.assignmentRequest.circuitIdentityCode);
1491 var MgcpEndpoint ep := int2str(cic) & "@mgw"; /* 1: matches value configured in BSC_Tests.ttcn pass in AssignReq */
1492 var MgcpCallId call_id := '51234'H;
1493 var SDP_attribute_list attributes := { valueof(ts_SDP_ptime(20)) };
1494 if (g_pars.use_osmux) {
1495 cmd := ts_CRCX_osmux(get_next_trans_id(), ep, "sendrecv", call_id, cic);
1496 resp := tr_CRCX_ACK_osmux;
1497 } else {
1498 cmd := ts_CRCX(get_next_trans_id(), ep, "sendrecv", call_id);
1499 resp := tr_CRCX_ACK;
1500 }
Pau Espin Pedrol07866632020-09-03 19:10:55 +02001501 cmd.sdp := ts_SDP(host_msc, host_mgw_rtp_v4, "23", "42",
Pau Espin Pedrolfd02ad42019-06-18 17:45:20 +02001502 14000, { int2str(g_media.mgcp_conn[1].rtp_pt) },
1503 { valueof(ts_SDP_ptime(20)) });
1504 mgcp_transceive_mgw(cmd, resp);
1505 }
1506
Philipp Maier3e2af5d2018-07-11 17:01:05 +02001507 f_check_mgcp_expectations();
Neels Hofmeyra5302c82018-11-04 23:09:58 +01001508
1509 if (st.is_assignment and st.assignment_done) {
1510 if (not st.old_lchan_deact_sacch_seen) {
1511 setverdict(fail, "f_establish_fully(): Assignment completed, but the old lchan was not",
1512 " released properly: expected a Deact SACCH on the old lchan, but saw none.");
1513 }
1514 if (st.old_lchan_rll_rel_req_seen) {
1515 setverdict(fail, "f_establish_fully(): Assignment completed, but the old lchan was not",
1516 " released properly: saw an RLL Release on the old lchan, but expecting none.");
1517 }
1518 }
Neels Hofmeyr9d686302021-04-25 19:02:29 +00001519
1520 var charstring lchan_info := f_vty_transceive_ret(BSCVTY, "show lchan 0 0 " & int2str(g_chan_nr.tn) & " 0");
1521 if (f_strstr(lchan_info, "State: ESTABLISHED") < 0) {
1522 log("after f_establish_fully(), 'show lchan' replied: ", lchan_info);
1523 setverdict(fail, "lchan is not in state ESTABLISHED");
1524 mtc.stop;
1525 }
Harald Welte930d0a72018-03-22 22:08:40 +01001526}
1527
Harald Welte261af4b2018-02-12 21:20:39 +01001528type record HandoverState {
1529 /* Assignment related bits */
1530 boolean rr_ho_cmpl_seen,
Philipp Maierc1e95c82018-07-18 16:03:00 +02001531 integer mdcx_seen_before_ho,
Harald Welte261af4b2018-02-12 21:20:39 +01001532 boolean handover_done,
Neels Hofmeyrc741fcb2021-10-02 14:52:28 +02001533 RslChannelNr old_chan_nr,
1534 uint3_t expect_target_tsc optional
Harald Welte261af4b2018-02-12 21:20:39 +01001535};
1536
1537altstep as_handover(inout HandoverState st) runs on MSC_ConnHdlr {
1538 var RSL_Message rsl;
1539 [not st.rr_ho_cmpl_seen] RSL.receive(tr_RSL_DATA_REQ(g_chan_nr)) -> value rsl {
1540 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[2].body.l3_info.payload);
1541 log("Rx L3 from net: ", l3);
1542 if (ischosen(l3.msgs.rrm.handoverCommand)) {
1543 var RslChannelNr new_chan_nr;
1544 var GsmArfcn arfcn;
1545 f_ChDesc2RslChanNr(l3.msgs.rrm.handoverCommand.channelDescription2,
1546 new_chan_nr, arfcn);
1547 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
1548
Neels Hofmeyrc741fcb2021-10-02 14:52:28 +02001549 /* Verify correct TSC in handoverCommand */
1550 if (ispresent(st.expect_target_tsc)) {
1551 var uint3_t got_tsc := rr_chan_desc_tsc(l3.msgs.rrm.handoverCommand.channelDescription2);
1552 if (not match(got_tsc, st.expect_target_tsc)) {
1553 setverdict(fail, "RR Handover Command: unexpected TSC in Channel Description: expected ",
1554 st.expect_target_tsc, " got ", got_tsc);
1555 mtc.stop;
1556 } else {
1557 log("handoverCommand: verified TSC = ", got_tsc, " (matches ",
1558 st.expect_target_tsc, ")");
1559 }
1560 }
1561
Harald Welte261af4b2018-02-12 21:20:39 +01001562 /* register our component for this channel number at the RSL Emulation */
1563 f_rslem_register(0, new_chan_nr, RSL1_PROC);
1564
1565 /* resume processing of RSL DChan messages, which was temporarily suspended
1566 * before performing a hand-over */
1567 f_rslem_resume(RSL1_PROC);
1568
Neels Hofmeyr378a49c2018-06-15 22:18:43 +02001569 /* send handover detect */
1570 RSL1.send(ts_RSL_HANDO_DET(new_chan_nr));
1571 f_sleep(0.3);
1572
Harald Welte261af4b2018-02-12 21:20:39 +01001573 /* send handover complete over the new channel */
1574 var PDU_ML3_MS_NW l3_tx := valueof(ts_RRM_HandoverComplete('00'O));
Neels Hofmeyrd07ee132018-07-14 22:28:29 +02001575 RSL1.send(ts_RSL_EST_IND(new_chan_nr, valueof(ts_RslLinkID_DCCH(0)),
Harald Welte261af4b2018-02-12 21:20:39 +01001576 enc_PDU_ML3_MS_NW(l3_tx)));
1577 /* by default, send via the new channel from now */
1578 st.old_chan_nr := g_chan_nr;
1579 g_chan_nr := new_chan_nr;
1580 st.rr_ho_cmpl_seen := true;
Philipp Maierc1e95c82018-07-18 16:03:00 +02001581
1582 /* Memorize how many MDCX we have seen before. We need this number to detect
1583 * that we have received the handover related MDCX */
1584 st.mdcx_seen_before_ho := g_media.mgcp_conn[0].mdcx_seen;
Harald Welte261af4b2018-02-12 21:20:39 +01001585 repeat;
1586 } else {
Daniel Willmann0c9e3fa2018-10-29 15:55:12 +01001587 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, log2str("Unexpected L3 received", l3));
Harald Welte261af4b2018-02-12 21:20:39 +01001588 }
1589 }
Philipp Maierc1e95c82018-07-18 16:03:00 +02001590 [st.rr_ho_cmpl_seen] as_Media_ipacc();
Philipp Maier09f1c6d2020-09-14 21:28:52 +02001591 [st.rr_ho_cmpl_seen] as_Media_mgw();
Neels Hofmeyr861a4c12018-11-07 01:23:17 +01001592 [st.rr_ho_cmpl_seen] RSL.receive(tr_RSL_DEACT_SACCH(st.old_chan_nr)) {
1593 repeat;
1594 }
Harald Welte261af4b2018-02-12 21:20:39 +01001595 [st.rr_ho_cmpl_seen] RSL.receive(tr_RSL_REL_REQ(st.old_chan_nr, tr_RslLinkID_DCCH(0))) {
1596 RSL.send(ts_RSL_REL_CONF(st.old_chan_nr, valueof(ts_RslLinkID_DCCH(0))));
1597 repeat;
1598 }
1599 [st.rr_ho_cmpl_seen] RSL.receive(tr_RSL_RF_CHAN_REL(st.old_chan_nr)) {
1600 RSL.send(ts_RSL_RF_CHAN_REL_ACK(st.old_chan_nr));
1601 /* unregister for old channel number in RSL emulation */
1602 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
1603 f_rslem_unregister(0, st.old_chan_nr);
Philipp Maierc1e95c82018-07-18 16:03:00 +02001604
1605 /* The channel release must not necessarly be synchronized to the RSL handover
1606 * procedure since those events may happen independently nearly at the same
1607 * time. When we receive the RSL_RF_CHAN_REL command the media negotiation on
1608 * IPACC or MGCP level may be still in progress. In order to make sure that
1609 * we do only stop when we have seen an MDCX on MGCP level and another a CRCX
Neels Hofmeyrffd2ef12020-10-12 18:45:58 +00001610 * as well as an MDCX on IPACC level.
1611 * If ipa_crcx_seen is false, this is not a voice channel and we need not check MGCP at all.. */
1612 if (g_media.bts.ipa_crcx_seen
1613 and (g_media.mgcp_conn[0].mdcx_seen <= st.mdcx_seen_before_ho or
1614 g_media.bts1.ipa_mdcx_seen == false or g_media.bts1.ipa_crcx_seen == false)) {
Philipp Maierc1e95c82018-07-18 16:03:00 +02001615 repeat;
1616 } else {
1617 st.handover_done := true;
1618 }
Harald Welte261af4b2018-02-12 21:20:39 +01001619 }
1620}
1621
1622
Harald Weltec1a2fff2017-12-17 11:06:19 +01001623
Harald Welte28d943e2017-11-25 15:00:50 +01001624}