blob: ca97ccda1882838b0e2ec4a6568dde186d1da4cc [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 {
Alexander Couzens0e510e62018-07-28 23:06:00 +020082 port BSSGP_PT BSSGP[3];
83 port BSSGP_PT BSSGP_SIG[3];
84 port BSSGP_PROC_PT BSSGP_PROC[3];
Harald Welte5ac31492018-02-15 20:39:13 +010085};
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
Alexander Couzens6b449fb2018-07-31 14:19:36 +0200119type record length(16) of LLC_Entity LLC_Entities;
120
Harald Welte5ac31492018-02-15 20:39:13 +0100121type record ClientEntity {
122 OCT4 tlli,
123 OCT4 tlli_old optional,
124 hexstring imsi,
125 BssgpCellId cell_id,
126 BSSGP_Client_CT comp_ref,
127 /* LLC entities, one for each SAPI */
128 LLC_Entity llc[16]
Harald Welte853c0ad2018-02-15 17:45:29 +0100129};
130
Harald Welte5ac31492018-02-15 20:39:13 +0100131type record LLC_Entity {
132 boolean sgsn_role,
133 /* N(U) on transmit side for next PDU */
134 uint9_t n_u_tx_next,
135 /* N(U) on receive side, last PDU */
136 uint9_t n_u_rx_last optional
137};
138
139private template LLC_Entity t_LLC_init(boolean sgsn_role := false) := {
140 sgsn_role := sgsn_role,
141 n_u_tx_next := 0,
142 n_u_rx_last := -
143}
144
145type record BssgpConfig {
146 Nsvci nsei,
147 Nsvci bvci,
148 BssgpCellId cell_id,
149 boolean sgsn_role
150};
151
152function f_BnsUdReq(template PDU_BSSGP pdu, BssgpBvci bvci)
153runs on BSSGP_CT return NsUnitdataRequest {
Harald Welte853c0ad2018-02-15 17:45:29 +0100154 var NsUnitdataRequest udr := {
Harald Welte1733a382017-07-23 17:26:17 +0200155 bvci := bvci,
Harald Welte5ac31492018-02-15 20:39:13 +0100156 nsei := g_cfg.nsei,
Harald Welte853c0ad2018-02-15 17:45:29 +0100157 /* for some weird reason we get "Dynamic test case error: Text encoder: Encoding an
158 * unbound integer value." when trying to send the reocrd rather than the octetstring */
159 //sdu := omit,
160 //bssgp := valueof(pdu)
161 sdu := enc_PDU_BSSGP(valueof(pdu)),
162 bssgp := omit
163 }
164 return udr;
165}
166
Harald Welte5ac31492018-02-15 20:39:13 +0100167function f_BnsUdInd(template PDU_BSSGP pdu, template BssgpBvci bvci)
168runs on BSSGP_CT return template NsUnitdataIndication {
Harald Welte853c0ad2018-02-15 17:45:29 +0100169 var template NsUnitdataIndication udi := {
170 bvci := bvci,
Harald Welte5ac31492018-02-15 20:39:13 +0100171 nsei := g_cfg.nsei,
Harald Welte853c0ad2018-02-15 17:45:29 +0100172 sdu := *,
173 bssgp := pdu
174 }
175 return udi;
176}
177
178private function f_change_state(BvcState new_state) runs on BSSGP_CT {
179 log("BSSGP State Transition: ", g_ptp_bvc_state, " -> ", new_state);
180 g_ptp_bvc_state := new_state;
Harald Welte5ac31492018-02-15 20:39:13 +0100181 for (var integer i := 0; i < sizeof(ClientTable); i := i+1) {
182 if (isbound(ClientTable[i].comp_ref)) {
183 BSSGP_SP.send(t_BssgpStsInd(g_cfg.nsei, g_cfg.bvci, g_ptp_bvc_state)) to ClientTable[i].comp_ref;
184 }
185 }
Harald Welte853c0ad2018-02-15 17:45:29 +0100186}
187
188private function f_sendReset() runs on BSSGP_CT {
Harald Welte5ac31492018-02-15 20:39:13 +0100189 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 +0100190 log("PDU: ", pdu);
191 log("ENC: ", enc_PDU_BSSGP(pdu));
192
193 /* BVC-RESET is always sent via the SIGNALLING BVCI, see Table 5.4.1 */
194 BSCP.send(f_BnsUdReq(pdu, 0));
195 g_T2.start;
196 //f_change_state(BVC_S_WAIT_RESET);
197}
198
199private function f_sendUnblock() runs on BSSGP_CT {
Harald Welte5ac31492018-02-15 20:39:13 +0100200 BSCP.send(f_BnsUdReq(t_BVC_UNBLOCK(g_cfg.bvci), 0));
Harald Welte853c0ad2018-02-15 17:45:29 +0100201 g_T1.start;
202}
203
204private function f_sendBlock(BssgpCause cause) runs on BSSGP_CT {
Harald Welte5ac31492018-02-15 20:39:13 +0100205 BSCP.send(f_BnsUdReq(t_BVC_BLOCK(g_cfg.bvci, cause), 0));
Harald Welte853c0ad2018-02-15 17:45:29 +0100206 g_T1.start;
207}
208
209private function f_sendStatus(BssgpCause cause, PDU_BSSGP pdu) runs on BSSGP_CT {
210 /* FIXME: Make sure correct Signaling or PTP BVCI is used! */
Harald Welte5ac31492018-02-15 20:39:13 +0100211 BSCP.send(f_BnsUdReq(ts_BSSGP_STATUS(g_cfg.bvci, cause, pdu), g_cfg.bvci));
212}
213
214/* attempt to extract the TLLI from a BSSGP PDU */
215function f_bssgp_get_tlli(PDU_BSSGP bssgp) return template OCT4 {
216 if (ischosen(bssgp.pDU_BSSGP_DL_UNITDATA)) {
217 return bssgp.pDU_BSSGP_DL_UNITDATA.tLLI_current;
218 } else if (ischosen(bssgp.pDU_BSSGP_UL_UNITDATA)) {
219 return bssgp.pDU_BSSGP_UL_UNITDATA.tLLI;
220 } else if (ischosen(bssgp.pDU_BSSGP_RA_CAPABILITY)) {
221 return bssgp.pDU_BSSGP_RA_CAPABILITY.tLLI.tLLI_Value;
222 } else if (ischosen(bssgp.pDU_BSSGP_RA_CAPABILITY_UPDATE)) {
223 return bssgp.pDU_BSSGP_RA_CAPABILITY_UPDATE.tLLI.tLLI_Value;
224 } else if (ischosen(bssgp.pDU_BSSGP_RA_CAPABILITY_UPDATE_ACK)) {
225 return bssgp.pDU_BSSGP_RA_CAPABILITY_UPDATE_ACK.tLLI.tLLI_Value;
226 } else if (ischosen(bssgp.pDU_BSSGP_RADIO_STATUS)) {
227 return bssgp.pDU_BSSGP_RADIO_STATUS.tLLI.tLLI_Value;
228 } else if (ischosen(bssgp.pDU_BSSGP_SUSPEND)) {
229 return bssgp.pDU_BSSGP_SUSPEND.tLLI.tLLI_Value;
230 } else if (ischosen(bssgp.pDU_BSSGP_SUSPEND_ACK)) {
231 return bssgp.pDU_BSSGP_SUSPEND_ACK.tLLI.tLLI_Value;
232 } else if (ischosen(bssgp.pDU_BSSGP_SUSPEND_NACK)) {
233 return bssgp.pDU_BSSGP_SUSPEND_NACK.tLLI.tLLI_Value;
234 } else if (ischosen(bssgp.pDU_BSSGP_RESUME)) {
235 return bssgp.pDU_BSSGP_RESUME.tLLI.tLLI_Value;
236 } else if (ischosen(bssgp.pDU_BSSGP_RESUME_ACK)) {
237 return bssgp.pDU_BSSGP_RESUME_ACK.tLLI.tLLI_Value;
238 } else if (ischosen(bssgp.pDU_BSSGP_RESUME_NACK)) {
239 return bssgp.pDU_BSSGP_RESUME_NACK.tLLI.tLLI_Value;
240 } else if (ischosen(bssgp.pDU_BSSGP_FLUSH_LL)) {
241 return bssgp.pDU_BSSGP_FLUSH_LL.tLLI.tLLI_Value;
242 } else if (ischosen(bssgp.pDU_BSSGP_FLUSH_LL_ACK)) {
243 return bssgp.pDU_BSSGP_FLUSH_LL_ACK.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_LLC_DISCARDED)) {
247 return bssgp.pDU_BSSGP_LLC_DISCARDED.tLLI.tLLI_Value;
248 } else if (ischosen(bssgp.pDU_BSSGP_PAGING_CS) and
249 isvalue(bssgp.pDU_BSSGP_PAGING_CS.tLLI)) {
250 return bssgp.pDU_BSSGP_PAGING_CS.tLLI.tLLI_Value;
251 } else if (ischosen(bssgp.pDU_BSSGP_FLOW_CONTROL_MS)) {
252 return bssgp.pDU_BSSGP_FLOW_CONTROL_MS.tLLI.tLLI_Value;
253 } else if (ischosen(bssgp.pDU_BSSGP_FLOW_CONTROL_MS_ACK)) {
254 return bssgp.pDU_BSSGP_FLOW_CONTROL_MS_ACK.tLLI.tLLI_Value;
255 }
256 /* TODO: Handover, PFC, LCS */
257 return omit;
258}
259
260/*
261private function f_tbl_init() runs on BSSGP_CT {
262 var integer i;
263 for (i := 0; i < sizeof(ImsiTable); i := i+1) {
264 ImsiTable[i] := -;
265 }
266
267 for (i := 0; i < sizeof(TlliTable); i := i+1) {
268 TlliTable[i] := -;
269 }
270}
271*/
272
273private function f_tbl_client_add(hexstring imsi, OCT4 tlli, BssgpCellId cell_id, BSSGP_Client_CT vc_conn)
274runs on BSSGP_CT {
275 var integer i;
276 for (i := 0; i < sizeof(ClientTable); i := i+1) {
Harald Weltec7872fa2018-02-18 14:06:12 +0100277 if (not isvalue(ClientTable[i].comp_ref)) {
278 log("Adding Client=", vc_conn, ", IMSI=", imsi, ", TLLI=", tlli, ", index=", i);
Harald Welte5ac31492018-02-15 20:39:13 +0100279 ClientTable[i] := {
280 tlli := tlli,
281 tlli_old := omit,
282 imsi := imsi,
283 cell_id := cell_id,
284 comp_ref := vc_conn,
285 llc := -
286 };
287 for (var integer j := 0; j < sizeof(ClientTable[i].llc); j := j+1) {
288 ClientTable[i].llc[j] := valueof(t_LLC_init(g_cfg.sgsn_role));
289 }
290 return;
291 }
292 }
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200293 testcase.stop("Client Table full");
Harald Welte5ac31492018-02-15 20:39:13 +0100294}
295
296private function f_tbl_client_del(hexstring imsi, BSSGP_Client_CT vc_conn) runs on BSSGP_CT {
297 var integer i;
298 for (i := 0; i < sizeof(ClientTable); i := i+1) {
Harald Weltec7872fa2018-02-18 14:06:12 +0100299 if (isvalue(ClientTable[i].imsi) and ClientTable[i].imsi == imsi) {
Harald Welte5ac31492018-02-15 20:39:13 +0100300 if (ClientTable[i].comp_ref != vc_conn) {
Alexander Couzens2c153422018-06-12 18:10:30 +0200301 setverdict(fail, "Cannot unregister index=", i, " IMSI ", imsi, " registred to ",
Harald Welte5ac31492018-02-15 20:39:13 +0100302 ClientTable[i].comp_ref, " from ", vc_conn);
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200303 mtc.stop;
Harald Welte5ac31492018-02-15 20:39:13 +0100304 }
305 log("Removing Client IMSI=", imsi, ", index=", i);
Alexander Couzens2c153422018-06-12 18:10:30 +0200306 ClientTable[i] := {
307 tlli := -,
308 tlli_old := omit,
309 imsi := ''H,
310 cell_id := -,
311 comp_ref := null,
312 llc := - };
Harald Welte5ac31492018-02-15 20:39:13 +0100313 return;
314 }
315 }
316 setverdict(fail, "Could not find client for IMSI ", imsi);
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200317 mtc.stop;
Harald Welte5ac31492018-02-15 20:39:13 +0100318}
319
Harald Weltef70997d2018-02-17 10:11:19 +0100320/* TS 44.064 7.2.1.1 LLGMM-ASSIGN */
321private function f_tbl_client_llgmm_assign(OCT4 tlli_old, OCT4 tlli_new, BSSGP_Client_CT vc_conn)
322runs on BSSGP_CT {
323 var integer i := f_tbl_idx_by_comp(vc_conn);
324
325 if (tlli_old == 'FFFFFFFF'O and tlli_new != 'FFFFFFFF'O) {
326 /* TLLI assignment */
327 ClientTable[i].tlli := tlli_new;
328 ClientTable[i].tlli_old := omit;
329 } else if (tlli_old != 'FFFFFFFF'O and tlli_new != 'FFFFFFFF'O) {
330 /* TLLI change: both active */
331 ClientTable[i].tlli := tlli_new;
332 ClientTable[i].tlli_old := tlli_old;
333 } else if (tlli_old != 'FFFFFFFF'O and tlli_new == 'FFFFFFFF'O) {
334 /* TLLI unassignment: old shall be unassigned; new stays */
335 ClientTable[i].tlli_old := omit;
336 }
337}
338
Harald Welte5ac31492018-02-15 20:39:13 +0100339private function f_tbl_comp_by_imsi(hexstring imsi) runs on BSSGP_CT return BSSGP_Client_CT {
340 var integer i;
341 for (i := 0; i < sizeof(ClientTable); i := i+1) {
Harald Weltec7872fa2018-02-18 14:06:12 +0100342 if (isvalue(ClientTable[i].imsi) and isvalue(ClientTable[i].comp_ref)
Harald Welte5ac31492018-02-15 20:39:13 +0100343 and ClientTable[i].imsi == imsi) {
344 return ClientTable[i].comp_ref;
345 }
346 }
347 setverdict(fail, "Couldn't find Component for IMSI ", imsi);
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200348 mtc.stop;
Harald Welte5ac31492018-02-15 20:39:13 +0100349}
350
351private function f_tbl_comp_by_tlli(OCT4 tlli) runs on BSSGP_CT return BSSGP_Client_CT {
352 var integer i;
353 for (i := 0; i < sizeof(ClientTable); i := i+1) {
Harald Weltec7872fa2018-02-18 14:06:12 +0100354 if (isvalue(ClientTable[i].comp_ref) and
355 (isvalue(ClientTable[i].tlli) and (ClientTable[i].tlli == tlli or
356 isvalue(ClientTable[i].tlli_old) and ClientTable[i].tlli_old == tlli) )) {
Harald Welte5ac31492018-02-15 20:39:13 +0100357 return ClientTable[i].comp_ref;
358 }
359 }
360 setverdict(fail, "Couldn't find Component for TLLI ", tlli);
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200361 mtc.stop;
Harald Welte5ac31492018-02-15 20:39:13 +0100362}
363
364private function f_tbl_idx_by_comp(BSSGP_Client_CT comp_ref) runs on BSSGP_CT return integer {
365 var integer i;
366 for (i := 0; i < sizeof(ClientTable); i := i+1) {
Harald Weltec7872fa2018-02-18 14:06:12 +0100367 if (isvalue(ClientTable[i].comp_ref) and ClientTable[i].comp_ref == comp_ref) {
Harald Welte5ac31492018-02-15 20:39:13 +0100368 return i;
369 }
370 }
371 setverdict(fail, "Couldn't find Client for Component ", comp_ref);
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200372 mtc.stop;
Harald Welte5ac31492018-02-15 20:39:13 +0100373}
374
375private function f_tbl_tlli_by_comp(BSSGP_Client_CT comp_ref) runs on BSSGP_CT return OCT4 {
376 var integer i;
377 for (i := 0; i < sizeof(ClientTable); i := i+1) {
Harald Weltec7872fa2018-02-18 14:06:12 +0100378 if (isvalue(ClientTable[i].tlli) and isvalue(ClientTable[i].comp_ref)
Harald Welte5ac31492018-02-15 20:39:13 +0100379 and ClientTable[i].comp_ref == comp_ref) {
380 return ClientTable[i].tlli;
381 }
382 }
383 setverdict(fail, "Couldn't find TLLI for Component ", comp_ref);
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200384 mtc.stop;
Harald Welte853c0ad2018-02-15 17:45:29 +0100385}
386
387altstep as_allstate() runs on BSSGP_CT {
Harald Welte5ac31492018-02-15 20:39:13 +0100388 var BSSGP_Client_CT vc_conn;
Harald Welte853c0ad2018-02-15 17:45:29 +0100389 var NsUnitdataIndication udi;
390 var NsStatusIndication nsi;
391 var ASP_Event evt;
Harald Welte5ac31492018-02-15 20:39:13 +0100392 var hexstring imsi;
Harald Weltef70997d2018-02-17 10:11:19 +0100393 var OCT4 tlli, tlli_old;
Harald Welte5ac31492018-02-15 20:39:13 +0100394 var BssgpCellId cell_id;
Harald Welte853c0ad2018-02-15 17:45:29 +0100395
396 /* Respond to BLOCK for wrong NSVCI */
397 [] BSCP.receive(f_BnsUdInd(t_BVC_BLOCK(?, ?), 0)) -> value udi {
398 log("Rx BVC-BLOCK for unknown BVCI");
399 f_sendStatus(BSSGP_CAUSE_BVCI_UNKNOWN, udi.bssgp);
Harald Welte1733a382017-07-23 17:26:17 +0200400 }
401
Harald Welte853c0ad2018-02-15 17:45:29 +0100402 /* Respond to RESET with correct BVCI/CellID */
Harald Welte5ac31492018-02-15 20:39:13 +0100403 [] BSCP.receive(f_BnsUdInd(tr_BVC_RESET(?, g_cfg.bvci, g_cfg.cell_id), 0)) -> value udi {
404 log("Rx BVC-RESET for Our BVCI=", g_cfg.bvci);
405 BSCP.send(f_BnsUdReq(ts_BVC_RESET_ACK(g_cfg.bvci, g_cfg.cell_id), 0));
Harald Welte853c0ad2018-02-15 17:45:29 +0100406 f_change_state(BVC_S_UNBLOCKED);
Harald Welte1733a382017-07-23 17:26:17 +0200407 }
408
Harald Welte853c0ad2018-02-15 17:45:29 +0100409 /* Respond to RESET for signalling BVCI 0 */
Harald Welte5ac31492018-02-15 20:39:13 +0100410 [] BSCP.receive(f_BnsUdInd(tr_BVC_RESET(?, 0, g_cfg.cell_id), 0)) -> value udi {
Harald Welte853c0ad2018-02-15 17:45:29 +0100411 log("Rx BVC-RESET for Signaling BVCI=0");
Harald Welte5ac31492018-02-15 20:39:13 +0100412 BSCP.send(f_BnsUdReq(ts_BVC_RESET_ACK(0, g_cfg.cell_id), 0));
Harald Welte1733a382017-07-23 17:26:17 +0200413 }
414
Harald Welte853c0ad2018-02-15 17:45:29 +0100415 /* Respond to RESET with wrong NSEI/NSVCI */
416 [] BSCP.receive(f_BnsUdInd(tr_BVC_RESET(?, ?, ?), 0)) -> value udi {
417 log("Rx BVC-RESET for unknown BVCI");
418 f_sendStatus(BSSGP_CAUSE_BVCI_UNKNOWN, udi.bssgp);
Harald Welte1733a382017-07-23 17:26:17 +0200419 }
420
Harald Welte853c0ad2018-02-15 17:45:29 +0100421 /* default case of handling unknown PDUs */
422 [] BSCP.receive(f_BnsUdInd(?, ?)) -> value udi {
423 log("Rx Unexpected BSSGP PDU ", udi.bssgp," in state ", g_ptp_bvc_state);
424 f_sendStatus(BSSGP_CAUSE_PDU_NOT_COMPATIBLE_WITH_PROTOCOL_STATE, udi.bssgp);
Harald Welte1733a382017-07-23 17:26:17 +0200425 }
Harald Welte853c0ad2018-02-15 17:45:29 +0100426 /* Forwarding of ASP_Event and NsStatusIndication to user */
Harald Welte5ac31492018-02-15 20:39:13 +0100427 [] BSCP.receive(ASP_Event:?) -> value evt {
428 for (var integer i := 0; i < sizeof(ClientTable); i := i+1) {
429 if (isbound(ClientTable[i].comp_ref)) {
430 BSSGP_SP.send(evt) to ClientTable[i].comp_ref;
431 }
432 }
433 }
Harald Welte853c0ad2018-02-15 17:45:29 +0100434 [] BSCP.receive(NsStatusIndication:?) -> value nsi {
435 /* if we just became NS-unblocked, send a BCC-RESET */
436 if (nsi.old_state != NSE_S_ALIVE_UNBLOCKED and nsi.new_state == NSE_S_ALIVE_UNBLOCKED) {
Harald Welte5ac31492018-02-15 20:39:13 +0100437 if (g_cfg.sgsn_role == false) {
Harald Welte853c0ad2018-02-15 17:45:29 +0100438 f_sendReset();
Harald Welte1733a382017-07-23 17:26:17 +0200439 }
Harald Welte5ac31492018-02-15 20:39:13 +0100440 /* Idea: We could send BVC-UNBLOCK here like some SGSN do */
Harald Welte1733a382017-07-23 17:26:17 +0200441 }
Harald Welte5ac31492018-02-15 20:39:13 +0100442 for (var integer i := 0; i < sizeof(ClientTable); i := i+1) {
443 if (isbound(ClientTable[i].comp_ref)) {
444 BSSGP_SP.send(nsi) to ClientTable[i].comp_ref;
445 }
446 }
447 }
448
449 [] BSSGP_PROC.getcall(BSSGP_register_client:{?,?,?}) -> param(imsi, tlli, cell_id) sender vc_conn {
450 f_tbl_client_add(imsi, tlli, cell_id, vc_conn);
Harald Weltee32ad992018-05-31 22:17:46 +0200451 BSSGP_PROC.reply(BSSGP_register_client:{imsi, tlli, cell_id}) to vc_conn;
Harald Welte5ac31492018-02-15 20:39:13 +0100452 }
453 [] BSSGP_PROC.getcall(BSSGP_unregister_client:{?}) -> param(imsi) sender vc_conn {
454 f_tbl_client_del(imsi, vc_conn);
Harald Weltee32ad992018-05-31 22:17:46 +0200455 BSSGP_PROC.reply(BSSGP_unregister_client:{imsi}) to vc_conn;
Harald Welte5ac31492018-02-15 20:39:13 +0100456 }
Harald Weltef70997d2018-02-17 10:11:19 +0100457 [] BSSGP_PROC.getcall(BSSGP_llgmm_assign:{?,?}) -> param(tlli_old, tlli) sender vc_conn {
458 f_tbl_client_llgmm_assign(tlli_old, tlli, vc_conn);
Harald Weltee32ad992018-05-31 22:17:46 +0200459 BSSGP_PROC.reply(BSSGP_llgmm_assign:{tlli_old, tlli}) to vc_conn;
Harald Weltef70997d2018-02-17 10:11:19 +0100460 }
461
Harald Welte5ac31492018-02-15 20:39:13 +0100462}
463
464altstep as_blocked() runs on BSSGP_CT {
Harald Weltec27f6842018-03-02 21:40:03 +0100465 [g_T1.running] g_T1.timeout {
Harald Welte5ac31492018-02-15 20:39:13 +0100466 f_sendUnblock();
467 }
468 [] BSCP.receive(f_BnsUdInd(t_BVC_UNBLOCK_ACK(g_cfg.bvci), 0)) {
469 g_T1.stop;
470 f_change_state(BVC_S_UNBLOCKED);
471 }
472 [not g_cfg.sgsn_role] BSCP.receive(f_BnsUdInd(tr_BVC_RESET_ACK(g_cfg.bvci, omit), 0)) {
473 f_sendUnblock();
Harald Welte1733a382017-07-23 17:26:17 +0200474 }
Harald Welte853c0ad2018-02-15 17:45:29 +0100475}
Harald Welte1733a382017-07-23 17:26:17 +0200476
Harald Welte5ac31492018-02-15 20:39:13 +0100477altstep as_unblocked() runs on BSSGP_CT {
478 var BSSGP_Client_CT vc_conn;
Harald Welte853c0ad2018-02-15 17:45:29 +0100479 var NsUnitdataIndication udi;
480 var PDU_BSSGP bs_pdu;
Harald Welte752abba2018-02-18 19:42:17 +0100481 var PDU_LLC llc;
Harald Welte5ac31492018-02-15 20:39:13 +0100482 var PDU_L3_MS_SGSN l3_mo;
483 var PDU_L3_SGSN_MS l3_mt;
Harald Welte1733a382017-07-23 17:26:17 +0200484
Harald Welte5ac31492018-02-15 20:39:13 +0100485 /* bogus unblock, just respond with ACK */
486 [] BSCP.receive(f_BnsUdInd(t_BVC_UNBLOCK(g_cfg.bvci), 0)) -> value udi {
487 BSCP.send(f_BnsUdReq(t_BVC_UNBLOCK_ACK(g_cfg.bvci), 0));
488 }
489 /* Respond to BLOCK with BLOCK-ACK + change state */
490 [] BSCP.receive(f_BnsUdInd(t_BVC_BLOCK(g_cfg.bvci, ?), 0)) -> value udi {
491 BSCP.send(f_BnsUdReq(t_BVC_BLOCK_ACK(g_cfg.bvci), 0));
492 g_T1.stop;
493 f_change_state(BVC_S_BLOCKED);
494 }
Harald Weltec27f6842018-03-02 21:40:03 +0100495 [g_T1.running] g_T1.timeout {
Harald Welte5ac31492018-02-15 20:39:13 +0100496 f_sendBlock(BSSGP_CAUSE_OM_INTERVENTION);
497 }
498 [] BSCP.receive(f_BnsUdInd(t_BVC_BLOCK_ACK(g_cfg.bvci), 0)) -> value udi {
499 g_T1.stop;
500 f_change_state(BVC_S_BLOCKED);
501 }
502 [] BSCP.receive(f_BnsUdInd(tr_BVC_RESET_ACK(g_cfg.bvci, g_cfg.cell_id), 0)) -> value udi {
503 g_T2.stop;
504 f_change_state(BVC_S_UNBLOCKED);
505 }
Harald Welte13d391e2017-07-23 19:52:33 +0200506
Harald Welte5ac31492018-02-15 20:39:13 +0100507 /* simply acknowledge all Flow Control Messages */
Harald Welteedcdd902018-03-02 22:04:54 +0100508 [g_cfg.sgsn_role] BSCP.receive(f_BnsUdInd(tr_BVC_FC_BVC, g_cfg.bvci)) -> value udi {
509 var OCT1 tag := udi.bssgp.pDU_BSSGP_FLOW_CONTROL_BVC.tag.unstructured_Value;
510 BSCP.send(f_BnsUdReq(t_BVC_FC_BVC_ACK(tag), g_cfg.bvci));
Harald Welte5ac31492018-02-15 20:39:13 +0100511 }
Harald Welteedcdd902018-03-02 22:04:54 +0100512/*
513 [g_cfg.sgsn_role] BSCP.receive(f_BnsUdInd(t_BVC_FC_MS, g_cfg.bvci)) {
514 BSCP.send(f_BnsUdReq(t_BVC_FC_MS_ACK, g_cfg.bvci));
Harald Welte5ac31492018-02-15 20:39:13 +0100515 }
Harald Weltee0abc472018-02-05 09:13:31 +0100516*/
Harald Welte13d391e2017-07-23 19:52:33 +0200517
Harald Welte5ac31492018-02-15 20:39:13 +0100518 /* FIXME: CS PAGING: dispatch by IMSI */
Harald Welte1733a382017-07-23 17:26:17 +0200519
Harald Welte5ac31492018-02-15 20:39:13 +0100520 /* PS PAGING: dispatch by IMSI */
521 [] BSCP.receive(f_BnsUdInd(tr_BSSGP_PS_PAGING(g_cfg.bvci), g_cfg.bvci)) -> value udi {
522 var hexstring imsi := udi.bssgp.pDU_BSSGP_PAGING_PS.iMSI.digits
523 vc_conn := f_tbl_comp_by_imsi(imsi);
524 BSSGP_SP.send(f_dec_bssgp(udi.bssgp)) to vc_conn;
525 }
526
527 /* Any other BSSGP message: If it has TLLi, route to component; otherwise broadcast */
528 [] BSCP.receive(f_BnsUdInd(?, g_cfg.bvci)) -> value udi {
529 var BssgpDecoded dec := f_dec_bssgp(udi.bssgp);
530 var template OCT4 tlli := f_bssgp_get_tlli(udi.bssgp);
531 if (isvalue(tlli)) {
532 vc_conn := f_tbl_comp_by_tlli(valueof(tlli));
533 BSSGP_SP.send(dec) to vc_conn;
534 } else {
535 log("No TLLI: Broadcasting ", dec);
536 /* broadcast this message to all components */
537 // TITAN DOESN'T DO THIS, *SIGH*: "BSSGP_SP.send(dec) to all component;"
538 for (var integer i := 0; i < sizeof(ClientTable); i := i+1) {
539 if (isbound(ClientTable[i].comp_ref)) {
540 BSSGP_SP.send(dec) to ClientTable[i].comp_ref;
541 }
542 }
Harald Welte853c0ad2018-02-15 17:45:29 +0100543 }
Harald Welte1733a382017-07-23 17:26:17 +0200544 }
Harald Welte853c0ad2018-02-15 17:45:29 +0100545
Stefan Sperlingf82bbb62018-05-03 19:14:28 +0200546 [] BSSGP_SP_SIG.receive(PDU_BSSGP:?)-> value bs_pdu sender vc_conn {
547 BSCP.send(f_BnsUdReq(bs_pdu, 0));
548 }
549
Harald Welte5ac31492018-02-15 20:39:13 +0100550 /* pass virtually any PDU from user to NS-UNITDATA PDU on network */
551 [] BSSGP_SP.receive(PDU_BSSGP:?) -> value bs_pdu sender vc_conn {
552 BSCP.send(f_BnsUdReq(bs_pdu, g_cfg.bvci));
553 }
554
555 [not g_cfg.sgsn_role] BSSGP_SP.receive(PDU_L3_MS_SGSN:?) -> value l3_mo sender vc_conn {
556 var integer idx := f_tbl_idx_by_comp(vc_conn);
557 var octetstring l3_enc := enc_PDU_L3_MS_SGSN(l3_mo);
558 var BIT4 sapi := f_llc_sapi_by_l3_mo(l3_mo);
559 var integer n_u := f_llc_get_n_u_tx(ClientTable[idx].llc[bit2int(sapi)]);
560 var octetstring llc_enc := enc_PDU_LLC(valueof(ts_LLC_UI(l3_enc, sapi, '0'B, n_u)));
561 BSCP.send(f_BnsUdReq(ts_BSSGP_UL_UD(ClientTable[idx].tlli, ClientTable[idx].cell_id, llc_enc), g_cfg.bvci));
562 }
Harald Welte5ac31492018-02-15 20:39:13 +0100563 [g_cfg.sgsn_role] BSSGP_SP.receive(PDU_L3_SGSN_MS:?) -> value l3_mt sender vc_conn {
564 var integer idx := f_tbl_idx_by_comp(vc_conn);
565 var octetstring l3_enc := enc_PDU_L3_SGSN_MS(l3_mt);
566 var BIT4 sapi := f_llc_sapi_by_l3_mt(l3_mt);
567 var integer n_u := f_llc_get_n_u_tx(ClientTable[idx].llc[bit2int(sapi)]);
568 var octetstring llc_enc := enc_PDU_LLC(valueof(ts_LLC_UI(l3_enc, sapi, '1'B, n_u)));
569 //BSCP.send(f_BnsUdReq(ts_BSSGP_DL_UD(ClientTable[idx].tlli, ClientTable[idx].cell_id, llc_enc)), g_cfg.bvci);
570 }
Harald Welte752abba2018-02-18 19:42:17 +0100571
572 [] BSSGP_SP.receive(PDU_LLC:?) -> value llc sender vc_conn {
573 var integer idx := f_tbl_idx_by_comp(vc_conn);
574 var octetstring llc_enc := enc_PDU_LLC(llc);
575 BSCP.send(f_BnsUdReq(ts_BSSGP_UL_UD(ClientTable[idx].tlli, ClientTable[idx].cell_id, llc_enc), g_cfg.bvci));
576 }
Harald Welte853c0ad2018-02-15 17:45:29 +0100577}
578
Harald Welte5ac31492018-02-15 20:39:13 +0100579private function f_llc_get_n_u_tx(inout LLC_Entity llc) return uint9_t {
580 var uint9_t ret := llc.n_u_tx_next;
581 llc.n_u_tx_next := llc.n_u_tx_next + 1;
582 return ret;
583}
584
585private function f_llc_sapi_by_l3_mo(PDU_L3_MS_SGSN l3_mo) return BIT4 {
586 if (ischosen(l3_mo.msgs.gprs_mm)) {
587 return c_LLC_SAPI_LLGMM;
588 } else if (ischosen(l3_mo.msgs.gprs_sm)) {
Harald Welted4719012018-02-17 16:45:06 +0100589 return c_LLC_SAPI_LLGMM;
Harald Welte5ac31492018-02-15 20:39:13 +0100590 } else if (ischosen(l3_mo.msgs.sms)) {
591 return c_LLC_SAPI_LLSMS;
592 }
593 setverdict(fail, "No LLC SAPI for ", l3_mo);
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200594 mtc.stop;
Harald Welte5ac31492018-02-15 20:39:13 +0100595}
596
597private function f_llc_sapi_by_l3_mt(PDU_L3_SGSN_MS l3_mt) return BIT4 {
598 if (ischosen(l3_mt.msgs.gprs_mm)) {
599 return c_LLC_SAPI_LLGMM;
600 } else if (ischosen(l3_mt.msgs.gprs_sm)) {
Harald Welted4719012018-02-17 16:45:06 +0100601 return c_LLC_SAPI_LLGMM;
Harald Welte5ac31492018-02-15 20:39:13 +0100602 } else if (ischosen(l3_mt.msgs.sms)) {
603 return c_LLC_SAPI_LLSMS;
604 }
605 setverdict(fail, "No LLC SAPI for ", l3_mt);
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200606 mtc.stop;
Harald Welte5ac31492018-02-15 20:39:13 +0100607}
608
609
610
611private function f_ScanEvents() runs on BSSGP_CT {
612 log("matching against ", tr_BVC_RESET(?, g_cfg.bvci, g_cfg.cell_id));
613
614 while (true) {
615 alt {
616 [g_ptp_bvc_state == BVC_S_BLOCKED] as_blocked();
617 [g_ptp_bvc_state == BVC_S_UNBLOCKED] as_unblocked();
618 [] as_allstate();
619 }
620 } /* while */
621}
622
623/* PDU_BSSGP enhanced with LLC and possibly L3 decoded payloads */
624type record BssgpDecoded {
625 PDU_BSSGP bssgp,
626 PDU_LLC llc optional,
627 PDU_L3_MS_SGSN l3_mo optional,
Harald Weltea2526a82018-02-18 19:03:36 +0100628 PDU_L3_SGSN_MS l3_mt optional,
629 PDU_SN sndcp optional
Harald Welte5ac31492018-02-15 20:39:13 +0100630}
631
632/* Decode a PDU_BSSGP into a BssgpDecoded (i.e. with LLC/L3 decoded, as applicable) */
633private function f_dec_bssgp(PDU_BSSGP bssgp) runs on BSSGP_CT return BssgpDecoded {
634 var BssgpDecoded dec := {
635 bssgp := bssgp,
636 llc := omit,
637 l3_mo := omit,
Harald Weltea2526a82018-02-18 19:03:36 +0100638 l3_mt := omit,
639 sndcp := omit
Harald Welte5ac31492018-02-15 20:39:13 +0100640 };
641
642 /* Decode LLC, if it is a PDU that contains LLC */
643 if (ischosen(bssgp.pDU_BSSGP_DL_UNITDATA)) {
644 dec.llc := dec_PDU_LLC(bssgp.pDU_BSSGP_DL_UNITDATA.lLC_PDU.lLC_PDU);
645 } else if (ischosen(bssgp.pDU_BSSGP_UL_UNITDATA)) {
646 dec.llc := dec_PDU_LLC(bssgp.pDU_BSSGP_UL_UNITDATA.lLC_PDU.lLC_PDU);
647 }
648
649 /* Decode L3, if it is a LLC PDU containing L3 */
650 if (isvalue(dec.llc) and match(dec.llc, tr_LLC_UI_L3)) {
651 if (g_cfg.sgsn_role) {
652 dec.l3_mo := dec_PDU_L3_MS_SGSN(dec.llc.pDU_LLC_UI.information_field_UI);
653 } else {
654 dec.l3_mt := dec_PDU_L3_SGSN_MS(dec.llc.pDU_LLC_UI.information_field_UI);
655 }
656 }
Harald Weltea2526a82018-02-18 19:03:36 +0100657
658 /* Decode SNDCP, if it is a LLC PDU containing user plane data */
659 if (isvalue(dec.llc) and match(dec.llc, tr_LLC_UI_USER)) {
660 dec.sndcp := dec_PDU_SN(dec.llc.pDU_LLC_UI.information_field_UI);
661 }
Harald Welte5ac31492018-02-15 20:39:13 +0100662 return dec;
663}
664
Alexander Couzens0e510e62018-07-28 23:06:00 +0200665function f_bssgp_client_register(hexstring imsi, OCT4 tlli, BssgpCellId cell_id, BSSGP_PROC_PT PT := BSSGP_PROC[0])
Harald Welte5ac31492018-02-15 20:39:13 +0100666runs on BSSGP_Client_CT {
667 PT.call(BSSGP_register_client:{imsi, tlli, cell_id}) {
668 [] PT.getreply(BSSGP_register_client:{imsi, tlli, cell_id}) {};
669 }
670}
671
Alexander Couzens0e510e62018-07-28 23:06:00 +0200672function f_bssgp_client_unregister(hexstring imsi, BSSGP_PROC_PT PT := BSSGP_PROC[0])
Harald Welte5ac31492018-02-15 20:39:13 +0100673runs on BSSGP_Client_CT {
674 PT.call(BSSGP_unregister_client:{imsi}) {
675 [] PT.getreply(BSSGP_unregister_client:{imsi}) {};
676 }
677}
678
Harald Weltef70997d2018-02-17 10:11:19 +0100679/* TS 44.064 7.2.1.1 LLGMM-ASSIGN */
Alexander Couzens0e510e62018-07-28 23:06:00 +0200680function f_bssgp_client_llgmm_assign(OCT4 tlli_old, OCT4 tlli_new, BSSGP_PROC_PT PT := BSSGP_PROC[0])
Harald Weltef70997d2018-02-17 10:11:19 +0100681runs on BSSGP_Client_CT {
682 PT.call(BSSGP_llgmm_assign:{tlli_old, tlli_new}) {
683 [] PT.getreply(BSSGP_llgmm_assign:{tlli_old, tlli_new}) {};
684 }
685}
686
Harald Welte5ac31492018-02-15 20:39:13 +0100687template BssgpDecoded tr_BD_BSSGP(template PDU_BSSGP bg) := {
688 bssgp := bg,
689 llc := *,
690 l3_mo := *,
Harald Weltea2526a82018-02-18 19:03:36 +0100691 l3_mt := *,
692 sndcp := *
693}
694
695template BssgpDecoded tr_BD_LLC(template PDU_LLC llc) := {
696 bssgp := ?,
697 llc := llc,
698 l3_mo := *,
699 l3_mt := *,
700 sndcp := *
Harald Welte5ac31492018-02-15 20:39:13 +0100701}
702
Harald Welte5ac31492018-02-15 20:39:13 +0100703template BssgpDecoded tr_BD_L3_MT(template PDU_L3_SGSN_MS mt) := {
704 bssgp := ?,
705 llc := ?,
706 l3_mo := omit,
Harald Weltea2526a82018-02-18 19:03:36 +0100707 l3_mt := mt,
708 sndcp := omit
Harald Welte5ac31492018-02-15 20:39:13 +0100709}
710
711template BssgpDecoded tr_BD_L3_MO(template PDU_L3_MS_SGSN mo) := {
712 bssgp := ?,
713 llc := ?,
714 l3_mo := mo,
Harald Weltea2526a82018-02-18 19:03:36 +0100715 l3_mt := omit,
716 sndcp := omit
Harald Welte5ac31492018-02-15 20:39:13 +0100717}
718
Harald Welte37692d82018-02-18 15:21:34 +0100719template BssgpDecoded tr_BD_SNDCP(template BIT4 sapi, template PDU_SN sn) := {
720 bssgp := ?,
721 llc := tr_LLC_UI(?, sapi),
722 l3_mo := omit,
723 l3_mt := omit,
724 sndcp := sn
725}
726
727
Harald Welte5ac31492018-02-15 20:39:13 +0100728
729
Harald Welte1733a382017-07-23 17:26:17 +0200730}