blob: 8b3b9eb588d6a205049a8cb466c9062e5b1aff7c [file] [log] [blame]
Harald Welte1733a382017-07-23 17:26:17 +02001module BSSGP_Emulation {
Harald Welte1733a382017-07-23 17:26:17 +02002
Harald Welte5ac31492018-02-15 20:39:13 +01003import from General_Types all;
4import from Osmocom_Types all;
Harald Welte853c0ad2018-02-15 17:45:29 +01005import from NS_Types all;
6import from NS_Emulation all;
7import from BSSGP_Types all;
8import from Osmocom_Gb_Types all;
9import from IPL4asp_Types all;
Harald Welte1733a382017-07-23 17:26:17 +020010
Harald Welte5ac31492018-02-15 20:39:13 +010011import from MobileL3_GMM_SM_Types all;
12import from MobileL3_Types all;
13
14import from LLC_Types all;
15import from LLC_Templates all;
16
Harald Weltea2526a82018-02-18 19:03:36 +010017import from SNDCP_Types all;
18
Harald Welte5ac31492018-02-15 20:39:13 +010019/***********************************************************************
20 * Communication between Client Components and Main Component
21 ***********************************************************************/
22
Harald Welte853c0ad2018-02-15 17:45:29 +010023type record BssgpStatusIndication {
24 Nsei nsei,
25 BssgpBvci bvci,
26 BvcState state
27}
28
29template BssgpStatusIndication t_BssgpStsInd(template Nsei nsei, template BssgpBvci bvci, template BvcState state) := {
30 nsei := nsei,
31 bvci := bvci,
32 state := state
33}
34
35type enumerated BvcState {
36 BVC_S_BLOCKED,
37 BVC_S_UNBLOCKED
38};
39
40/* port from our (internal) point of view */
41type port BSSGP_SP_PT message {
Harald Welte5ac31492018-02-15 20:39:13 +010042 in PDU_BSSGP,
Harald Welte752abba2018-02-18 19:42:17 +010043 PDU_LLC,
Harald Welte5ac31492018-02-15 20:39:13 +010044 PDU_L3_MS_SGSN,
45 PDU_L3_SGSN_MS;
46 out BssgpDecoded,
Harald Welte853c0ad2018-02-15 17:45:29 +010047 NsStatusIndication,
48 BssgpStatusIndication,
Harald Welte5ac31492018-02-15 20:39:13 +010049 ASP_Event,
50 PDU_L3_MS_SGSN,
51 PDU_L3_SGSN_MS;
Harald Welte853c0ad2018-02-15 17:45:29 +010052} with { extension "internal" };
53
54/* port from the user point of view */
55type port BSSGP_PT message {
56 in ASP_Event,
57 NsStatusIndication,
58 BssgpStatusIndication,
Harald Welte5ac31492018-02-15 20:39:13 +010059 BssgpDecoded,
60 PDU_L3_MS_SGSN,
61 PDU_L3_SGSN_MS;
62 out PDU_BSSGP,
Harald Welte752abba2018-02-18 19:42:17 +010063 PDU_LLC,
Harald Welte5ac31492018-02-15 20:39:13 +010064 PDU_L3_SGSN_MS,
65 PDU_L3_MS_SGSN;
Harald Welte853c0ad2018-02-15 17:45:29 +010066} with { extension "internal" };
67
Harald Welte5ac31492018-02-15 20:39:13 +010068signature BSSGP_register_client(hexstring imsi, OCT4 tlli, BssgpCellId cell_id);
69signature BSSGP_unregister_client(hexstring imsi);
Harald Weltef70997d2018-02-17 10:11:19 +010070signature BSSGP_llgmm_assign(OCT4 tlli_old, OCT4 tlli);
Harald Welte5ac31492018-02-15 20:39:13 +010071
72type port BSSGP_PROC_PT procedure {
Harald Weltef70997d2018-02-17 10:11:19 +010073 inout BSSGP_register_client, BSSGP_unregister_client, BSSGP_llgmm_assign;
Harald Welte5ac31492018-02-15 20:39:13 +010074} with { extension "internal" };
75
76
77/***********************************************************************
78 * Client Component for a single MS/TLLI
79 ***********************************************************************/
80
81type component BSSGP_Client_CT {
82 port BSSGP_PT BSSGP;
Stefan Sperlingf82bbb62018-05-03 19:14:28 +020083 port BSSGP_PT BSSGP_SIG;
Harald Welte5ac31492018-02-15 20:39:13 +010084 port BSSGP_PROC_PT BSSGP_PROC;
85};
86
87/***********************************************************************
88 * Main Component
89 ***********************************************************************/
90
91function BssgpStart(BssgpConfig cfg) runs on BSSGP_CT {
92 g_cfg := cfg;
Harald Welte853c0ad2018-02-15 17:45:29 +010093 f_init();
94 f_ScanEvents();
95}
96
97private function f_init() runs on BSSGP_CT {
98 /* Connect the UDP socket */
99 f_change_state(BVC_S_BLOCKED);
100}
101
102type component BSSGP_CT {
Stefan Sperlingf82bbb62018-05-03 19:14:28 +0200103 /* UDP ports towards the bottom (IUT) */
Harald Welte853c0ad2018-02-15 17:45:29 +0100104 port NS_PT BSCP;
105 /* NS-User SAP towards the user */
106 port BSSGP_SP_PT BSSGP_SP;
Stefan Sperlingf82bbb62018-05-03 19:14:28 +0200107 port BSSGP_SP_PT BSSGP_SP_SIG;
Harald Welte5ac31492018-02-15 20:39:13 +0100108 port BSSGP_PROC_PT BSSGP_PROC;
Harald Welte853c0ad2018-02-15 17:45:29 +0100109
Harald Welte5ac31492018-02-15 20:39:13 +0100110 var BssgpConfig g_cfg;
111
Harald Welte853c0ad2018-02-15 17:45:29 +0100112 var BvcState g_ptp_bvc_state := BVC_S_BLOCKED;
113 timer g_T1 := 15.0;
114 timer g_T2 := 60.0;
Harald Welte5ac31492018-02-15 20:39:13 +0100115
116 var ClientEntity ClientTable[16];
Harald Welte853c0ad2018-02-15 17:45:29 +0100117}
118
Harald Welte5ac31492018-02-15 20:39:13 +0100119type record ClientEntity {
120 OCT4 tlli,
121 OCT4 tlli_old optional,
122 hexstring imsi,
123 BssgpCellId cell_id,
124 BSSGP_Client_CT comp_ref,
125 /* LLC entities, one for each SAPI */
126 LLC_Entity llc[16]
Harald Welte853c0ad2018-02-15 17:45:29 +0100127};
128
Harald Welte5ac31492018-02-15 20:39:13 +0100129type record LLC_Entity {
130 boolean sgsn_role,
131 /* N(U) on transmit side for next PDU */
132 uint9_t n_u_tx_next,
133 /* N(U) on receive side, last PDU */
134 uint9_t n_u_rx_last optional
135};
136
137private template LLC_Entity t_LLC_init(boolean sgsn_role := false) := {
138 sgsn_role := sgsn_role,
139 n_u_tx_next := 0,
140 n_u_rx_last := -
141}
142
143type record BssgpConfig {
144 Nsvci nsei,
145 Nsvci bvci,
146 BssgpCellId cell_id,
147 boolean sgsn_role
148};
149
150function f_BnsUdReq(template PDU_BSSGP pdu, BssgpBvci bvci)
151runs on BSSGP_CT return NsUnitdataRequest {
Harald Welte853c0ad2018-02-15 17:45:29 +0100152 var NsUnitdataRequest udr := {
Harald Welte1733a382017-07-23 17:26:17 +0200153 bvci := bvci,
Harald Welte5ac31492018-02-15 20:39:13 +0100154 nsei := g_cfg.nsei,
Harald Welte853c0ad2018-02-15 17:45:29 +0100155 /* for some weird reason we get "Dynamic test case error: Text encoder: Encoding an
156 * unbound integer value." when trying to send the reocrd rather than the octetstring */
157 //sdu := omit,
158 //bssgp := valueof(pdu)
159 sdu := enc_PDU_BSSGP(valueof(pdu)),
160 bssgp := omit
161 }
162 return udr;
163}
164
Harald Welte5ac31492018-02-15 20:39:13 +0100165function f_BnsUdInd(template PDU_BSSGP pdu, template BssgpBvci bvci)
166runs on BSSGP_CT return template NsUnitdataIndication {
Harald Welte853c0ad2018-02-15 17:45:29 +0100167 var template NsUnitdataIndication udi := {
168 bvci := bvci,
Harald Welte5ac31492018-02-15 20:39:13 +0100169 nsei := g_cfg.nsei,
Harald Welte853c0ad2018-02-15 17:45:29 +0100170 sdu := *,
171 bssgp := pdu
172 }
173 return udi;
174}
175
176private function f_change_state(BvcState new_state) runs on BSSGP_CT {
177 log("BSSGP State Transition: ", g_ptp_bvc_state, " -> ", new_state);
178 g_ptp_bvc_state := new_state;
Harald Welte5ac31492018-02-15 20:39:13 +0100179 for (var integer i := 0; i < sizeof(ClientTable); i := i+1) {
180 if (isbound(ClientTable[i].comp_ref)) {
181 BSSGP_SP.send(t_BssgpStsInd(g_cfg.nsei, g_cfg.bvci, g_ptp_bvc_state)) to ClientTable[i].comp_ref;
182 }
183 }
Harald Welte853c0ad2018-02-15 17:45:29 +0100184}
185
186private function f_sendReset() runs on BSSGP_CT {
Harald Welte5ac31492018-02-15 20:39:13 +0100187 var PDU_BSSGP pdu := valueof(ts_BVC_RESET(BSSGP_CAUSE_OM_INTERVENTION, g_cfg.bvci, g_cfg.cell_id));
Harald Welte853c0ad2018-02-15 17:45:29 +0100188 log("PDU: ", pdu);
189 log("ENC: ", enc_PDU_BSSGP(pdu));
190
191 /* BVC-RESET is always sent via the SIGNALLING BVCI, see Table 5.4.1 */
192 BSCP.send(f_BnsUdReq(pdu, 0));
193 g_T2.start;
194 //f_change_state(BVC_S_WAIT_RESET);
195}
196
197private function f_sendUnblock() runs on BSSGP_CT {
Harald Welte5ac31492018-02-15 20:39:13 +0100198 BSCP.send(f_BnsUdReq(t_BVC_UNBLOCK(g_cfg.bvci), 0));
Harald Welte853c0ad2018-02-15 17:45:29 +0100199 g_T1.start;
200}
201
202private function f_sendBlock(BssgpCause cause) runs on BSSGP_CT {
Harald Welte5ac31492018-02-15 20:39:13 +0100203 BSCP.send(f_BnsUdReq(t_BVC_BLOCK(g_cfg.bvci, cause), 0));
Harald Welte853c0ad2018-02-15 17:45:29 +0100204 g_T1.start;
205}
206
207private function f_sendStatus(BssgpCause cause, PDU_BSSGP pdu) runs on BSSGP_CT {
208 /* FIXME: Make sure correct Signaling or PTP BVCI is used! */
Harald Welte5ac31492018-02-15 20:39:13 +0100209 BSCP.send(f_BnsUdReq(ts_BSSGP_STATUS(g_cfg.bvci, cause, pdu), g_cfg.bvci));
210}
211
212/* attempt to extract the TLLI from a BSSGP PDU */
213function f_bssgp_get_tlli(PDU_BSSGP bssgp) return template OCT4 {
214 if (ischosen(bssgp.pDU_BSSGP_DL_UNITDATA)) {
215 return bssgp.pDU_BSSGP_DL_UNITDATA.tLLI_current;
216 } else if (ischosen(bssgp.pDU_BSSGP_UL_UNITDATA)) {
217 return bssgp.pDU_BSSGP_UL_UNITDATA.tLLI;
218 } else if (ischosen(bssgp.pDU_BSSGP_RA_CAPABILITY)) {
219 return bssgp.pDU_BSSGP_RA_CAPABILITY.tLLI.tLLI_Value;
220 } else if (ischosen(bssgp.pDU_BSSGP_RA_CAPABILITY_UPDATE)) {
221 return bssgp.pDU_BSSGP_RA_CAPABILITY_UPDATE.tLLI.tLLI_Value;
222 } else if (ischosen(bssgp.pDU_BSSGP_RA_CAPABILITY_UPDATE_ACK)) {
223 return bssgp.pDU_BSSGP_RA_CAPABILITY_UPDATE_ACK.tLLI.tLLI_Value;
224 } else if (ischosen(bssgp.pDU_BSSGP_RADIO_STATUS)) {
225 return bssgp.pDU_BSSGP_RADIO_STATUS.tLLI.tLLI_Value;
226 } else if (ischosen(bssgp.pDU_BSSGP_SUSPEND)) {
227 return bssgp.pDU_BSSGP_SUSPEND.tLLI.tLLI_Value;
228 } else if (ischosen(bssgp.pDU_BSSGP_SUSPEND_ACK)) {
229 return bssgp.pDU_BSSGP_SUSPEND_ACK.tLLI.tLLI_Value;
230 } else if (ischosen(bssgp.pDU_BSSGP_SUSPEND_NACK)) {
231 return bssgp.pDU_BSSGP_SUSPEND_NACK.tLLI.tLLI_Value;
232 } else if (ischosen(bssgp.pDU_BSSGP_RESUME)) {
233 return bssgp.pDU_BSSGP_RESUME.tLLI.tLLI_Value;
234 } else if (ischosen(bssgp.pDU_BSSGP_RESUME_ACK)) {
235 return bssgp.pDU_BSSGP_RESUME_ACK.tLLI.tLLI_Value;
236 } else if (ischosen(bssgp.pDU_BSSGP_RESUME_NACK)) {
237 return bssgp.pDU_BSSGP_RESUME_NACK.tLLI.tLLI_Value;
238 } else if (ischosen(bssgp.pDU_BSSGP_FLUSH_LL)) {
239 return bssgp.pDU_BSSGP_FLUSH_LL.tLLI.tLLI_Value;
240 } else if (ischosen(bssgp.pDU_BSSGP_FLUSH_LL_ACK)) {
241 return bssgp.pDU_BSSGP_FLUSH_LL_ACK.tLLI.tLLI_Value;
242 } else if (ischosen(bssgp.pDU_BSSGP_LLC_DISCARDED)) {
243 return bssgp.pDU_BSSGP_LLC_DISCARDED.tLLI.tLLI_Value;
244 } else if (ischosen(bssgp.pDU_BSSGP_LLC_DISCARDED)) {
245 return bssgp.pDU_BSSGP_LLC_DISCARDED.tLLI.tLLI_Value;
246 } else if (ischosen(bssgp.pDU_BSSGP_PAGING_CS) and
247 isvalue(bssgp.pDU_BSSGP_PAGING_CS.tLLI)) {
248 return bssgp.pDU_BSSGP_PAGING_CS.tLLI.tLLI_Value;
249 } else if (ischosen(bssgp.pDU_BSSGP_FLOW_CONTROL_MS)) {
250 return bssgp.pDU_BSSGP_FLOW_CONTROL_MS.tLLI.tLLI_Value;
251 } else if (ischosen(bssgp.pDU_BSSGP_FLOW_CONTROL_MS_ACK)) {
252 return bssgp.pDU_BSSGP_FLOW_CONTROL_MS_ACK.tLLI.tLLI_Value;
253 }
254 /* TODO: Handover, PFC, LCS */
255 return omit;
256}
257
258/*
259private function f_tbl_init() runs on BSSGP_CT {
260 var integer i;
261 for (i := 0; i < sizeof(ImsiTable); i := i+1) {
262 ImsiTable[i] := -;
263 }
264
265 for (i := 0; i < sizeof(TlliTable); i := i+1) {
266 TlliTable[i] := -;
267 }
268}
269*/
270
271private function f_tbl_client_add(hexstring imsi, OCT4 tlli, BssgpCellId cell_id, BSSGP_Client_CT vc_conn)
272runs on BSSGP_CT {
273 var integer i;
274 for (i := 0; i < sizeof(ClientTable); i := i+1) {
Harald Weltec7872fa2018-02-18 14:06:12 +0100275 if (not isvalue(ClientTable[i].comp_ref)) {
276 log("Adding Client=", vc_conn, ", IMSI=", imsi, ", TLLI=", tlli, ", index=", i);
Harald Welte5ac31492018-02-15 20:39:13 +0100277 ClientTable[i] := {
278 tlli := tlli,
279 tlli_old := omit,
280 imsi := imsi,
281 cell_id := cell_id,
282 comp_ref := vc_conn,
283 llc := -
284 };
285 for (var integer j := 0; j < sizeof(ClientTable[i].llc); j := j+1) {
286 ClientTable[i].llc[j] := valueof(t_LLC_init(g_cfg.sgsn_role));
287 }
288 return;
289 }
290 }
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200291 testcase.stop("Client Table full");
Harald Welte5ac31492018-02-15 20:39:13 +0100292}
293
294private function f_tbl_client_del(hexstring imsi, BSSGP_Client_CT vc_conn) runs on BSSGP_CT {
295 var integer i;
296 for (i := 0; i < sizeof(ClientTable); i := i+1) {
Harald Weltec7872fa2018-02-18 14:06:12 +0100297 if (isvalue(ClientTable[i].imsi) and ClientTable[i].imsi == imsi) {
Harald Welte5ac31492018-02-15 20:39:13 +0100298 if (ClientTable[i].comp_ref != vc_conn) {
Alexander Couzens2c153422018-06-12 18:10:30 +0200299 setverdict(fail, "Cannot unregister index=", i, " IMSI ", imsi, " registred to ",
Harald Welte5ac31492018-02-15 20:39:13 +0100300 ClientTable[i].comp_ref, " from ", vc_conn);
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200301 mtc.stop;
Harald Welte5ac31492018-02-15 20:39:13 +0100302 }
303 log("Removing Client IMSI=", imsi, ", index=", i);
Alexander Couzens2c153422018-06-12 18:10:30 +0200304 ClientTable[i] := {
305 tlli := -,
306 tlli_old := omit,
307 imsi := ''H,
308 cell_id := -,
309 comp_ref := null,
310 llc := - };
Harald Welte5ac31492018-02-15 20:39:13 +0100311 return;
312 }
313 }
314 setverdict(fail, "Could not find client for IMSI ", imsi);
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200315 mtc.stop;
Harald Welte5ac31492018-02-15 20:39:13 +0100316}
317
Harald Weltef70997d2018-02-17 10:11:19 +0100318/* TS 44.064 7.2.1.1 LLGMM-ASSIGN */
319private function f_tbl_client_llgmm_assign(OCT4 tlli_old, OCT4 tlli_new, BSSGP_Client_CT vc_conn)
320runs on BSSGP_CT {
321 var integer i := f_tbl_idx_by_comp(vc_conn);
322
323 if (tlli_old == 'FFFFFFFF'O and tlli_new != 'FFFFFFFF'O) {
324 /* TLLI assignment */
325 ClientTable[i].tlli := tlli_new;
326 ClientTable[i].tlli_old := omit;
327 } else if (tlli_old != 'FFFFFFFF'O and tlli_new != 'FFFFFFFF'O) {
328 /* TLLI change: both active */
329 ClientTable[i].tlli := tlli_new;
330 ClientTable[i].tlli_old := tlli_old;
331 } else if (tlli_old != 'FFFFFFFF'O and tlli_new == 'FFFFFFFF'O) {
332 /* TLLI unassignment: old shall be unassigned; new stays */
333 ClientTable[i].tlli_old := omit;
334 }
335}
336
Harald Welte5ac31492018-02-15 20:39:13 +0100337private function f_tbl_comp_by_imsi(hexstring imsi) runs on BSSGP_CT return BSSGP_Client_CT {
338 var integer i;
339 for (i := 0; i < sizeof(ClientTable); i := i+1) {
Harald Weltec7872fa2018-02-18 14:06:12 +0100340 if (isvalue(ClientTable[i].imsi) and isvalue(ClientTable[i].comp_ref)
Harald Welte5ac31492018-02-15 20:39:13 +0100341 and ClientTable[i].imsi == imsi) {
342 return ClientTable[i].comp_ref;
343 }
344 }
345 setverdict(fail, "Couldn't find Component for IMSI ", imsi);
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200346 mtc.stop;
Harald Welte5ac31492018-02-15 20:39:13 +0100347}
348
349private function f_tbl_comp_by_tlli(OCT4 tlli) runs on BSSGP_CT return BSSGP_Client_CT {
350 var integer i;
351 for (i := 0; i < sizeof(ClientTable); i := i+1) {
Harald Weltec7872fa2018-02-18 14:06:12 +0100352 if (isvalue(ClientTable[i].comp_ref) and
353 (isvalue(ClientTable[i].tlli) and (ClientTable[i].tlli == tlli or
354 isvalue(ClientTable[i].tlli_old) and ClientTable[i].tlli_old == tlli) )) {
Harald Welte5ac31492018-02-15 20:39:13 +0100355 return ClientTable[i].comp_ref;
356 }
357 }
358 setverdict(fail, "Couldn't find Component for TLLI ", tlli);
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200359 mtc.stop;
Harald Welte5ac31492018-02-15 20:39:13 +0100360}
361
362private function f_tbl_idx_by_comp(BSSGP_Client_CT comp_ref) runs on BSSGP_CT return integer {
363 var integer i;
364 for (i := 0; i < sizeof(ClientTable); i := i+1) {
Harald Weltec7872fa2018-02-18 14:06:12 +0100365 if (isvalue(ClientTable[i].comp_ref) and ClientTable[i].comp_ref == comp_ref) {
Harald Welte5ac31492018-02-15 20:39:13 +0100366 return i;
367 }
368 }
369 setverdict(fail, "Couldn't find Client for Component ", comp_ref);
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200370 mtc.stop;
Harald Welte5ac31492018-02-15 20:39:13 +0100371}
372
373private function f_tbl_tlli_by_comp(BSSGP_Client_CT comp_ref) runs on BSSGP_CT return OCT4 {
374 var integer i;
375 for (i := 0; i < sizeof(ClientTable); i := i+1) {
Harald Weltec7872fa2018-02-18 14:06:12 +0100376 if (isvalue(ClientTable[i].tlli) and isvalue(ClientTable[i].comp_ref)
Harald Welte5ac31492018-02-15 20:39:13 +0100377 and ClientTable[i].comp_ref == comp_ref) {
378 return ClientTable[i].tlli;
379 }
380 }
381 setverdict(fail, "Couldn't find TLLI for Component ", comp_ref);
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200382 mtc.stop;
Harald Welte853c0ad2018-02-15 17:45:29 +0100383}
384
385altstep as_allstate() runs on BSSGP_CT {
Harald Welte5ac31492018-02-15 20:39:13 +0100386 var BSSGP_Client_CT vc_conn;
Harald Welte853c0ad2018-02-15 17:45:29 +0100387 var NsUnitdataIndication udi;
388 var NsStatusIndication nsi;
389 var ASP_Event evt;
Harald Welte5ac31492018-02-15 20:39:13 +0100390 var hexstring imsi;
Harald Weltef70997d2018-02-17 10:11:19 +0100391 var OCT4 tlli, tlli_old;
Harald Welte5ac31492018-02-15 20:39:13 +0100392 var BssgpCellId cell_id;
Harald Welte853c0ad2018-02-15 17:45:29 +0100393
394 /* Respond to BLOCK for wrong NSVCI */
395 [] BSCP.receive(f_BnsUdInd(t_BVC_BLOCK(?, ?), 0)) -> value udi {
396 log("Rx BVC-BLOCK for unknown BVCI");
397 f_sendStatus(BSSGP_CAUSE_BVCI_UNKNOWN, udi.bssgp);
Harald Welte1733a382017-07-23 17:26:17 +0200398 }
399
Harald Welte853c0ad2018-02-15 17:45:29 +0100400 /* Respond to RESET with correct BVCI/CellID */
Harald Welte5ac31492018-02-15 20:39:13 +0100401 [] BSCP.receive(f_BnsUdInd(tr_BVC_RESET(?, g_cfg.bvci, g_cfg.cell_id), 0)) -> value udi {
402 log("Rx BVC-RESET for Our BVCI=", g_cfg.bvci);
403 BSCP.send(f_BnsUdReq(ts_BVC_RESET_ACK(g_cfg.bvci, g_cfg.cell_id), 0));
Harald Welte853c0ad2018-02-15 17:45:29 +0100404 f_change_state(BVC_S_UNBLOCKED);
Harald Welte1733a382017-07-23 17:26:17 +0200405 }
406
Harald Welte853c0ad2018-02-15 17:45:29 +0100407 /* Respond to RESET for signalling BVCI 0 */
Harald Welte5ac31492018-02-15 20:39:13 +0100408 [] BSCP.receive(f_BnsUdInd(tr_BVC_RESET(?, 0, g_cfg.cell_id), 0)) -> value udi {
Harald Welte853c0ad2018-02-15 17:45:29 +0100409 log("Rx BVC-RESET for Signaling BVCI=0");
Harald Welte5ac31492018-02-15 20:39:13 +0100410 BSCP.send(f_BnsUdReq(ts_BVC_RESET_ACK(0, g_cfg.cell_id), 0));
Harald Welte1733a382017-07-23 17:26:17 +0200411 }
412
Harald Welte853c0ad2018-02-15 17:45:29 +0100413 /* Respond to RESET with wrong NSEI/NSVCI */
414 [] BSCP.receive(f_BnsUdInd(tr_BVC_RESET(?, ?, ?), 0)) -> value udi {
415 log("Rx BVC-RESET for unknown BVCI");
416 f_sendStatus(BSSGP_CAUSE_BVCI_UNKNOWN, udi.bssgp);
Harald Welte1733a382017-07-23 17:26:17 +0200417 }
418
Harald Welte853c0ad2018-02-15 17:45:29 +0100419 /* default case of handling unknown PDUs */
420 [] BSCP.receive(f_BnsUdInd(?, ?)) -> value udi {
421 log("Rx Unexpected BSSGP PDU ", udi.bssgp," in state ", g_ptp_bvc_state);
422 f_sendStatus(BSSGP_CAUSE_PDU_NOT_COMPATIBLE_WITH_PROTOCOL_STATE, udi.bssgp);
Harald Welte1733a382017-07-23 17:26:17 +0200423 }
Harald Welte853c0ad2018-02-15 17:45:29 +0100424 /* Forwarding of ASP_Event and NsStatusIndication to user */
Harald Welte5ac31492018-02-15 20:39:13 +0100425 [] BSCP.receive(ASP_Event:?) -> value evt {
426 for (var integer i := 0; i < sizeof(ClientTable); i := i+1) {
427 if (isbound(ClientTable[i].comp_ref)) {
428 BSSGP_SP.send(evt) to ClientTable[i].comp_ref;
429 }
430 }
431 }
Harald Welte853c0ad2018-02-15 17:45:29 +0100432 [] BSCP.receive(NsStatusIndication:?) -> value nsi {
433 /* if we just became NS-unblocked, send a BCC-RESET */
434 if (nsi.old_state != NSE_S_ALIVE_UNBLOCKED and nsi.new_state == NSE_S_ALIVE_UNBLOCKED) {
Harald Welte5ac31492018-02-15 20:39:13 +0100435 if (g_cfg.sgsn_role == false) {
Harald Welte853c0ad2018-02-15 17:45:29 +0100436 f_sendReset();
Harald Welte1733a382017-07-23 17:26:17 +0200437 }
Harald Welte5ac31492018-02-15 20:39:13 +0100438 /* Idea: We could send BVC-UNBLOCK here like some SGSN do */
Harald Welte1733a382017-07-23 17:26:17 +0200439 }
Harald Welte5ac31492018-02-15 20:39:13 +0100440 for (var integer i := 0; i < sizeof(ClientTable); i := i+1) {
441 if (isbound(ClientTable[i].comp_ref)) {
442 BSSGP_SP.send(nsi) to ClientTable[i].comp_ref;
443 }
444 }
445 }
446
447 [] BSSGP_PROC.getcall(BSSGP_register_client:{?,?,?}) -> param(imsi, tlli, cell_id) sender vc_conn {
448 f_tbl_client_add(imsi, tlli, cell_id, vc_conn);
Harald Weltee32ad992018-05-31 22:17:46 +0200449 BSSGP_PROC.reply(BSSGP_register_client:{imsi, tlli, cell_id}) to vc_conn;
Harald Welte5ac31492018-02-15 20:39:13 +0100450 }
451 [] BSSGP_PROC.getcall(BSSGP_unregister_client:{?}) -> param(imsi) sender vc_conn {
452 f_tbl_client_del(imsi, vc_conn);
Harald Weltee32ad992018-05-31 22:17:46 +0200453 BSSGP_PROC.reply(BSSGP_unregister_client:{imsi}) to vc_conn;
Harald Welte5ac31492018-02-15 20:39:13 +0100454 }
Harald Weltef70997d2018-02-17 10:11:19 +0100455 [] BSSGP_PROC.getcall(BSSGP_llgmm_assign:{?,?}) -> param(tlli_old, tlli) sender vc_conn {
456 f_tbl_client_llgmm_assign(tlli_old, tlli, vc_conn);
Harald Weltee32ad992018-05-31 22:17:46 +0200457 BSSGP_PROC.reply(BSSGP_llgmm_assign:{tlli_old, tlli}) to vc_conn;
Harald Weltef70997d2018-02-17 10:11:19 +0100458 }
459
Harald Welte5ac31492018-02-15 20:39:13 +0100460}
461
462altstep as_blocked() runs on BSSGP_CT {
Harald Weltec27f6842018-03-02 21:40:03 +0100463 [g_T1.running] g_T1.timeout {
Harald Welte5ac31492018-02-15 20:39:13 +0100464 f_sendUnblock();
465 }
466 [] BSCP.receive(f_BnsUdInd(t_BVC_UNBLOCK_ACK(g_cfg.bvci), 0)) {
467 g_T1.stop;
468 f_change_state(BVC_S_UNBLOCKED);
469 }
470 [not g_cfg.sgsn_role] BSCP.receive(f_BnsUdInd(tr_BVC_RESET_ACK(g_cfg.bvci, omit), 0)) {
471 f_sendUnblock();
Harald Welte1733a382017-07-23 17:26:17 +0200472 }
Harald Welte853c0ad2018-02-15 17:45:29 +0100473}
Harald Welte1733a382017-07-23 17:26:17 +0200474
Harald Welte5ac31492018-02-15 20:39:13 +0100475altstep as_unblocked() runs on BSSGP_CT {
476 var BSSGP_Client_CT vc_conn;
Harald Welte853c0ad2018-02-15 17:45:29 +0100477 var NsUnitdataIndication udi;
478 var PDU_BSSGP bs_pdu;
Harald Welte752abba2018-02-18 19:42:17 +0100479 var PDU_LLC llc;
Harald Welte5ac31492018-02-15 20:39:13 +0100480 var PDU_L3_MS_SGSN l3_mo;
481 var PDU_L3_SGSN_MS l3_mt;
Harald Welte1733a382017-07-23 17:26:17 +0200482
Harald Welte5ac31492018-02-15 20:39:13 +0100483 /* bogus unblock, just respond with ACK */
484 [] BSCP.receive(f_BnsUdInd(t_BVC_UNBLOCK(g_cfg.bvci), 0)) -> value udi {
485 BSCP.send(f_BnsUdReq(t_BVC_UNBLOCK_ACK(g_cfg.bvci), 0));
486 }
487 /* Respond to BLOCK with BLOCK-ACK + change state */
488 [] BSCP.receive(f_BnsUdInd(t_BVC_BLOCK(g_cfg.bvci, ?), 0)) -> value udi {
489 BSCP.send(f_BnsUdReq(t_BVC_BLOCK_ACK(g_cfg.bvci), 0));
490 g_T1.stop;
491 f_change_state(BVC_S_BLOCKED);
492 }
Harald Weltec27f6842018-03-02 21:40:03 +0100493 [g_T1.running] g_T1.timeout {
Harald Welte5ac31492018-02-15 20:39:13 +0100494 f_sendBlock(BSSGP_CAUSE_OM_INTERVENTION);
495 }
496 [] BSCP.receive(f_BnsUdInd(t_BVC_BLOCK_ACK(g_cfg.bvci), 0)) -> value udi {
497 g_T1.stop;
498 f_change_state(BVC_S_BLOCKED);
499 }
500 [] BSCP.receive(f_BnsUdInd(tr_BVC_RESET_ACK(g_cfg.bvci, g_cfg.cell_id), 0)) -> value udi {
501 g_T2.stop;
502 f_change_state(BVC_S_UNBLOCKED);
503 }
Harald Welte13d391e2017-07-23 19:52:33 +0200504
Harald Welte5ac31492018-02-15 20:39:13 +0100505 /* simply acknowledge all Flow Control Messages */
Harald Welteedcdd902018-03-02 22:04:54 +0100506 [g_cfg.sgsn_role] BSCP.receive(f_BnsUdInd(tr_BVC_FC_BVC, g_cfg.bvci)) -> value udi {
507 var OCT1 tag := udi.bssgp.pDU_BSSGP_FLOW_CONTROL_BVC.tag.unstructured_Value;
508 BSCP.send(f_BnsUdReq(t_BVC_FC_BVC_ACK(tag), g_cfg.bvci));
Harald Welte5ac31492018-02-15 20:39:13 +0100509 }
Harald Welteedcdd902018-03-02 22:04:54 +0100510/*
511 [g_cfg.sgsn_role] BSCP.receive(f_BnsUdInd(t_BVC_FC_MS, g_cfg.bvci)) {
512 BSCP.send(f_BnsUdReq(t_BVC_FC_MS_ACK, g_cfg.bvci));
Harald Welte5ac31492018-02-15 20:39:13 +0100513 }
Harald Weltee0abc472018-02-05 09:13:31 +0100514*/
Harald Welte13d391e2017-07-23 19:52:33 +0200515
Harald Welte5ac31492018-02-15 20:39:13 +0100516 /* FIXME: CS PAGING: dispatch by IMSI */
Harald Welte1733a382017-07-23 17:26:17 +0200517
Harald Welte5ac31492018-02-15 20:39:13 +0100518 /* PS PAGING: dispatch by IMSI */
519 [] BSCP.receive(f_BnsUdInd(tr_BSSGP_PS_PAGING(g_cfg.bvci), g_cfg.bvci)) -> value udi {
520 var hexstring imsi := udi.bssgp.pDU_BSSGP_PAGING_PS.iMSI.digits
521 vc_conn := f_tbl_comp_by_imsi(imsi);
522 BSSGP_SP.send(f_dec_bssgp(udi.bssgp)) to vc_conn;
523 }
524
525 /* Any other BSSGP message: If it has TLLi, route to component; otherwise broadcast */
526 [] BSCP.receive(f_BnsUdInd(?, g_cfg.bvci)) -> value udi {
527 var BssgpDecoded dec := f_dec_bssgp(udi.bssgp);
528 var template OCT4 tlli := f_bssgp_get_tlli(udi.bssgp);
529 if (isvalue(tlli)) {
530 vc_conn := f_tbl_comp_by_tlli(valueof(tlli));
531 BSSGP_SP.send(dec) to vc_conn;
532 } else {
533 log("No TLLI: Broadcasting ", dec);
534 /* broadcast this message to all components */
535 // TITAN DOESN'T DO THIS, *SIGH*: "BSSGP_SP.send(dec) to all component;"
536 for (var integer i := 0; i < sizeof(ClientTable); i := i+1) {
537 if (isbound(ClientTable[i].comp_ref)) {
538 BSSGP_SP.send(dec) to ClientTable[i].comp_ref;
539 }
540 }
Harald Welte853c0ad2018-02-15 17:45:29 +0100541 }
Harald Welte1733a382017-07-23 17:26:17 +0200542 }
Harald Welte853c0ad2018-02-15 17:45:29 +0100543
Stefan Sperlingf82bbb62018-05-03 19:14:28 +0200544 [] BSSGP_SP_SIG.receive(PDU_BSSGP:?)-> value bs_pdu sender vc_conn {
545 BSCP.send(f_BnsUdReq(bs_pdu, 0));
546 }
547
Harald Welte5ac31492018-02-15 20:39:13 +0100548 /* pass virtually any PDU from user to NS-UNITDATA PDU on network */
549 [] BSSGP_SP.receive(PDU_BSSGP:?) -> value bs_pdu sender vc_conn {
550 BSCP.send(f_BnsUdReq(bs_pdu, g_cfg.bvci));
551 }
552
553 [not g_cfg.sgsn_role] BSSGP_SP.receive(PDU_L3_MS_SGSN:?) -> value l3_mo sender vc_conn {
554 var integer idx := f_tbl_idx_by_comp(vc_conn);
555 var octetstring l3_enc := enc_PDU_L3_MS_SGSN(l3_mo);
556 var BIT4 sapi := f_llc_sapi_by_l3_mo(l3_mo);
557 var integer n_u := f_llc_get_n_u_tx(ClientTable[idx].llc[bit2int(sapi)]);
558 var octetstring llc_enc := enc_PDU_LLC(valueof(ts_LLC_UI(l3_enc, sapi, '0'B, n_u)));
559 BSCP.send(f_BnsUdReq(ts_BSSGP_UL_UD(ClientTable[idx].tlli, ClientTable[idx].cell_id, llc_enc), g_cfg.bvci));
560 }
Harald Welte5ac31492018-02-15 20:39:13 +0100561 [g_cfg.sgsn_role] BSSGP_SP.receive(PDU_L3_SGSN_MS:?) -> value l3_mt sender vc_conn {
562 var integer idx := f_tbl_idx_by_comp(vc_conn);
563 var octetstring l3_enc := enc_PDU_L3_SGSN_MS(l3_mt);
564 var BIT4 sapi := f_llc_sapi_by_l3_mt(l3_mt);
565 var integer n_u := f_llc_get_n_u_tx(ClientTable[idx].llc[bit2int(sapi)]);
566 var octetstring llc_enc := enc_PDU_LLC(valueof(ts_LLC_UI(l3_enc, sapi, '1'B, n_u)));
567 //BSCP.send(f_BnsUdReq(ts_BSSGP_DL_UD(ClientTable[idx].tlli, ClientTable[idx].cell_id, llc_enc)), g_cfg.bvci);
568 }
Harald Welte752abba2018-02-18 19:42:17 +0100569
570 [] BSSGP_SP.receive(PDU_LLC:?) -> value llc sender vc_conn {
571 var integer idx := f_tbl_idx_by_comp(vc_conn);
572 var octetstring llc_enc := enc_PDU_LLC(llc);
573 BSCP.send(f_BnsUdReq(ts_BSSGP_UL_UD(ClientTable[idx].tlli, ClientTable[idx].cell_id, llc_enc), g_cfg.bvci));
574 }
Harald Welte853c0ad2018-02-15 17:45:29 +0100575}
576
Harald Welte5ac31492018-02-15 20:39:13 +0100577private function f_llc_get_n_u_tx(inout LLC_Entity llc) return uint9_t {
578 var uint9_t ret := llc.n_u_tx_next;
579 llc.n_u_tx_next := llc.n_u_tx_next + 1;
580 return ret;
581}
582
583private function f_llc_sapi_by_l3_mo(PDU_L3_MS_SGSN l3_mo) return BIT4 {
584 if (ischosen(l3_mo.msgs.gprs_mm)) {
585 return c_LLC_SAPI_LLGMM;
586 } else if (ischosen(l3_mo.msgs.gprs_sm)) {
Harald Welted4719012018-02-17 16:45:06 +0100587 return c_LLC_SAPI_LLGMM;
Harald Welte5ac31492018-02-15 20:39:13 +0100588 } else if (ischosen(l3_mo.msgs.sms)) {
589 return c_LLC_SAPI_LLSMS;
590 }
591 setverdict(fail, "No LLC SAPI for ", l3_mo);
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200592 mtc.stop;
Harald Welte5ac31492018-02-15 20:39:13 +0100593}
594
595private function f_llc_sapi_by_l3_mt(PDU_L3_SGSN_MS l3_mt) return BIT4 {
596 if (ischosen(l3_mt.msgs.gprs_mm)) {
597 return c_LLC_SAPI_LLGMM;
598 } else if (ischosen(l3_mt.msgs.gprs_sm)) {
Harald Welted4719012018-02-17 16:45:06 +0100599 return c_LLC_SAPI_LLGMM;
Harald Welte5ac31492018-02-15 20:39:13 +0100600 } else if (ischosen(l3_mt.msgs.sms)) {
601 return c_LLC_SAPI_LLSMS;
602 }
603 setverdict(fail, "No LLC SAPI for ", l3_mt);
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200604 mtc.stop;
Harald Welte5ac31492018-02-15 20:39:13 +0100605}
606
607
608
609private function f_ScanEvents() runs on BSSGP_CT {
610 log("matching against ", tr_BVC_RESET(?, g_cfg.bvci, g_cfg.cell_id));
611
612 while (true) {
613 alt {
614 [g_ptp_bvc_state == BVC_S_BLOCKED] as_blocked();
615 [g_ptp_bvc_state == BVC_S_UNBLOCKED] as_unblocked();
616 [] as_allstate();
617 }
618 } /* while */
619}
620
621/* PDU_BSSGP enhanced with LLC and possibly L3 decoded payloads */
622type record BssgpDecoded {
623 PDU_BSSGP bssgp,
624 PDU_LLC llc optional,
625 PDU_L3_MS_SGSN l3_mo optional,
Harald Weltea2526a82018-02-18 19:03:36 +0100626 PDU_L3_SGSN_MS l3_mt optional,
627 PDU_SN sndcp optional
Harald Welte5ac31492018-02-15 20:39:13 +0100628}
629
630/* Decode a PDU_BSSGP into a BssgpDecoded (i.e. with LLC/L3 decoded, as applicable) */
631private function f_dec_bssgp(PDU_BSSGP bssgp) runs on BSSGP_CT return BssgpDecoded {
632 var BssgpDecoded dec := {
633 bssgp := bssgp,
634 llc := omit,
635 l3_mo := omit,
Harald Weltea2526a82018-02-18 19:03:36 +0100636 l3_mt := omit,
637 sndcp := omit
Harald Welte5ac31492018-02-15 20:39:13 +0100638 };
639
640 /* Decode LLC, if it is a PDU that contains LLC */
641 if (ischosen(bssgp.pDU_BSSGP_DL_UNITDATA)) {
642 dec.llc := dec_PDU_LLC(bssgp.pDU_BSSGP_DL_UNITDATA.lLC_PDU.lLC_PDU);
643 } else if (ischosen(bssgp.pDU_BSSGP_UL_UNITDATA)) {
644 dec.llc := dec_PDU_LLC(bssgp.pDU_BSSGP_UL_UNITDATA.lLC_PDU.lLC_PDU);
645 }
646
647 /* Decode L3, if it is a LLC PDU containing L3 */
648 if (isvalue(dec.llc) and match(dec.llc, tr_LLC_UI_L3)) {
649 if (g_cfg.sgsn_role) {
650 dec.l3_mo := dec_PDU_L3_MS_SGSN(dec.llc.pDU_LLC_UI.information_field_UI);
651 } else {
652 dec.l3_mt := dec_PDU_L3_SGSN_MS(dec.llc.pDU_LLC_UI.information_field_UI);
653 }
654 }
Harald Weltea2526a82018-02-18 19:03:36 +0100655
656 /* Decode SNDCP, if it is a LLC PDU containing user plane data */
657 if (isvalue(dec.llc) and match(dec.llc, tr_LLC_UI_USER)) {
658 dec.sndcp := dec_PDU_SN(dec.llc.pDU_LLC_UI.information_field_UI);
659 }
Harald Welte5ac31492018-02-15 20:39:13 +0100660 return dec;
661}
662
663function f_bssgp_client_register(hexstring imsi, OCT4 tlli, BssgpCellId cell_id, BSSGP_PROC_PT PT := BSSGP_PROC)
664runs on BSSGP_Client_CT {
665 PT.call(BSSGP_register_client:{imsi, tlli, cell_id}) {
666 [] PT.getreply(BSSGP_register_client:{imsi, tlli, cell_id}) {};
667 }
668}
669
670function f_bssgp_client_unregister(hexstring imsi, BSSGP_PROC_PT PT := BSSGP_PROC)
671runs on BSSGP_Client_CT {
672 PT.call(BSSGP_unregister_client:{imsi}) {
673 [] PT.getreply(BSSGP_unregister_client:{imsi}) {};
674 }
675}
676
Harald Weltef70997d2018-02-17 10:11:19 +0100677/* TS 44.064 7.2.1.1 LLGMM-ASSIGN */
678function f_bssgp_client_llgmm_assign(OCT4 tlli_old, OCT4 tlli_new, BSSGP_PROC_PT PT := BSSGP_PROC)
679runs on BSSGP_Client_CT {
680 PT.call(BSSGP_llgmm_assign:{tlli_old, tlli_new}) {
681 [] PT.getreply(BSSGP_llgmm_assign:{tlli_old, tlli_new}) {};
682 }
683}
684
Harald Welte5ac31492018-02-15 20:39:13 +0100685template BssgpDecoded tr_BD_BSSGP(template PDU_BSSGP bg) := {
686 bssgp := bg,
687 llc := *,
688 l3_mo := *,
Harald Weltea2526a82018-02-18 19:03:36 +0100689 l3_mt := *,
690 sndcp := *
691}
692
693template BssgpDecoded tr_BD_LLC(template PDU_LLC llc) := {
694 bssgp := ?,
695 llc := llc,
696 l3_mo := *,
697 l3_mt := *,
698 sndcp := *
Harald Welte5ac31492018-02-15 20:39:13 +0100699}
700
Harald Welte5ac31492018-02-15 20:39:13 +0100701template BssgpDecoded tr_BD_L3_MT(template PDU_L3_SGSN_MS mt) := {
702 bssgp := ?,
703 llc := ?,
704 l3_mo := omit,
Harald Weltea2526a82018-02-18 19:03:36 +0100705 l3_mt := mt,
706 sndcp := omit
Harald Welte5ac31492018-02-15 20:39:13 +0100707}
708
709template BssgpDecoded tr_BD_L3_MO(template PDU_L3_MS_SGSN mo) := {
710 bssgp := ?,
711 llc := ?,
712 l3_mo := mo,
Harald Weltea2526a82018-02-18 19:03:36 +0100713 l3_mt := omit,
714 sndcp := omit
Harald Welte5ac31492018-02-15 20:39:13 +0100715}
716
Harald Welte37692d82018-02-18 15:21:34 +0100717template BssgpDecoded tr_BD_SNDCP(template BIT4 sapi, template PDU_SN sn) := {
718 bssgp := ?,
719 llc := tr_LLC_UI(?, sapi),
720 l3_mo := omit,
721 l3_mt := omit,
722 sndcp := sn
723}
724
725
Harald Welte5ac31492018-02-15 20:39:13 +0100726
727
Harald Welte1733a382017-07-23 17:26:17 +0200728}