blob: 6bf3221c9dbb4c2c4bef11ed27539a9db9a21343 [file] [log] [blame]
Harald Welte28d943e2017-11-25 15:00:50 +01001module MSC_ConnectionHandler {
2
3import from General_Types all;
4import from Osmocom_Types all;
Harald Weltec1a2fff2017-12-17 11:06:19 +01005import from GSM_Types all;
Harald Welte28d943e2017-11-25 15:00:50 +01006import from SCCPasp_Types all;
7import from BSSAP_Types all;
8import from BSSMAP_Emulation all;
9import from BSSMAP_Templates all;
10
Harald Welte211219e2018-01-29 22:03:36 +010011import from IPL4asp_Types all;
12import from Native_Functions all;
13
Harald Welte28d943e2017-11-25 15:00:50 +010014import from MGCP_Types all;
15import from MGCP_Templates all;
Daniel Willmann191e0d92018-01-17 12:44:35 +010016import from MGCP_Emulation all;
Harald Welte28d943e2017-11-25 15:00:50 +010017import from SDP_Types all;
18
Harald Weltec1a2fff2017-12-17 11:06:19 +010019import from RSL_Emulation all;
20import from RSL_Types all;
21
22import from MobileL3_Types all;
23import from MobileL3_CommonIE_Types all;
Harald Welte211219e2018-01-29 22:03:36 +010024import from MobileL3_RRM_Types all;
Harald Weltec1a2fff2017-12-17 11:06:19 +010025import from L3_Templates all;
26
Harald Weltec20b1c42018-02-12 20:50:08 +010027import from TELNETasp_PortType all;
28import from Osmocom_VTY_Functions all;
29
Harald Weltec1a2fff2017-12-17 11:06:19 +010030
Harald Welte211219e2018-01-29 22:03:36 +010031/***********************************************************************
32 * Media related handling
33 ***********************************************************************/
34
35/* Tuple containing host/ip and port */
36type record HostPort {
37 HostName host,
38 PortNumber port_nr
39};
40
41/* State encapsulating one MGCP Connection */
42type record MgcpConnState {
43 boolean crcx_seen,
44 MgcpConnectionId conn_id,
45 charstring mime_type, /* e.g. AMR */
46 integer sample_rate, /* 8000 */
47 integer ptime, /* 20 */
48 uint7_t rtp_pt, /* RTP Payload Type */
49 HostPort mgw, /* MGW side */
50 HostPort peer /* CA side */
51};
52
53/* BTS media state */
54type record BtsMediaState {
55 boolean ipa_crcx_seen,
56 uint16_t conn_id,
57 uint7_t rtp_pt,
58 HostPort bts,
59 HostPort peer
60};
61
62type record MediaState {
63 MgcpEndpoint mgcp_ep,
64 MgcpConnState mgcp_conn[2],
Harald Welte261af4b2018-02-12 21:20:39 +010065 BtsMediaState bts,
66 BtsMediaState bts1 /* only during hand-over */
Harald Welte211219e2018-01-29 22:03:36 +010067};
68
69function f_MediaState_init(inout MediaState g_media, integer nr, HostName bts, HostName mgw) {
70 /* BTS Side */
71 g_media.bts := {
72 ipa_crcx_seen := false,
73 conn_id := nr,
74 rtp_pt := 0,
75 bts := {
76 host := bts,
77 port_nr := 9000 + nr*2
78 },
79 peer := -
80 }
81
Harald Welte261af4b2018-02-12 21:20:39 +010082 g_media.bts1 := {
83 ipa_crcx_seen := false,
84 conn_id := nr,
85 rtp_pt := 0,
86 bts := {
87 host := bts, /* FIXME */
88 port_nr := 9000 + nr*2
89 },
90 peer := -
91 }
92
Harald Welte363cb0a2018-01-30 19:35:53 +010093 g_media.mgcp_ep := "rtpbridge/" & int2str(nr) & "@mgw";
Harald Welte211219e2018-01-29 22:03:36 +010094
95 for (var integer i:= 0; i < sizeof(g_media.mgcp_conn); i := i+1) {
96 g_media.mgcp_conn[i].mime_type := "AMR";
97 g_media.mgcp_conn[i].sample_rate := 8000;
98 g_media.mgcp_conn[i].ptime := 20;
99 g_media.mgcp_conn[i].rtp_pt := 98;
100 g_media.mgcp_conn[i].crcx_seen := false;
101 g_media.mgcp_conn[i].conn_id := f_mgcp_alloc_conn_id();
102 }
103
104 g_media.mgcp_conn[0].mgw := {
105 host := mgw,
106 port_nr := 10000 + nr*2
107 }
108 g_media.mgcp_conn[1].mgw := {
109 host := mgw,
110 port_nr := 11000 + nr*2
111 }
112}
113
114private function f_get_free_mgcp_conn() runs on MSC_ConnHdlr return integer {
115 for (var integer i:= 0; i < sizeof(g_media.mgcp_conn); i := i+1) {
116 if (not g_media.mgcp_conn[i].crcx_seen) {
117 return i;
118 }
119 }
120 setverdict(fail, "Only 2 Connections per EP!");
121 self.stop;
122 return -1;
123}
124
125private function f_get_mgcp_conn(MgcpConnectionId cid) runs on MSC_ConnHdlr return integer {
126 for (var integer i:= 0; i < sizeof(g_media.mgcp_conn); i := i+1) {
127 if (g_media.mgcp_conn[i].conn_id == cid and g_media.mgcp_conn[i].crcx_seen) {
128 return i;
129 }
130 }
131 setverdict(fail, "No Connection for ID ", cid);
132 self.stop;
133 return -1;
134}
135
136
137/* altstep for handling of IPA + MGCP media related commands. Can be activated by a given
138 * test case if it expects to see media related handling (i.e. voice calls */
139altstep as_Media() runs on MSC_ConnHdlr {
140 var RSL_Message rsl;
141 var MgcpCommand mgcp_cmd;
142 var RSL_IE_Body ie;
143 [not g_media.bts.ipa_crcx_seen] RSL.receive(tr_RSL_IPA_CRCX(g_chan_nr)) -> value rsl {
144 /* Extract parameters from request + use in response */
145 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
146 g_media.bts.rtp_pt := ie.ipa_rtp_pt;
147 }
148 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
149 g_media.bts.rtp_pt := ie.ipa_rtp_pt2;
150 }
151 RSL.send(ts_RSL_IPA_CRCX_ACK(g_chan_nr, g_media.bts.conn_id,
152 oct2int(f_inet_addr(g_media.bts.bts.host)),
153 g_media.bts.bts.port_nr,
154 g_media.bts.rtp_pt));
155 g_media.bts.ipa_crcx_seen := true;
156 repeat;
157 }
158 [g_media.bts.ipa_crcx_seen] RSL.receive(tr_RSL_IPA_MDCX(g_chan_nr, ?)) -> value rsl{
159 /* Extract conn_id, ip, port, rtp_pt2 from request + use in response */
160 f_rsl_find_ie(rsl, RSL_IE_IPAC_CONN_ID, ie);
161 if (g_media.bts.conn_id != ie.ipa_conn_id) {
162 setverdict(fail, "IPA MDCX for unknown ConnId", rsl);
163 self.stop;
164 }
165 /* mandatory */
166 f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_IP, ie);
167 g_media.bts.peer.host := f_inet_ntoa(int2oct(ie.ipa_remote_ip, 4));
168 f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_PORT, ie);
169 g_media.bts.peer.port_nr := ie.ipa_remote_port;
170 /* optional */
171 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
172 g_media.bts.rtp_pt := ie.ipa_rtp_pt;
173 }
174 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
175 g_media.bts.rtp_pt := ie.ipa_rtp_pt2;
176 }
177 RSL.send(ts_RSL_IPA_MDCX_ACK(g_chan_nr, g_media.bts.conn_id,
178 oct2int(f_inet_addr(g_media.bts.peer.host)),
179 g_media.bts.peer.port_nr,
180 g_media.bts.rtp_pt));
Harald Welte261af4b2018-02-12 21:20:39 +0100181 //g_media.bts.ipa_mdcx_seen := true;
Harald Welte211219e2018-01-29 22:03:36 +0100182 repeat;
183 }
Harald Welte261af4b2018-02-12 21:20:39 +0100184
185 /* on second (new) BTS during hand-over */
186 [not g_media.bts1.ipa_crcx_seen] RSL1.receive(tr_RSL_IPA_CRCX(g_chan_nr)) -> value rsl {
187 /* Extract parameters from request + use in response */
188 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
189 g_media.bts1.rtp_pt := ie.ipa_rtp_pt;
190 }
191 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
192 g_media.bts1.rtp_pt := ie.ipa_rtp_pt2;
193 }
194 RSL1.send(ts_RSL_IPA_CRCX_ACK(g_chan_nr, g_media.bts1.conn_id,
195 oct2int(f_inet_addr(g_media.bts1.bts.host)),
196 g_media.bts1.bts.port_nr,
197 g_media.bts1.rtp_pt));
198 g_media.bts1.ipa_crcx_seen := true;
199 repeat;
200 }
201 /* on second (new) BTS during hand-over */
202 [g_media.bts1.ipa_crcx_seen] RSL1.receive(tr_RSL_IPA_MDCX(g_chan_nr, ?)) -> value rsl{
203 /* Extract conn_id, ip, port, rtp_pt2 from request + use in response */
204 f_rsl_find_ie(rsl, RSL_IE_IPAC_CONN_ID, ie);
205 if (g_media.bts1.conn_id != ie.ipa_conn_id) {
206 setverdict(fail, "IPA MDCX for unknown ConnId", rsl);
207 self.stop;
208 }
209 /* mandatory */
210 f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_IP, ie);
211 g_media.bts1.peer.host := f_inet_ntoa(int2oct(ie.ipa_remote_ip, 4));
212 f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_PORT, ie);
213 g_media.bts1.peer.port_nr := ie.ipa_remote_port;
214 /* optional */
215 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
216 g_media.bts1.rtp_pt := ie.ipa_rtp_pt;
217 }
218 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
219 g_media.bts1.rtp_pt := ie.ipa_rtp_pt2;
220 }
221 RSL1.send(ts_RSL_IPA_MDCX_ACK(g_chan_nr, g_media.bts1.conn_id,
222 oct2int(f_inet_addr(g_media.bts1.peer.host)),
223 g_media.bts1.peer.port_nr,
224 g_media.bts1.rtp_pt));
225 //g_media.bts1.ipa_mdcx_seen := true;
226 repeat;
227 }
228
Harald Welte211219e2018-01-29 22:03:36 +0100229 [] MGCP.receive(tr_CRCX) -> value mgcp_cmd {
230 var SDP_Message sdp;
231 var integer cid := f_get_free_mgcp_conn();
Harald Welte363cb0a2018-01-30 19:35:53 +0100232 if (match(mgcp_cmd.line.ep, t_MGCP_EP_wildcard)) {
233 if (cid != 0) {
234 setverdict(fail, "MGCP wildcard EP only works in first CRCX");
235 self.stop;
236 }
237 /* we keep the endpoint name allocated during MediaState_init */
238 } else {
239 /* Call Agent allocated endpoint, trust/use it always */
240 g_media.mgcp_ep := mgcp_cmd.line.ep;
241 }
Harald Welte211219e2018-01-29 22:03:36 +0100242 if (isvalue(mgcp_cmd.sdp)) {
243 sdp := mgcp_cmd.sdp;
244 g_media.mgcp_conn[cid].peer.host := sdp.connection.conn_addr.addr;
245 g_media.mgcp_conn[cid].peer.port_nr := sdp.media_list[0].media_field.ports.port_number;
246 }
247 var MgcpConnState mgcp_conn := g_media.mgcp_conn[cid];
248 sdp := valueof(ts_SDP(mgcp_conn.mgw.host, mgcp_conn.mgw.host, "foo", "21",
249 mgcp_conn.mgw.port_nr, { int2str(mgcp_conn.rtp_pt) },
250 {valueof(ts_SDP_rtpmap(mgcp_conn.rtp_pt,
251 mgcp_conn.mime_type & "/" &
252 int2str(mgcp_conn.sample_rate))),
253 valueof(ts_SDP_ptime(mgcp_conn.ptime)) } ));
Harald Welte363cb0a2018-01-30 19:35:53 +0100254 var template MgcpResponse mgcp_resp;
255 mgcp_resp := ts_CRCX_ACK(mgcp_cmd.line.trans_id, mgcp_conn.conn_id, sdp);
256 f_mgcp_par_append(mgcp_resp.params, ts_MgcpParSpecEP(g_media.mgcp_ep));
257 MGCP.send(mgcp_resp);
Harald Welte211219e2018-01-29 22:03:36 +0100258 g_media.mgcp_conn[cid].crcx_seen := true;
259 repeat;
260 }
261 [] MGCP.receive(tr_MDCX) -> value mgcp_cmd {
262 var SDP_Message sdp;
263 var integer cid := f_get_mgcp_conn(f_MgcpCmd_extract_conn_id(mgcp_cmd));
264 if (isvalue(mgcp_cmd.sdp)) {
265 sdp := mgcp_cmd.sdp;
266 g_media.mgcp_conn[cid].peer.host := sdp.connection.conn_addr.addr;
267 g_media.mgcp_conn[cid].peer.port_nr := sdp.media_list[0].media_field.ports.port_number;
268 } else {
269 setverdict(fail, "MDCX has no [recognizable] SDP");
Harald Welte211219e2018-01-29 22:03:36 +0100270 }
271 var MgcpConnState mgcp_conn := g_media.mgcp_conn[cid];
272 sdp := valueof(ts_SDP(mgcp_conn.peer.host, mgcp_conn.peer.host, "foo", "21",
273 mgcp_conn.peer.port_nr, { int2str(mgcp_conn.rtp_pt) },
274 {valueof(ts_SDP_rtpmap(mgcp_conn.rtp_pt,
275 mgcp_conn.mime_type & "/" &
276 int2str(mgcp_conn.sample_rate))),
277 valueof(ts_SDP_ptime(mgcp_conn.ptime)) } ));
278 MGCP.send(ts_MDCX_ACK(mgcp_cmd.line.trans_id, mgcp_conn.conn_id, sdp));
Harald Welte261af4b2018-02-12 21:20:39 +0100279 //g_media.mgcp_mdcx_seen := true;
Harald Welte211219e2018-01-29 22:03:36 +0100280 repeat;
281 }
282}
283
284
285
286
Harald Welte28d943e2017-11-25 15:00:50 +0100287/* this component represents a single subscriber connection at the MSC.
288 * There is a 1:1 mapping between SCCP connections and BSSAP_ConnHdlr components.
289 * We inherit all component variables, ports, functions, ... from BSSAP_ConnHdlr */
Daniel Willmann191e0d92018-01-17 12:44:35 +0100290type component MSC_ConnHdlr extends BSSAP_ConnHdlr, RSL_DchanHdlr, MGCP_ConnHdlr {
Harald Welte28d943e2017-11-25 15:00:50 +0100291 /* SCCP Connecction Identifier for the underlying SCCP connection */
292 var integer g_sccp_conn_id;
293
Harald Weltec1a2fff2017-12-17 11:06:19 +0100294 /* procedure port back to our parent (BSSMAP_Emulation_CT) for control */
295 port BSSMAPEM_PROC_PT BSSMAPEM;
Harald Weltec20b1c42018-02-12 20:50:08 +0100296 port TELNETasp_PT BSCVTY;
Harald Welte28d943e2017-11-25 15:00:50 +0100297
Harald Welte211219e2018-01-29 22:03:36 +0100298 var MediaState g_media;
Harald Weltea0630032018-03-20 21:09:55 +0100299 var TestHdlrParams g_pars;
Harald Weltee97eab42018-03-21 18:46:06 +0100300
301 var boolean g_vty_initialized := false;
Harald Welte211219e2018-01-29 22:03:36 +0100302}
303
304/* initialize all parameters */
305function f_MscConnHdlr_init(integer i, HostName bts, HostName mgw) runs on MSC_ConnHdlr {
306 f_MediaState_init(g_media, i, bts, mgw);
Harald Weltee97eab42018-03-21 18:46:06 +0100307 if (not g_vty_initialized) {
308 map(self:BSCVTY, system:BSCVTY);
309 f_vty_set_prompts(BSCVTY);
310 f_vty_transceive(BSCVTY, "enable");
311 g_vty_initialized := true;
312 }
Harald Welte28d943e2017-11-25 15:00:50 +0100313}
314
315/* Callback function from general BSSMAP_Emulation whenever a connectionless
316 * BSSMAP message arrives. Can retunr a PDU_BSSAP that should be sent in return */
317private function UnitdataCallback(PDU_BSSAP bssap)
318runs on BSSMAP_Emulation_CT return template PDU_BSSAP {
319 var template PDU_BSSAP resp := omit;
320
Harald Weltec1a2fff2017-12-17 11:06:19 +0100321 /* answer all RESET with a RESET ACK */
Harald Welte28d943e2017-11-25 15:00:50 +0100322 if (match(bssap, tr_BSSMAP_Reset)) {
323 resp := ts_BSSMAP_ResetAck;
324 }
325
326 return resp;
327}
328
329const BssmapOps MSC_BssmapOps := {
Harald Weltec1a2fff2017-12-17 11:06:19 +0100330 create_cb := refers(BSSMAP_Emulation.ExpectedCreateCallback),
Harald Welte0b476062018-01-21 19:07:32 +0100331 unitdata_cb := refers(UnitdataCallback),
332 decode_dtap := false,
333 role_ms := false
Harald Welte28d943e2017-11-25 15:00:50 +0100334}
335
Daniel Willmann191e0d92018-01-17 12:44:35 +0100336const MGCPOps MSC_MGCPOps := {
337 create_cb := refers(MGCP_Emulation.ExpectedCreateCallback)
338}
339
Harald Weltec1a2fff2017-12-17 11:06:19 +0100340/* register an expect with the BSSMAP core */
Daniel Willmann191e0d92018-01-17 12:44:35 +0100341private function f_create_bssmap_exp(octetstring l3_enc) runs on MSC_ConnHdlr {
Harald Weltec1a2fff2017-12-17 11:06:19 +0100342 BSSMAPEM.call(BSSMAPEM_register:{l3_enc, self}) {
343 [] BSSMAPEM.getreply(BSSMAPEM_register:{?, ?}) {};
Harald Welte28d943e2017-11-25 15:00:50 +0100344 }
345}
346
Harald Weltec1a2fff2017-12-17 11:06:19 +0100347type record TestHdlrParams {
348 OCT1 ra,
349 GsmFrameNumber fn,
350 hexstring imsi,
351 RslLinkId link_id
352};
353
354template (value) TestHdlrParams t_def_TestHdlrPars := {
355 ra := '23'O,
356 fn := 23,
357 imsi := '001019876543210'H,
358 link_id := valueof(ts_RslLinkID_DCCH(0))
359}
360
Harald Weltea0630032018-03-20 21:09:55 +0100361function f_create_chan_and_exp() runs on MSC_ConnHdlr {
362 var MobileIdentityLV mi := valueof(ts_MI_IMSI_LV(g_pars.imsi));
Harald Welte6ed6bf92018-01-24 21:09:15 +0100363 var PDU_ML3_MS_NW l3_info := valueof(ts_CM_SERV_REQ(CM_TYPE_MO_CALL, mi));
Harald Weltec1a2fff2017-12-17 11:06:19 +0100364 var octetstring l3_enc := enc_PDU_ML3_MS_NW(l3_info);
365
366 /* call helper function for CHAN_RQD -> IMM ASS ->EST_IND */
Harald Weltea0630032018-03-20 21:09:55 +0100367 RSL_Emulation.f_chan_est(g_pars.ra, l3_enc, g_pars.link_id, g_pars.fn);
Daniel Willmann191e0d92018-01-17 12:44:35 +0100368 f_create_bssmap_exp(l3_enc);
Harald Weltec1a2fff2017-12-17 11:06:19 +0100369}
370
Harald Welte898113b2018-01-31 18:32:21 +0100371function f_rsl_send_l3(template PDU_ML3_MS_NW l3, template (omit) RslLinkId link_id := omit,
372 template (omit) RslChannelNr chan_nr := omit) runs on MSC_ConnHdlr {
373 if (not isvalue(link_id)) {
374 link_id := ts_RslLinkID_DCCH(0);
375 }
376 if (not isvalue(chan_nr)) {
377 chan_nr := g_chan_nr;
378 }
379 RSL.send(ts_RSL_DATA_IND(valueof(chan_nr), valueof(link_id), enc_PDU_ML3_MS_NW(valueof(l3))));
380}
381
Harald Weltec1a2fff2017-12-17 11:06:19 +0100382function f_rsl_reply(template PDU_ML3_MS_NW l3, RSL_Message orig) runs on MSC_ConnHdlr {
383 var RslChannelNr chan_nr := orig.ies[0].body.chan_nr;
Harald Welte1a40de62017-12-23 02:28:34 +0100384 var RslLinkId link_id;
Harald Welte8d5eead2017-12-17 18:56:45 +0100385 if (orig.msg_type == RSL_MT_ENCR_CMD) {
386 link_id := orig.ies[2].body.link_id;
387 } else {
388 link_id := orig.ies[1].body.link_id;
389 }
Harald Welte898113b2018-01-31 18:32:21 +0100390 f_rsl_send_l3(l3, link_id, chan_nr);
Harald Weltec1a2fff2017-12-17 11:06:19 +0100391}
392
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100393/* Convert the chipher representation on BSSMAP to the representation used on RSL */
394function f_chipher_mode_bssmap_to_rsl(OCT1 alg_bssmap) return OCT1
395{
396 /* A5 0 */
397 if (alg_bssmap == '01'O) {
398 return '01'O;
399 }
400 /* A5 1 */
401 else if (alg_bssmap == '02'O) {
402 return '02'O;
403 }
404 /* A5 2 */
405 else if (alg_bssmap == '04'O) {
406 return '03'O;
407 }
408 /* A5 3 */
409 else if (alg_bssmap == '08'O) {
410 return '04'O;
411 }
412 /* A5 4 */
413 else if (alg_bssmap == '10'O) {
414 return '05'O;
415 }
416 /* A5 5 */
417 else if (alg_bssmap == '20'O) {
418 return '06'O;
419 }
420 /* A5 6 */
421 else if (alg_bssmap == '40'O) {
422 return '07'O;
423 }
424 /* A5 7 */
425 else if (alg_bssmap == '80'O) {
426 return '08'O;
427 } else {
428 setverdict(fail, "Unexpected Encryption Algorithm");
429 return '00'O;
430 }
431}
432
Harald Welte38b2a102017-12-23 02:42:58 +0100433function f_cipher_mode(OCT1 alg, OCT8 key, template OCT16 kc128 := omit, boolean exp_fail := false)
434runs on MSC_ConnHdlr {
Harald Welte73cd2712017-12-17 00:44:52 +0100435 var PDU_BSSAP bssap;
436 var RSL_Message rsl;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100437 var OCT1 alg_rsl;
Harald Welte73cd2712017-12-17 00:44:52 +0100438
439 if (isvalue(kc128)) {
440 BSSAP.send(ts_BSSMAP_CipherModeCmdKc128(alg, key, valueof(kc128)));
441 } else {
442 BSSAP.send(ts_BSSMAP_CipherModeCmd(alg, key));
443 }
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100444
445 /* RSL uses a different representation of the encryption algorithm,
446 * so we need to convert first */
447 alg_rsl := f_chipher_mode_bssmap_to_rsl(alg);
448
Harald Welte73cd2712017-12-17 00:44:52 +0100449 alt {
450 /* RSL/UE Side */
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100451 [] RSL.receive(tr_RSL_ENCR_CMD(g_chan_nr, ?, alg_rsl, key)) -> value rsl {
Harald Welte73cd2712017-12-17 00:44:52 +0100452 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[3].body.l3_info.payload);
453 log("Rx L3 from net: ", l3);
454 if (ischosen(l3.msgs.rrm.cipheringModeCommand)) {
455 f_rsl_reply(ts_RRM_CiphModeCompl, rsl);
456 }
457 repeat;
458 }
459 [] BSSAP.receive(tr_BSSMAP_CipherModeCompl) -> value bssap {
460 // bssap.bssmap.cipherModeComplete.chosenEncryptionAlgorithm.algoritmhIdentifier
Harald Welte38b2a102017-12-23 02:42:58 +0100461 if (exp_fail == true) {
462 setverdict(fail, "Unexpected Cipher Mode Complete");
463 } else {
464 setverdict(pass);
465 }
Harald Welte73cd2712017-12-17 00:44:52 +0100466 }
467 [] BSSAP.receive(tr_BSSMAP_CipherModeRej) -> value bssap {
Harald Welte38b2a102017-12-23 02:42:58 +0100468 if (exp_fail == false) {
469 setverdict(fail, "Ciphering Mode Reject");
470 } else {
471 setverdict(pass);
472 }
Harald Welte73cd2712017-12-17 00:44:52 +0100473 }
474 }
475}
476
Harald Welte211219e2018-01-29 22:03:36 +0100477/* Convert from Ericsson ChanDesc2 format to Osmocom RslChannelNr format */
478function f_ChDesc2RslChanNr(ChannelDescription2_V ch_desc, out RslChannelNr chan_nr, out GsmArfcn arfcn) {
479 var BIT5 inp := ch_desc.channelTypeandTDMAOffset;
480
481 chan_nr.tn := bit2int(ch_desc.timeslotNumber);
482
483 if (match(inp, '00001'B)) { /* TCH/F */
484 chan_nr.u.ch0 := RSL_CHAN_NR_Bm_ACCH;
485 }
486 else if (match(inp, '0001?'B)) { /* TCH/H */
487 chan_nr.u.lm.sub_chan := bit2int(substr(inp, 4, 1));
488 }
489 else if (match(inp, '001??'B)) { /* SDCCH/4 */
490 chan_nr.u.sdcch4.sub_chan := bit2int(substr(inp, 3, 2));
491 }
492 else if (match(inp, '01???'B)) { /* SDCCH/8 */
493 chan_nr.u.sdcch8.sub_chan := bit2int(substr(inp, 2, 3));
494 }
495 else {
496 setverdict(fail, "Unknown ChDesc!");
497 self.stop;
498 }
499
500 if (ch_desc.octet3 and4b '10'O == '10'O) {
501 setverdict(fail, "No support for Hopping");
502 self.stop;
503 } else {
504 var OCT2 concat := ch_desc.octet3 & ch_desc.octet4;
505 arfcn := oct2int(concat);
506 }
507}
508
509type record AssignmentState {
510 /* global */
511 boolean voice_call,
512 boolean is_assignment,
513 /* Assignment related bits */
514 boolean rr_ass_cmpl_seen,
Harald Welte21583082018-01-29 22:28:26 +0100515 boolean assignment_done,
Harald Welte211219e2018-01-29 22:03:36 +0100516 RslChannelNr old_chan_nr,
517 /* Modify related bits */
518 boolean rr_modify_seen,
Harald Welte21583082018-01-29 22:28:26 +0100519 boolean modify_done
Harald Welte211219e2018-01-29 22:03:36 +0100520}
521
522template (value) AssignmentState ts_AssignmentStateInit := {
523 voice_call := false,
524 is_assignment := false,
525 rr_ass_cmpl_seen := false,
Harald Welte21583082018-01-29 22:28:26 +0100526 assignment_done := false,
Harald Welte211219e2018-01-29 22:03:36 +0100527 old_chan_nr := -,
528 rr_modify_seen := false,
Harald Welte21583082018-01-29 22:28:26 +0100529 modify_done := false
Harald Welte211219e2018-01-29 22:03:36 +0100530}
531
532altstep as_assignment(inout AssignmentState st) runs on MSC_ConnHdlr {
Harald Weltec1a2fff2017-12-17 11:06:19 +0100533 var RSL_Message rsl;
Harald Welte211219e2018-01-29 22:03:36 +0100534 [not st.rr_ass_cmpl_seen] RSL.receive(tr_RSL_DATA_REQ(g_chan_nr)) -> value rsl {
535 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[2].body.l3_info.payload);
536 log("Rx L3 from net: ", l3);
537 if (ischosen(l3.msgs.rrm.assignmentCommand)) {
538 var RslChannelNr new_chan_nr;
539 var GsmArfcn arfcn;
540 f_ChDesc2RslChanNr(l3.msgs.rrm.assignmentCommand.descrOf1stChAfterTime,
541 new_chan_nr, arfcn);
542 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
Harald Weltec1a2fff2017-12-17 11:06:19 +0100543
Harald Welte211219e2018-01-29 22:03:36 +0100544 /* register our component for this channel number at the RSL Emulation */
545 f_rslem_register(0, new_chan_nr);
546 var PDU_ML3_MS_NW l3_tx := valueof(ts_RRM_AssignmentComplete('00'O));
547 /* send assignment complete over the new channel */
548 RSL.send(ts_RSL_DATA_IND(new_chan_nr, valueof(ts_RslLinkID_DCCH(0)),
549 enc_PDU_ML3_MS_NW(l3_tx)));
550 /* by default, send via the new channel from now */
551 st.old_chan_nr := g_chan_nr;
552 g_chan_nr := new_chan_nr;
553 st.rr_ass_cmpl_seen := true;
554 repeat;
555 } else {
556 setverdict(fail, "Unexpected L3 received", l3);
557 self.stop;
Harald Weltec1a2fff2017-12-17 11:06:19 +0100558 }
Harald Welte211219e2018-01-29 22:03:36 +0100559 }
560 [st.rr_ass_cmpl_seen] RSL.receive(tr_RSL_REL_REQ(st.old_chan_nr, tr_RslLinkID_DCCH(0))) {
561 RSL.send(ts_RSL_REL_CONF(st.old_chan_nr, valueof(ts_RslLinkID_DCCH(0))));
562 repeat;
563 }
564 [st.rr_ass_cmpl_seen] RSL.receive(tr_RSL_RF_CHAN_REL(st.old_chan_nr)) {
565 RSL.send(ts_RSL_RF_CHAN_REL_ACK(st.old_chan_nr));
Harald Welte1909f462018-01-29 22:29:29 +0100566 /* unregister for old channel number in RSL emulation */
567 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
568 f_rslem_unregister(0, st.old_chan_nr);
Harald Welte21583082018-01-29 22:28:26 +0100569 st.assignment_done := true;
Harald Welte211219e2018-01-29 22:03:36 +0100570 repeat;
571 }
572}
573
574altstep as_modify(inout AssignmentState st) runs on MSC_ConnHdlr {
575 /* no assignment, just mode modify */
576 var RSL_Message rsl;
577
578 [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 +0100579 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[2].body.l3_info.payload);
580 log("Rx L3 from net: ", l3);
581 if (ischosen(l3.msgs.rrm.channelModeModify)) {
582 f_rsl_reply(ts_RRM_ModeModifyAck(l3.msgs.rrm.channelModeModify.channelDescription,
583 l3.msgs.rrm.channelModeModify.channelMode), rsl);
Harald Welte211219e2018-01-29 22:03:36 +0100584 st.rr_modify_seen := true;
Harald Weltec1a2fff2017-12-17 11:06:19 +0100585 }
586 repeat;
587 }
Harald Welte211219e2018-01-29 22:03:36 +0100588 [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 +0100589 RSL.send(ts_RSL_MODE_MODIFY_ACK(g_chan_nr));
Harald Welte21583082018-01-29 22:28:26 +0100590 st.modify_done := true;
Harald Weltec1a2fff2017-12-17 11:06:19 +0100591 repeat;
592 }
Harald Welte211219e2018-01-29 22:03:36 +0100593}
Daniel Willmann191e0d92018-01-17 12:44:35 +0100594
Harald Welte211219e2018-01-29 22:03:36 +0100595/* Determine if given rsl_chan_nr is compatible with given BSSMAP ChannelType */
596function f_channel_compatible(BSSMAP_IE_ChannelType bssmap, RslChannelNr rsl_chan_nr)
597return boolean {
598 select (bssmap.speechOrDataIndicator) {
599 case ('0011'B) { /* Signalling */
600 /* all channels support signalling */
601 return true;
602 }
603 case else { /* Speech, Speech+CTM or CSD */
604 select (bssmap.channelRateAndType) {
605 case ('08'O) { /* TCH/F */
606 select (rsl_chan_nr) {
607 case (t_RslChanNr_Bm(?)) { return true; }
608 }
609 }
610 case ('09'O) { /* TCH/H */
611 select (rsl_chan_nr) {
612 case (t_RslChanNr_Lm(?, ?)) { return true; }
613 }
614 }
615 case else { /* full or half-rate */
616 select (rsl_chan_nr) {
617 case (t_RslChanNr_Bm(?)) { return true; }
618 case (t_RslChanNr_Lm(?, ?)) { return true; }
619 }
620 }
621 }
Harald Weltec1a2fff2017-12-17 11:06:19 +0100622 }
Harald Welte211219e2018-01-29 22:03:36 +0100623 }
624 return false;
625}
Daniel Willmann191e0d92018-01-17 12:44:35 +0100626
Harald Welte211219e2018-01-29 22:03:36 +0100627/* establish a channel fully, expecting an assignment matching 'exp' */
Harald Weltea0630032018-03-20 21:09:55 +0100628function f_establish_fully(PDU_BSSAP ass_cmd, template PDU_BSSAP exp_ass_cpl)
Harald Welte211219e2018-01-29 22:03:36 +0100629runs on MSC_ConnHdlr return PDU_BSSAP {
630 var PDU_BSSAP bssap;
631 timer T := 10.0;
632 var boolean exp_compl := ischosen(exp_ass_cpl.pdu.bssmap.assignmentComplete);
Philipp Maier86f39202018-02-07 14:40:09 +0100633 var boolean exp_fail := ischosen(exp_ass_cpl.pdu.bssmap.assignmentFailure);
Harald Welte211219e2018-01-29 22:03:36 +0100634 var ExpectCriteria mgcpcrit := {
635 connid := omit,
636 endpoint := omit,
637 transid := omit
638 };
639 var AssignmentState st := valueof(ts_AssignmentStateInit);
640 /* if the channel type is SIGNAL, we're not handling a voice call */
641 if (ass_cmd.pdu.bssmap.assignmentRequest.channelType.speechOrDataIndicator != '0011'B) {
642 st.voice_call := true;
643 }
644 /* determine if the current channel can support the given service or not */
645 if (not f_channel_compatible(ass_cmd.pdu.bssmap.assignmentRequest.channelType, g_chan_nr)) {
646 st.is_assignment := true;
647 }
648
Harald Weltec20b1c42018-02-12 20:50:08 +0100649 f_MscConnHdlr_init(1, "127.0.0.2", "127.0.0.3");
Harald Welte211219e2018-01-29 22:03:36 +0100650
Harald Weltea0630032018-03-20 21:09:55 +0100651 f_create_chan_and_exp();
Harald Welte211219e2018-01-29 22:03:36 +0100652 /* we should now have a COMPL_L3 at the MSC */
653 BSSAP.receive(tr_BSSMAP_ComplL3);
654 f_create_mgcp_expect(mgcpcrit);
655 BSSAP.send(ass_cmd);
656
657 T.start;
658 alt {
659 /* assignment related bits */
660 [st.is_assignment] as_assignment(st);
661
662 /* modify related bits */
663 [not st.is_assignment] as_modify(st);
664
665 /* voice call related bits (IPA CRCX/MDCX + MGCP) */
666 [st.voice_call] as_Media();
667
668 /* if we receive exactly what we expected, always return + pass */
Harald Welte21583082018-01-29 22:28:26 +0100669 [st.is_assignment and st.assignment_done or
670 (not st.is_assignment and st.modify_done)] BSSAP.receive(exp_ass_cpl) -> value bssap {
Harald Welte211219e2018-01-29 22:03:36 +0100671 setverdict(pass);
672 }
Philipp Maier86f39202018-02-07 14:40:09 +0100673 [exp_fail] BSSAP.receive(exp_ass_cpl) -> value bssap {
674 setverdict(pass);
675 }
Harald Welte21583082018-01-29 22:28:26 +0100676 [(st.is_assignment and st.assignment_done or
677 (not st.is_assignment and st.modify_done)) and
678 exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentComplete) {
Harald Weltec1a2fff2017-12-17 11:06:19 +0100679 setverdict(fail, "Received non-matching ASSIGNMENT COMPLETE");
680 }
681 [exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentFail) {
682 setverdict(fail, "Received unexpected ASSIGNMENT FAIL");
683 }
684 [not exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentComplete) {
685 setverdict(fail, "Received unexpected ASSIGNMENT COMPLETE");
686 }
687 [not exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentFail) {
688 setverdict(fail, "Received non-matching ASSIGNMENT FAIL");
689 }
690 [] T.timeout {
Harald Welte458fd372018-03-21 11:26:23 +0100691 setverdict(fail, "Timeout waiting for ASSIGNMENT COMPLETE");
Harald Weltec1a2fff2017-12-17 11:06:19 +0100692 }
693 }
Harald Welte211219e2018-01-29 22:03:36 +0100694 log("g_media ", g_media);
695 if (not isbound(bssap)) {
696 self.stop;
697 }
698 return bssap;
Harald Weltec1a2fff2017-12-17 11:06:19 +0100699}
700
Harald Welte261af4b2018-02-12 21:20:39 +0100701type record HandoverState {
702 /* Assignment related bits */
703 boolean rr_ho_cmpl_seen,
704 boolean handover_done,
705 RslChannelNr old_chan_nr
706};
707
708altstep as_handover(inout HandoverState st) runs on MSC_ConnHdlr {
709 var RSL_Message rsl;
710 [not st.rr_ho_cmpl_seen] RSL.receive(tr_RSL_DATA_REQ(g_chan_nr)) -> value rsl {
711 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[2].body.l3_info.payload);
712 log("Rx L3 from net: ", l3);
713 if (ischosen(l3.msgs.rrm.handoverCommand)) {
714 var RslChannelNr new_chan_nr;
715 var GsmArfcn arfcn;
716 f_ChDesc2RslChanNr(l3.msgs.rrm.handoverCommand.channelDescription2,
717 new_chan_nr, arfcn);
718 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
719
720 /* register our component for this channel number at the RSL Emulation */
721 f_rslem_register(0, new_chan_nr, RSL1_PROC);
722
723 /* resume processing of RSL DChan messages, which was temporarily suspended
724 * before performing a hand-over */
725 f_rslem_resume(RSL1_PROC);
726
727 /* send handover complete over the new channel */
728 var PDU_ML3_MS_NW l3_tx := valueof(ts_RRM_HandoverComplete('00'O));
729 RSL1.send(ts_RSL_DATA_IND(new_chan_nr, valueof(ts_RslLinkID_DCCH(0)),
730 enc_PDU_ML3_MS_NW(l3_tx)));
731 /* by default, send via the new channel from now */
732 st.old_chan_nr := g_chan_nr;
733 g_chan_nr := new_chan_nr;
734 st.rr_ho_cmpl_seen := true;
735 repeat;
736 } else {
737 setverdict(fail, "Unexpected L3 received", l3);
738 self.stop;
739 }
740 }
741 [st.rr_ho_cmpl_seen] as_Media();
742 [st.rr_ho_cmpl_seen] RSL.receive(tr_RSL_REL_REQ(st.old_chan_nr, tr_RslLinkID_DCCH(0))) {
743 RSL.send(ts_RSL_REL_CONF(st.old_chan_nr, valueof(ts_RslLinkID_DCCH(0))));
744 repeat;
745 }
746 [st.rr_ho_cmpl_seen] RSL.receive(tr_RSL_RF_CHAN_REL(st.old_chan_nr)) {
747 RSL.send(ts_RSL_RF_CHAN_REL_ACK(st.old_chan_nr));
748 /* unregister for old channel number in RSL emulation */
749 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
750 f_rslem_unregister(0, st.old_chan_nr);
751 st.handover_done := true;
Harald Welte261af4b2018-02-12 21:20:39 +0100752 }
753}
754
755
Harald Weltec1a2fff2017-12-17 11:06:19 +0100756
Harald Welte28d943e2017-11-25 15:00:50 +0100757}