blob: c1ff963694f1bc89525c38664bb19864510bf18e [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;
Harald Welte211219e2018-01-29 22:03:36 +0100122}
123
124private function f_get_mgcp_conn(MgcpConnectionId cid) runs on MSC_ConnHdlr return integer {
125 for (var integer i:= 0; i < sizeof(g_media.mgcp_conn); i := i+1) {
126 if (g_media.mgcp_conn[i].conn_id == cid and g_media.mgcp_conn[i].crcx_seen) {
127 return i;
128 }
129 }
130 setverdict(fail, "No Connection for ID ", cid);
131 self.stop;
Harald Welte211219e2018-01-29 22:03:36 +0100132}
133
134
135/* altstep for handling of IPA + MGCP media related commands. Can be activated by a given
136 * test case if it expects to see media related handling (i.e. voice calls */
137altstep as_Media() runs on MSC_ConnHdlr {
138 var RSL_Message rsl;
139 var MgcpCommand mgcp_cmd;
140 var RSL_IE_Body ie;
Harald Welte930d0a72018-03-22 22:08:40 +0100141 var boolean b_unused;
Harald Welte211219e2018-01-29 22:03:36 +0100142 [not g_media.bts.ipa_crcx_seen] RSL.receive(tr_RSL_IPA_CRCX(g_chan_nr)) -> value rsl {
143 /* Extract parameters from request + use in response */
144 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
145 g_media.bts.rtp_pt := ie.ipa_rtp_pt;
146 }
147 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
148 g_media.bts.rtp_pt := ie.ipa_rtp_pt2;
149 }
150 RSL.send(ts_RSL_IPA_CRCX_ACK(g_chan_nr, g_media.bts.conn_id,
151 oct2int(f_inet_addr(g_media.bts.bts.host)),
152 g_media.bts.bts.port_nr,
153 g_media.bts.rtp_pt));
154 g_media.bts.ipa_crcx_seen := true;
155 repeat;
156 }
157 [g_media.bts.ipa_crcx_seen] RSL.receive(tr_RSL_IPA_MDCX(g_chan_nr, ?)) -> value rsl{
158 /* Extract conn_id, ip, port, rtp_pt2 from request + use in response */
Harald Welte930d0a72018-03-22 22:08:40 +0100159 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_CONN_ID, ie);
Harald Welte211219e2018-01-29 22:03:36 +0100160 if (g_media.bts.conn_id != ie.ipa_conn_id) {
161 setverdict(fail, "IPA MDCX for unknown ConnId", rsl);
162 self.stop;
163 }
164 /* mandatory */
Harald Welte930d0a72018-03-22 22:08:40 +0100165 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_IP, ie);
Harald Welte211219e2018-01-29 22:03:36 +0100166 g_media.bts.peer.host := f_inet_ntoa(int2oct(ie.ipa_remote_ip, 4));
Harald Welte930d0a72018-03-22 22:08:40 +0100167 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_PORT, ie);
Harald Welte211219e2018-01-29 22:03:36 +0100168 g_media.bts.peer.port_nr := ie.ipa_remote_port;
169 /* optional */
170 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
171 g_media.bts.rtp_pt := ie.ipa_rtp_pt;
172 }
173 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
174 g_media.bts.rtp_pt := ie.ipa_rtp_pt2;
175 }
176 RSL.send(ts_RSL_IPA_MDCX_ACK(g_chan_nr, g_media.bts.conn_id,
177 oct2int(f_inet_addr(g_media.bts.peer.host)),
178 g_media.bts.peer.port_nr,
179 g_media.bts.rtp_pt));
Harald Welte261af4b2018-02-12 21:20:39 +0100180 //g_media.bts.ipa_mdcx_seen := true;
Harald Welte211219e2018-01-29 22:03:36 +0100181 repeat;
182 }
Harald Welte261af4b2018-02-12 21:20:39 +0100183
184 /* on second (new) BTS during hand-over */
185 [not g_media.bts1.ipa_crcx_seen] RSL1.receive(tr_RSL_IPA_CRCX(g_chan_nr)) -> value rsl {
186 /* Extract parameters from request + use in response */
187 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
188 g_media.bts1.rtp_pt := ie.ipa_rtp_pt;
189 }
190 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
191 g_media.bts1.rtp_pt := ie.ipa_rtp_pt2;
192 }
193 RSL1.send(ts_RSL_IPA_CRCX_ACK(g_chan_nr, g_media.bts1.conn_id,
194 oct2int(f_inet_addr(g_media.bts1.bts.host)),
195 g_media.bts1.bts.port_nr,
196 g_media.bts1.rtp_pt));
197 g_media.bts1.ipa_crcx_seen := true;
198 repeat;
199 }
200 /* on second (new) BTS during hand-over */
201 [g_media.bts1.ipa_crcx_seen] RSL1.receive(tr_RSL_IPA_MDCX(g_chan_nr, ?)) -> value rsl{
202 /* Extract conn_id, ip, port, rtp_pt2 from request + use in response */
Harald Welte930d0a72018-03-22 22:08:40 +0100203 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_CONN_ID, ie);
Harald Welte261af4b2018-02-12 21:20:39 +0100204 if (g_media.bts1.conn_id != ie.ipa_conn_id) {
205 setverdict(fail, "IPA MDCX for unknown ConnId", rsl);
206 self.stop;
207 }
208 /* mandatory */
Harald Welte930d0a72018-03-22 22:08:40 +0100209 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_IP, ie);
Harald Welte261af4b2018-02-12 21:20:39 +0100210 g_media.bts1.peer.host := f_inet_ntoa(int2oct(ie.ipa_remote_ip, 4));
Harald Welte930d0a72018-03-22 22:08:40 +0100211 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_PORT, ie);
Harald Welte261af4b2018-02-12 21:20:39 +0100212 g_media.bts1.peer.port_nr := ie.ipa_remote_port;
213 /* optional */
214 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
215 g_media.bts1.rtp_pt := ie.ipa_rtp_pt;
216 }
217 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
218 g_media.bts1.rtp_pt := ie.ipa_rtp_pt2;
219 }
220 RSL1.send(ts_RSL_IPA_MDCX_ACK(g_chan_nr, g_media.bts1.conn_id,
221 oct2int(f_inet_addr(g_media.bts1.peer.host)),
222 g_media.bts1.peer.port_nr,
223 g_media.bts1.rtp_pt));
224 //g_media.bts1.ipa_mdcx_seen := true;
225 repeat;
226 }
227
Harald Welte211219e2018-01-29 22:03:36 +0100228 [] MGCP.receive(tr_CRCX) -> value mgcp_cmd {
229 var SDP_Message sdp;
230 var integer cid := f_get_free_mgcp_conn();
Harald Welte363cb0a2018-01-30 19:35:53 +0100231 if (match(mgcp_cmd.line.ep, t_MGCP_EP_wildcard)) {
232 if (cid != 0) {
233 setverdict(fail, "MGCP wildcard EP only works in first CRCX");
234 self.stop;
235 }
236 /* we keep the endpoint name allocated during MediaState_init */
237 } else {
238 /* Call Agent allocated endpoint, trust/use it always */
239 g_media.mgcp_ep := mgcp_cmd.line.ep;
240 }
Harald Welte211219e2018-01-29 22:03:36 +0100241 if (isvalue(mgcp_cmd.sdp)) {
242 sdp := mgcp_cmd.sdp;
243 g_media.mgcp_conn[cid].peer.host := sdp.connection.conn_addr.addr;
244 g_media.mgcp_conn[cid].peer.port_nr := sdp.media_list[0].media_field.ports.port_number;
245 }
246 var MgcpConnState mgcp_conn := g_media.mgcp_conn[cid];
247 sdp := valueof(ts_SDP(mgcp_conn.mgw.host, mgcp_conn.mgw.host, "foo", "21",
248 mgcp_conn.mgw.port_nr, { int2str(mgcp_conn.rtp_pt) },
249 {valueof(ts_SDP_rtpmap(mgcp_conn.rtp_pt,
250 mgcp_conn.mime_type & "/" &
251 int2str(mgcp_conn.sample_rate))),
252 valueof(ts_SDP_ptime(mgcp_conn.ptime)) } ));
Harald Welte363cb0a2018-01-30 19:35:53 +0100253 var template MgcpResponse mgcp_resp;
254 mgcp_resp := ts_CRCX_ACK(mgcp_cmd.line.trans_id, mgcp_conn.conn_id, sdp);
255 f_mgcp_par_append(mgcp_resp.params, ts_MgcpParSpecEP(g_media.mgcp_ep));
256 MGCP.send(mgcp_resp);
Harald Welte211219e2018-01-29 22:03:36 +0100257 g_media.mgcp_conn[cid].crcx_seen := true;
258 repeat;
259 }
260 [] MGCP.receive(tr_MDCX) -> value mgcp_cmd {
261 var SDP_Message sdp;
262 var integer cid := f_get_mgcp_conn(f_MgcpCmd_extract_conn_id(mgcp_cmd));
263 if (isvalue(mgcp_cmd.sdp)) {
264 sdp := mgcp_cmd.sdp;
265 g_media.mgcp_conn[cid].peer.host := sdp.connection.conn_addr.addr;
266 g_media.mgcp_conn[cid].peer.port_nr := sdp.media_list[0].media_field.ports.port_number;
267 } else {
268 setverdict(fail, "MDCX has no [recognizable] SDP");
Harald Welte211219e2018-01-29 22:03:36 +0100269 }
270 var MgcpConnState mgcp_conn := g_media.mgcp_conn[cid];
271 sdp := valueof(ts_SDP(mgcp_conn.peer.host, mgcp_conn.peer.host, "foo", "21",
272 mgcp_conn.peer.port_nr, { int2str(mgcp_conn.rtp_pt) },
273 {valueof(ts_SDP_rtpmap(mgcp_conn.rtp_pt,
274 mgcp_conn.mime_type & "/" &
275 int2str(mgcp_conn.sample_rate))),
276 valueof(ts_SDP_ptime(mgcp_conn.ptime)) } ));
277 MGCP.send(ts_MDCX_ACK(mgcp_cmd.line.trans_id, mgcp_conn.conn_id, sdp));
Harald Welte261af4b2018-02-12 21:20:39 +0100278 //g_media.mgcp_mdcx_seen := true;
Harald Welte211219e2018-01-29 22:03:36 +0100279 repeat;
280 }
281}
282
283
284
285
Harald Welte28d943e2017-11-25 15:00:50 +0100286/* this component represents a single subscriber connection at the MSC.
287 * There is a 1:1 mapping between SCCP connections and BSSAP_ConnHdlr components.
288 * We inherit all component variables, ports, functions, ... from BSSAP_ConnHdlr */
Daniel Willmann191e0d92018-01-17 12:44:35 +0100289type component MSC_ConnHdlr extends BSSAP_ConnHdlr, RSL_DchanHdlr, MGCP_ConnHdlr {
Harald Welte28d943e2017-11-25 15:00:50 +0100290 /* SCCP Connecction Identifier for the underlying SCCP connection */
291 var integer g_sccp_conn_id;
292
Harald Weltec1a2fff2017-12-17 11:06:19 +0100293 /* procedure port back to our parent (BSSMAP_Emulation_CT) for control */
294 port BSSMAPEM_PROC_PT BSSMAPEM;
Harald Weltec20b1c42018-02-12 20:50:08 +0100295 port TELNETasp_PT BSCVTY;
Harald Welte28d943e2017-11-25 15:00:50 +0100296
Harald Welte211219e2018-01-29 22:03:36 +0100297 var MediaState g_media;
Harald Weltea0630032018-03-20 21:09:55 +0100298 var TestHdlrParams g_pars;
Harald Weltee97eab42018-03-21 18:46:06 +0100299
300 var boolean g_vty_initialized := false;
Harald Welte211219e2018-01-29 22:03:36 +0100301}
302
303/* initialize all parameters */
304function f_MscConnHdlr_init(integer i, HostName bts, HostName mgw) runs on MSC_ConnHdlr {
305 f_MediaState_init(g_media, i, bts, mgw);
Harald Weltee97eab42018-03-21 18:46:06 +0100306 if (not g_vty_initialized) {
307 map(self:BSCVTY, system:BSCVTY);
308 f_vty_set_prompts(BSCVTY);
309 f_vty_transceive(BSCVTY, "enable");
310 g_vty_initialized := true;
311 }
Harald Welte28d943e2017-11-25 15:00:50 +0100312}
313
314/* Callback function from general BSSMAP_Emulation whenever a connectionless
315 * BSSMAP message arrives. Can retunr a PDU_BSSAP that should be sent in return */
316private function UnitdataCallback(PDU_BSSAP bssap)
317runs on BSSMAP_Emulation_CT return template PDU_BSSAP {
318 var template PDU_BSSAP resp := omit;
319
Harald Weltec1a2fff2017-12-17 11:06:19 +0100320 /* answer all RESET with a RESET ACK */
Harald Welte28d943e2017-11-25 15:00:50 +0100321 if (match(bssap, tr_BSSMAP_Reset)) {
322 resp := ts_BSSMAP_ResetAck;
323 }
324
325 return resp;
326}
327
328const BssmapOps MSC_BssmapOps := {
Harald Weltec1a2fff2017-12-17 11:06:19 +0100329 create_cb := refers(BSSMAP_Emulation.ExpectedCreateCallback),
Harald Welte0b476062018-01-21 19:07:32 +0100330 unitdata_cb := refers(UnitdataCallback),
331 decode_dtap := false,
Harald Welte930d0a72018-03-22 22:08:40 +0100332 role_ms := false,
333 sccp_addr_local := omit,
334 sccp_addr_peer := omit
Harald Welte28d943e2017-11-25 15:00:50 +0100335}
336
Daniel Willmann191e0d92018-01-17 12:44:35 +0100337const MGCPOps MSC_MGCPOps := {
Harald Welte930d0a72018-03-22 22:08:40 +0100338 create_cb := refers(MGCP_Emulation.ExpectedCreateCallback),
339 unitdata_cb := refers(MGCP_Emulation.DummyUnitdataCallback)
Daniel Willmann191e0d92018-01-17 12:44:35 +0100340}
341
Harald Weltec1a2fff2017-12-17 11:06:19 +0100342/* register an expect with the BSSMAP core */
Daniel Willmann191e0d92018-01-17 12:44:35 +0100343private function f_create_bssmap_exp(octetstring l3_enc) runs on MSC_ConnHdlr {
Harald Weltec1a2fff2017-12-17 11:06:19 +0100344 BSSMAPEM.call(BSSMAPEM_register:{l3_enc, self}) {
345 [] BSSMAPEM.getreply(BSSMAPEM_register:{?, ?}) {};
Harald Welte28d943e2017-11-25 15:00:50 +0100346 }
347}
348
Harald Welte651fcdc2018-05-10 20:23:16 +0200349type record TestHdlrEncrParams {
350 OCT1 enc_alg,
351 octetstring enc_key
352};
353
354template (value) TestHdlrEncrParams t_EncrParams(OCT1 alg, octetstring key) := {
355 enc_alg := alg,
356 enc_key := key
357}
358
Harald Weltec1a2fff2017-12-17 11:06:19 +0100359type record TestHdlrParams {
360 OCT1 ra,
361 GsmFrameNumber fn,
362 hexstring imsi,
Harald Welte60aa5762018-03-21 19:33:13 +0100363 RslLinkId link_id,
Harald Welte651fcdc2018-05-10 20:23:16 +0200364 BSSMAP_IE_SpeechCodecList ass_codec_list optional,
365 TestHdlrEncrParams encr optional
Harald Weltec1a2fff2017-12-17 11:06:19 +0100366};
367
368template (value) TestHdlrParams t_def_TestHdlrPars := {
369 ra := '23'O,
370 fn := 23,
371 imsi := '001019876543210'H,
Harald Welte60aa5762018-03-21 19:33:13 +0100372 link_id := valueof(ts_RslLinkID_DCCH(0)),
Harald Welte651fcdc2018-05-10 20:23:16 +0200373 ass_codec_list := omit,
374 encr := omit
Harald Weltec1a2fff2017-12-17 11:06:19 +0100375}
376
Harald Weltea0630032018-03-20 21:09:55 +0100377function f_create_chan_and_exp() runs on MSC_ConnHdlr {
378 var MobileIdentityLV mi := valueof(ts_MI_IMSI_LV(g_pars.imsi));
Harald Welte6ed6bf92018-01-24 21:09:15 +0100379 var PDU_ML3_MS_NW l3_info := valueof(ts_CM_SERV_REQ(CM_TYPE_MO_CALL, mi));
Harald Weltec1a2fff2017-12-17 11:06:19 +0100380 var octetstring l3_enc := enc_PDU_ML3_MS_NW(l3_info);
381
382 /* call helper function for CHAN_RQD -> IMM ASS ->EST_IND */
Harald Weltea0630032018-03-20 21:09:55 +0100383 RSL_Emulation.f_chan_est(g_pars.ra, l3_enc, g_pars.link_id, g_pars.fn);
Daniel Willmann191e0d92018-01-17 12:44:35 +0100384 f_create_bssmap_exp(l3_enc);
Harald Weltec1a2fff2017-12-17 11:06:19 +0100385}
386
Harald Welte898113b2018-01-31 18:32:21 +0100387function f_rsl_send_l3(template PDU_ML3_MS_NW l3, template (omit) RslLinkId link_id := omit,
388 template (omit) RslChannelNr chan_nr := omit) runs on MSC_ConnHdlr {
389 if (not isvalue(link_id)) {
390 link_id := ts_RslLinkID_DCCH(0);
391 }
392 if (not isvalue(chan_nr)) {
393 chan_nr := g_chan_nr;
394 }
395 RSL.send(ts_RSL_DATA_IND(valueof(chan_nr), valueof(link_id), enc_PDU_ML3_MS_NW(valueof(l3))));
396}
397
Harald Weltec1a2fff2017-12-17 11:06:19 +0100398function f_rsl_reply(template PDU_ML3_MS_NW l3, RSL_Message orig) runs on MSC_ConnHdlr {
399 var RslChannelNr chan_nr := orig.ies[0].body.chan_nr;
Harald Welte1a40de62017-12-23 02:28:34 +0100400 var RslLinkId link_id;
Harald Welte8d5eead2017-12-17 18:56:45 +0100401 if (orig.msg_type == RSL_MT_ENCR_CMD) {
402 link_id := orig.ies[2].body.link_id;
403 } else {
404 link_id := orig.ies[1].body.link_id;
405 }
Harald Welte898113b2018-01-31 18:32:21 +0100406 f_rsl_send_l3(l3, link_id, chan_nr);
Harald Weltec1a2fff2017-12-17 11:06:19 +0100407}
408
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100409/* Convert the chipher representation on BSSMAP to the representation used on RSL */
Harald Weltee613f962018-04-18 22:38:16 +0200410function f_chipher_mode_bssmap_to_rsl(OCT1 alg_bssmap) return RSL_AlgId
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100411{
412 /* A5 0 */
413 if (alg_bssmap == '01'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200414 return RSL_ALG_ID_A5_0;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100415 }
416 /* A5 1 */
417 else if (alg_bssmap == '02'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200418 return RSL_ALG_ID_A5_1;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100419 }
420 /* A5 2 */
421 else if (alg_bssmap == '04'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200422 return RSL_ALG_ID_A5_2;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100423 }
424 /* A5 3 */
425 else if (alg_bssmap == '08'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200426 return RSL_ALG_ID_A5_3;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100427 }
428 /* A5 4 */
429 else if (alg_bssmap == '10'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200430 return RSL_ALG_ID_A5_4;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100431 }
432 /* A5 5 */
433 else if (alg_bssmap == '20'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200434 return RSL_ALG_ID_A5_5;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100435 }
436 /* A5 6 */
437 else if (alg_bssmap == '40'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200438 return RSL_ALG_ID_A5_6;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100439 }
440 /* A5 7 */
441 else if (alg_bssmap == '80'O) {
Harald Weltee613f962018-04-18 22:38:16 +0200442 return RSL_ALG_ID_A5_7;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100443 } else {
444 setverdict(fail, "Unexpected Encryption Algorithm");
Harald Weltee613f962018-04-18 22:38:16 +0200445 return RSL_ALG_ID_A5_0;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100446 }
447}
448
Harald Welte38b2a102017-12-23 02:42:58 +0100449function f_cipher_mode(OCT1 alg, OCT8 key, template OCT16 kc128 := omit, boolean exp_fail := false)
450runs on MSC_ConnHdlr {
Harald Welte73cd2712017-12-17 00:44:52 +0100451 var PDU_BSSAP bssap;
452 var RSL_Message rsl;
Harald Weltee613f962018-04-18 22:38:16 +0200453 var RSL_AlgId alg_rsl;
Harald Welte73cd2712017-12-17 00:44:52 +0100454
455 if (isvalue(kc128)) {
456 BSSAP.send(ts_BSSMAP_CipherModeCmdKc128(alg, key, valueof(kc128)));
457 } else {
458 BSSAP.send(ts_BSSMAP_CipherModeCmd(alg, key));
459 }
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100460
461 /* RSL uses a different representation of the encryption algorithm,
462 * so we need to convert first */
463 alg_rsl := f_chipher_mode_bssmap_to_rsl(alg);
464
Harald Welte73cd2712017-12-17 00:44:52 +0100465 alt {
466 /* RSL/UE Side */
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100467 [] RSL.receive(tr_RSL_ENCR_CMD(g_chan_nr, ?, alg_rsl, key)) -> value rsl {
Harald Welte73cd2712017-12-17 00:44:52 +0100468 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[3].body.l3_info.payload);
469 log("Rx L3 from net: ", l3);
470 if (ischosen(l3.msgs.rrm.cipheringModeCommand)) {
471 f_rsl_reply(ts_RRM_CiphModeCompl, rsl);
472 }
473 repeat;
474 }
475 [] BSSAP.receive(tr_BSSMAP_CipherModeCompl) -> value bssap {
476 // bssap.bssmap.cipherModeComplete.chosenEncryptionAlgorithm.algoritmhIdentifier
Harald Welte38b2a102017-12-23 02:42:58 +0100477 if (exp_fail == true) {
478 setverdict(fail, "Unexpected Cipher Mode Complete");
479 } else {
480 setverdict(pass);
481 }
Harald Welte73cd2712017-12-17 00:44:52 +0100482 }
483 [] BSSAP.receive(tr_BSSMAP_CipherModeRej) -> value bssap {
Harald Welte38b2a102017-12-23 02:42:58 +0100484 if (exp_fail == false) {
485 setverdict(fail, "Ciphering Mode Reject");
486 } else {
487 setverdict(pass);
488 }
Harald Welte73cd2712017-12-17 00:44:52 +0100489 }
490 }
491}
492
Harald Welte211219e2018-01-29 22:03:36 +0100493/* Convert from Ericsson ChanDesc2 format to Osmocom RslChannelNr format */
494function f_ChDesc2RslChanNr(ChannelDescription2_V ch_desc, out RslChannelNr chan_nr, out GsmArfcn arfcn) {
495 var BIT5 inp := ch_desc.channelTypeandTDMAOffset;
Harald Welte6fa1f732018-03-21 22:46:16 +0100496 var uint3_t tn := bit2int(ch_desc.timeslotNumber);
Harald Welte211219e2018-01-29 22:03:36 +0100497
498 if (match(inp, '00001'B)) { /* TCH/F */
Harald Welte6fa1f732018-03-21 22:46:16 +0100499 chan_nr := valueof(t_RslChanNr_Bm(tn));
Harald Welte211219e2018-01-29 22:03:36 +0100500 }
501 else if (match(inp, '0001?'B)) { /* TCH/H */
Harald Welte6fa1f732018-03-21 22:46:16 +0100502 chan_nr := valueof(t_RslChanNr_Lm(tn, bit2int(substr(inp, 4, 1))));
Harald Welte211219e2018-01-29 22:03:36 +0100503 }
504 else if (match(inp, '001??'B)) { /* SDCCH/4 */
Harald Welte6fa1f732018-03-21 22:46:16 +0100505 chan_nr := valueof(t_RslChanNr_SDCCH4(tn, bit2int(substr(inp, 3, 2))));
Harald Welte211219e2018-01-29 22:03:36 +0100506 }
507 else if (match(inp, '01???'B)) { /* SDCCH/8 */
Harald Welte6fa1f732018-03-21 22:46:16 +0100508 chan_nr := valueof(t_RslChanNr_SDCCH8(tn, bit2int(substr(inp, 2, 3))));
Harald Welte211219e2018-01-29 22:03:36 +0100509 }
510 else {
511 setverdict(fail, "Unknown ChDesc!");
512 self.stop;
513 }
514
515 if (ch_desc.octet3 and4b '10'O == '10'O) {
516 setverdict(fail, "No support for Hopping");
517 self.stop;
518 } else {
519 var OCT2 concat := ch_desc.octet3 & ch_desc.octet4;
520 arfcn := oct2int(concat);
521 }
522}
523
524type record AssignmentState {
525 /* global */
526 boolean voice_call,
527 boolean is_assignment,
528 /* Assignment related bits */
529 boolean rr_ass_cmpl_seen,
Harald Welte21583082018-01-29 22:28:26 +0100530 boolean assignment_done,
Harald Welte211219e2018-01-29 22:03:36 +0100531 RslChannelNr old_chan_nr,
532 /* Modify related bits */
533 boolean rr_modify_seen,
Harald Welte21583082018-01-29 22:28:26 +0100534 boolean modify_done
Harald Welte211219e2018-01-29 22:03:36 +0100535}
536
537template (value) AssignmentState ts_AssignmentStateInit := {
538 voice_call := false,
539 is_assignment := false,
540 rr_ass_cmpl_seen := false,
Harald Welte21583082018-01-29 22:28:26 +0100541 assignment_done := false,
Harald Welte211219e2018-01-29 22:03:36 +0100542 old_chan_nr := -,
543 rr_modify_seen := false,
Harald Welte21583082018-01-29 22:28:26 +0100544 modify_done := false
Harald Welte211219e2018-01-29 22:03:36 +0100545}
546
547altstep as_assignment(inout AssignmentState st) runs on MSC_ConnHdlr {
Harald Weltec1a2fff2017-12-17 11:06:19 +0100548 var RSL_Message rsl;
Harald Welte211219e2018-01-29 22:03:36 +0100549 [not st.rr_ass_cmpl_seen] RSL.receive(tr_RSL_DATA_REQ(g_chan_nr)) -> value rsl {
550 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[2].body.l3_info.payload);
551 log("Rx L3 from net: ", l3);
552 if (ischosen(l3.msgs.rrm.assignmentCommand)) {
553 var RslChannelNr new_chan_nr;
554 var GsmArfcn arfcn;
555 f_ChDesc2RslChanNr(l3.msgs.rrm.assignmentCommand.descrOf1stChAfterTime,
556 new_chan_nr, arfcn);
557 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
Harald Weltec1a2fff2017-12-17 11:06:19 +0100558
Harald Welte211219e2018-01-29 22:03:36 +0100559 /* register our component for this channel number at the RSL Emulation */
560 f_rslem_register(0, new_chan_nr);
561 var PDU_ML3_MS_NW l3_tx := valueof(ts_RRM_AssignmentComplete('00'O));
562 /* send assignment complete over the new channel */
563 RSL.send(ts_RSL_DATA_IND(new_chan_nr, valueof(ts_RslLinkID_DCCH(0)),
564 enc_PDU_ML3_MS_NW(l3_tx)));
565 /* by default, send via the new channel from now */
566 st.old_chan_nr := g_chan_nr;
567 g_chan_nr := new_chan_nr;
568 st.rr_ass_cmpl_seen := true;
569 repeat;
570 } else {
571 setverdict(fail, "Unexpected L3 received", l3);
572 self.stop;
Harald Weltec1a2fff2017-12-17 11:06:19 +0100573 }
Harald Welte211219e2018-01-29 22:03:36 +0100574 }
575 [st.rr_ass_cmpl_seen] RSL.receive(tr_RSL_REL_REQ(st.old_chan_nr, tr_RslLinkID_DCCH(0))) {
576 RSL.send(ts_RSL_REL_CONF(st.old_chan_nr, valueof(ts_RslLinkID_DCCH(0))));
577 repeat;
578 }
579 [st.rr_ass_cmpl_seen] RSL.receive(tr_RSL_RF_CHAN_REL(st.old_chan_nr)) {
580 RSL.send(ts_RSL_RF_CHAN_REL_ACK(st.old_chan_nr));
Harald Welte1909f462018-01-29 22:29:29 +0100581 /* unregister for old channel number in RSL emulation */
582 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
583 f_rslem_unregister(0, st.old_chan_nr);
Harald Welte21583082018-01-29 22:28:26 +0100584 st.assignment_done := true;
Harald Welte211219e2018-01-29 22:03:36 +0100585 repeat;
586 }
587}
588
589altstep as_modify(inout AssignmentState st) runs on MSC_ConnHdlr {
590 /* no assignment, just mode modify */
591 var RSL_Message rsl;
592
593 [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 +0100594 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[2].body.l3_info.payload);
595 log("Rx L3 from net: ", l3);
596 if (ischosen(l3.msgs.rrm.channelModeModify)) {
597 f_rsl_reply(ts_RRM_ModeModifyAck(l3.msgs.rrm.channelModeModify.channelDescription,
598 l3.msgs.rrm.channelModeModify.channelMode), rsl);
Harald Welte211219e2018-01-29 22:03:36 +0100599 st.rr_modify_seen := true;
Harald Weltec1a2fff2017-12-17 11:06:19 +0100600 }
601 repeat;
602 }
Harald Welte211219e2018-01-29 22:03:36 +0100603 [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 +0100604 RSL.send(ts_RSL_MODE_MODIFY_ACK(g_chan_nr));
Harald Welte21583082018-01-29 22:28:26 +0100605 st.modify_done := true;
Harald Weltec1a2fff2017-12-17 11:06:19 +0100606 repeat;
607 }
Harald Welte211219e2018-01-29 22:03:36 +0100608}
Daniel Willmann191e0d92018-01-17 12:44:35 +0100609
Harald Welte211219e2018-01-29 22:03:36 +0100610/* Determine if given rsl_chan_nr is compatible with given BSSMAP ChannelType */
611function f_channel_compatible(BSSMAP_IE_ChannelType bssmap, RslChannelNr rsl_chan_nr)
612return boolean {
613 select (bssmap.speechOrDataIndicator) {
614 case ('0011'B) { /* Signalling */
615 /* all channels support signalling */
616 return true;
617 }
618 case else { /* Speech, Speech+CTM or CSD */
619 select (bssmap.channelRateAndType) {
620 case ('08'O) { /* TCH/F */
621 select (rsl_chan_nr) {
622 case (t_RslChanNr_Bm(?)) { return true; }
623 }
624 }
625 case ('09'O) { /* TCH/H */
626 select (rsl_chan_nr) {
627 case (t_RslChanNr_Lm(?, ?)) { return true; }
628 }
629 }
630 case else { /* full or half-rate */
631 select (rsl_chan_nr) {
632 case (t_RslChanNr_Bm(?)) { return true; }
633 case (t_RslChanNr_Lm(?, ?)) { return true; }
634 }
635 }
636 }
Harald Weltec1a2fff2017-12-17 11:06:19 +0100637 }
Harald Welte211219e2018-01-29 22:03:36 +0100638 }
639 return false;
640}
Daniel Willmann191e0d92018-01-17 12:44:35 +0100641
Harald Welte211219e2018-01-29 22:03:36 +0100642/* establish a channel fully, expecting an assignment matching 'exp' */
Harald Welte930d0a72018-03-22 22:08:40 +0100643function f_establish_fully_ret(PDU_BSSAP ass_cmd, template PDU_BSSAP exp_ass_cpl)
Harald Welte211219e2018-01-29 22:03:36 +0100644runs on MSC_ConnHdlr return PDU_BSSAP {
645 var PDU_BSSAP bssap;
646 timer T := 10.0;
647 var boolean exp_compl := ischosen(exp_ass_cpl.pdu.bssmap.assignmentComplete);
Philipp Maier86f39202018-02-07 14:40:09 +0100648 var boolean exp_fail := ischosen(exp_ass_cpl.pdu.bssmap.assignmentFailure);
Harald Welte211219e2018-01-29 22:03:36 +0100649 var ExpectCriteria mgcpcrit := {
650 connid := omit,
651 endpoint := omit,
652 transid := omit
653 };
654 var AssignmentState st := valueof(ts_AssignmentStateInit);
655 /* if the channel type is SIGNAL, we're not handling a voice call */
656 if (ass_cmd.pdu.bssmap.assignmentRequest.channelType.speechOrDataIndicator != '0011'B) {
657 st.voice_call := true;
658 }
659 /* determine if the current channel can support the given service or not */
660 if (not f_channel_compatible(ass_cmd.pdu.bssmap.assignmentRequest.channelType, g_chan_nr)) {
661 st.is_assignment := true;
662 }
663
Harald Weltec20b1c42018-02-12 20:50:08 +0100664 f_MscConnHdlr_init(1, "127.0.0.2", "127.0.0.3");
Harald Welte211219e2018-01-29 22:03:36 +0100665
Harald Weltea0630032018-03-20 21:09:55 +0100666 f_create_chan_and_exp();
Harald Welte211219e2018-01-29 22:03:36 +0100667 /* we should now have a COMPL_L3 at the MSC */
668 BSSAP.receive(tr_BSSMAP_ComplL3);
669 f_create_mgcp_expect(mgcpcrit);
670 BSSAP.send(ass_cmd);
671
672 T.start;
673 alt {
674 /* assignment related bits */
675 [st.is_assignment] as_assignment(st);
676
677 /* modify related bits */
678 [not st.is_assignment] as_modify(st);
679
680 /* voice call related bits (IPA CRCX/MDCX + MGCP) */
681 [st.voice_call] as_Media();
682
683 /* if we receive exactly what we expected, always return + pass */
Harald Welte21583082018-01-29 22:28:26 +0100684 [st.is_assignment and st.assignment_done or
685 (not st.is_assignment and st.modify_done)] BSSAP.receive(exp_ass_cpl) -> value bssap {
Harald Welte211219e2018-01-29 22:03:36 +0100686 setverdict(pass);
687 }
Philipp Maier86f39202018-02-07 14:40:09 +0100688 [exp_fail] BSSAP.receive(exp_ass_cpl) -> value bssap {
689 setverdict(pass);
690 }
Harald Welte21583082018-01-29 22:28:26 +0100691 [(st.is_assignment and st.assignment_done or
692 (not st.is_assignment and st.modify_done)) and
693 exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentComplete) {
Harald Weltec1a2fff2017-12-17 11:06:19 +0100694 setverdict(fail, "Received non-matching ASSIGNMENT COMPLETE");
695 }
696 [exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentFail) {
697 setverdict(fail, "Received unexpected ASSIGNMENT FAIL");
698 }
699 [not exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentComplete) {
700 setverdict(fail, "Received unexpected ASSIGNMENT COMPLETE");
701 }
702 [not exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentFail) {
703 setverdict(fail, "Received non-matching ASSIGNMENT FAIL");
704 }
705 [] T.timeout {
Harald Welte458fd372018-03-21 11:26:23 +0100706 setverdict(fail, "Timeout waiting for ASSIGNMENT COMPLETE");
Harald Weltec1a2fff2017-12-17 11:06:19 +0100707 }
708 }
Harald Welte211219e2018-01-29 22:03:36 +0100709 log("g_media ", g_media);
710 if (not isbound(bssap)) {
711 self.stop;
712 }
713 return bssap;
Harald Weltec1a2fff2017-12-17 11:06:19 +0100714}
715
Harald Welte930d0a72018-03-22 22:08:40 +0100716function f_establish_fully(PDU_BSSAP ass_cmd, template PDU_BSSAP exp_ass_cpl)
717runs on MSC_ConnHdlr {
718 var PDU_BSSAP unused := f_establish_fully_ret(ass_cmd, exp_ass_cpl);
719}
720
Harald Welte261af4b2018-02-12 21:20:39 +0100721type record HandoverState {
722 /* Assignment related bits */
723 boolean rr_ho_cmpl_seen,
724 boolean handover_done,
725 RslChannelNr old_chan_nr
726};
727
728altstep as_handover(inout HandoverState st) runs on MSC_ConnHdlr {
729 var RSL_Message rsl;
730 [not st.rr_ho_cmpl_seen] RSL.receive(tr_RSL_DATA_REQ(g_chan_nr)) -> value rsl {
731 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[2].body.l3_info.payload);
732 log("Rx L3 from net: ", l3);
733 if (ischosen(l3.msgs.rrm.handoverCommand)) {
734 var RslChannelNr new_chan_nr;
735 var GsmArfcn arfcn;
736 f_ChDesc2RslChanNr(l3.msgs.rrm.handoverCommand.channelDescription2,
737 new_chan_nr, arfcn);
738 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
739
740 /* register our component for this channel number at the RSL Emulation */
741 f_rslem_register(0, new_chan_nr, RSL1_PROC);
742
743 /* resume processing of RSL DChan messages, which was temporarily suspended
744 * before performing a hand-over */
745 f_rslem_resume(RSL1_PROC);
746
747 /* send handover complete over the new channel */
748 var PDU_ML3_MS_NW l3_tx := valueof(ts_RRM_HandoverComplete('00'O));
749 RSL1.send(ts_RSL_DATA_IND(new_chan_nr, valueof(ts_RslLinkID_DCCH(0)),
750 enc_PDU_ML3_MS_NW(l3_tx)));
751 /* by default, send via the new channel from now */
752 st.old_chan_nr := g_chan_nr;
753 g_chan_nr := new_chan_nr;
754 st.rr_ho_cmpl_seen := true;
755 repeat;
756 } else {
757 setverdict(fail, "Unexpected L3 received", l3);
758 self.stop;
759 }
760 }
761 [st.rr_ho_cmpl_seen] as_Media();
762 [st.rr_ho_cmpl_seen] RSL.receive(tr_RSL_REL_REQ(st.old_chan_nr, tr_RslLinkID_DCCH(0))) {
763 RSL.send(ts_RSL_REL_CONF(st.old_chan_nr, valueof(ts_RslLinkID_DCCH(0))));
764 repeat;
765 }
766 [st.rr_ho_cmpl_seen] RSL.receive(tr_RSL_RF_CHAN_REL(st.old_chan_nr)) {
767 RSL.send(ts_RSL_RF_CHAN_REL_ACK(st.old_chan_nr));
768 /* unregister for old channel number in RSL emulation */
769 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
770 f_rslem_unregister(0, st.old_chan_nr);
771 st.handover_done := true;
Harald Welte261af4b2018-02-12 21:20:39 +0100772 }
773}
774
775
Harald Weltec1a2fff2017-12-17 11:06:19 +0100776
Harald Welte28d943e2017-11-25 15:00:50 +0100777}