blob: c30ad6a4dc1f3f3ed8be2ce9d9cbb1e70ac4400d [file] [log] [blame]
Harald Welte56db5fd2017-07-14 18:25:59 +02001module Test {
Harald Welteaf549412017-07-15 21:33:21 +02002 import from GSM_Types all;
Harald Welte56db5fd2017-07-14 18:25:59 +02003 import from GSM_SystemInformation all;
Harald Welteb622a3d2017-07-14 22:26:33 +02004 import from GSMTAP_Types all;
5 import from GSMTAP_PortType all;
6 import from IPL4_GSMTAP_CtrlFunct all;
Harald Welte9a907b32017-07-15 10:34:27 +02007 import from TELNETasp_PortType all;
Harald Welte56db5fd2017-07-14 18:25:59 +02008
9 const octetstring si1 := '5506198fb38000000000000000000000000000e504002b'O;
10 const octetstring si2 := '59061a00000000000000000000000000000000ffe50400'O;
11 const octetstring si3 := '49061b000062f22404d2490301275d40e50400392b2b2b'O;
12 const octetstring si4 := '31061c62f22404d25d40e504002b2b2b2b2b2b2b2b2b2b'O;
Harald Weltebdc5dbd2017-07-16 00:00:43 +020013 const octetstring c_si2bis := '550602bfe809b3ff00000000000000000000007900002b'O;
14 const octetstring c_si2ter := '010603bf66b0aa0a00000002000000000000002b2b2b2b'O;
15 const octetstring c_si2quater := '050607a8a0364aa698d72ff424feee0506d5e7fff02043'O;
Harald Welte56db5fd2017-07-14 18:25:59 +020016
17 type component dummy_CT {
Harald Welteb622a3d2017-07-14 22:26:33 +020018 port GSMTAP_PT GSMTAP;
Harald Welte9a907b32017-07-15 10:34:27 +020019 port TELNETasp_PT BSCVTY;
Harald Weltebdc5dbd2017-07-16 00:00:43 +020020 var boolean initialized := false;
21 var SystemInformationConfig si_cfg := {
22 bcch_extended := false,
23 si1_present := true,
24 si2bis_present := false,
25 si2ter_present := false,
26 si2quater_present := false,
27 si7_present := false,
28 si8_present := false,
29 si9_present := false,
30 si13_present := false,
31 si13alt_present := false,
32 si15_present := false,
33 si16_present := false,
34 si17_present := false,
35 si2n_present := false,
36 si21_present := false,
37 si22_present := false
38 };
Harald Welte56db5fd2017-07-14 18:25:59 +020039 };
40
41 testcase TC_si1() runs on dummy_CT {
Harald Welte56db5fd2017-07-14 18:25:59 +020042 log("SI: ", dec_SystemInformation(si1));
43 log("SI: ", dec_SystemInformation(si2));
44 log("SI: ", dec_SystemInformation(si3));
45 log("SI: ", dec_SystemInformation(si4));
Harald Weltebdc5dbd2017-07-16 00:00:43 +020046 setverdict(pass);
Harald Welte56db5fd2017-07-14 18:25:59 +020047 }
48
Harald Welteb622a3d2017-07-14 22:26:33 +020049 template GsmtapHeader t_GsmtapHeader := {
50 version := GSMTAP_VERSION,
51 hdr_len := 4,
52 msg_type := ?,
53 timeslot := ?,
54 arfcn := ?,
55 signal_dbm := ?,
56 snr_db := ?,
57 frame_number := ?,
58 sub_type := ?,
59 antenna_nr := ?,
60 sub_slot := ?,
61 res := ?
62 }
63
64 template GsmtapHeader t_GsmtapHeaderUm(template GsmtapChannel ch) modifies t_GsmtapHeader := {
65 msg_type := GSMTAP_TYPE_UM,
66 sub_type := ch
67 }
68
Harald Welteb622a3d2017-07-14 22:26:33 +020069 template GsmtapMessage t_bcch := {
70 header := t_GsmtapHeaderUm(GSMTAP_CHANNEL_BCCH),
71 payload := ?
72 }
73
74 template GSMTAP_RecvFrom t_recvfrom(template GsmtapChannel ch) := {
75 connId := ?,
76 remName := ?,
77 remPort := ?,
78 locName := ?,
79 locPort := GSMTAP_PORT,
80 proto := {udp:={}},
81 userData := ?,
82 msg := { header := t_GsmtapHeaderUm(ch), payload := ?}
83 }
84
Harald Welteaf549412017-07-15 21:33:21 +020085 /* tuple of gsmtap header + decoded SI */
86 type record SystemInformationGsmtap {
87 GsmtapHeader gsmtap,
88 SystemInformation si
89 }
90
91 /* an arbitrary-length vector of decoded SI + gsmtap header */
92 type record of SystemInformationGsmtap SystemInformationVector;
93
94 /* an array of SI-vectors indexed by TC value */
95 type SystemInformationVector SystemInformationVectorPerTc[8];
96
97 type record of integer IntegerRecord;
98
99 function f_array_contains(IntegerRecord arr, integer key) return boolean {
100 for (var integer i:= 0; i< sizeof(arr); i := i + 1) {
101 if (arr[i] == key) {
102 return true;
103 }
104 }
105 return false;
106 }
107
108
109 /* compute TC as per 45.002 6.3.1.3 */
110 function f_gsm_compute_tc(integer fn) return integer {
111 return (fn / 51) mod 8;
112 }
113
114 /* determine if a given SI vector contains given SI type at least once */
115 function f_si_vecslot_contains(SystemInformationVector arr, RrMessageType key, boolean bcch_ext := false) return boolean {
116 for (var integer i:= 0; i< sizeof(arr); i := i + 1) {
117 var integer fn_mod51 := arr[i].gsmtap.frame_number mod 51;
118 if (not bcch_ext and fn_mod51 == 2 or
119 bcch_ext and fn_mod51 == 6) {
120 if (arr[i].si.header.message_type == key) {
121 return true;
122 }
123 }
124 }
125 return false;
126 }
127
Harald Welte39276772017-07-16 01:07:42 +0200128 /* ensure a given TC slot of the SI vector contains given SI type at least once at TC */
129 function f_ensure_si_vec_contains(SystemInformationVectorPerTc arr, integer tc, RrMessageType key, boolean ext_bcch := false) {
130 if (not f_si_vecslot_contains(arr[tc], key, ext_bcch)) {
131 log("Fail: No ", key, " in TC=", tc, "!");
132 setverdict(fail);
133 }
134 }
135
Harald Welteaf549412017-07-15 21:33:21 +0200136 /* check if a given SI vector contains given SI type at least once on any TC */
137 function f_si_vec_contains(SystemInformationVectorPerTc arr, RrMessageType key) return boolean {
138 for (var integer tc:= 0; tc < sizeof(arr); tc := tc + 1) {
139 if (f_si_vecslot_contains(arr[tc], key) or
140 f_si_vecslot_contains(arr[tc], key, true)) {
141 return true;
142 }
143 }
144 return false;
145 }
146
Harald Welte39276772017-07-16 01:07:42 +0200147 /* determine if a given SI vector contains given SI type at least N of M times */
148 function f_si_vecslot_contains_n_of_m(SystemInformationVector arr, RrMessageType key, boolean bcch_ext := false, integer n := 1, integer m := 4) return boolean {
149 var integer count := 0;
150 if (sizeof(arr) < m) {
151 log("Error: Insufficient SI in array");
152 setverdict(fail);
153 return false;
154 }
155 for (var integer i:= 0; i < m; i := i + 1) {
156 var integer fn_mod51 := arr[i].gsmtap.frame_number mod 51;
157 if (not bcch_ext and fn_mod51 == 2 or
158 bcch_ext and fn_mod51 == 6) {
159 if (arr[i].si.header.message_type == key) {
160 count := count + 1;
161 }
162 }
163 }
164 if (count >= n) {
165 return true;
166 } else {
167 return false;
168 }
169 }
170
171 /* ensure a given TC slot of the SI vector contains given SI type at least N out of M times at TC */
172 function f_ensure_si_vec_contains_n_of_m(SystemInformationVectorPerTc arr, integer tc, RrMessageType key, boolean ext_bcch := false, integer n, integer m) {
173 if (not f_si_vecslot_contains_n_of_m(arr[tc], key, ext_bcch, n, m)) {
174 log("Fail: Not ", n, "/", m, " of ", key, " in TC=", tc, "!");
175 setverdict(fail);
176 }
177 }
178
179 /* determine if a given SI vector contains given SI type at least once */
180 function f_si_vecslot_contains_only(SystemInformationVector arr, RrMessageType key, boolean bcch_ext := false) return boolean {
181 for (var integer i:= 0; i< sizeof(arr); i := i + 1) {
182 var integer fn_mod51 := arr[i].gsmtap.frame_number mod 51;
183 if (not bcch_ext and fn_mod51 == 2 or
184 bcch_ext and fn_mod51 == 6) {
185 if (arr[i].si.header.message_type != key) {
186 return false;
187 }
188 }
189 }
190 return true;
191 }
192
193 /* ensure a given TC slot of the SI vector contains only given SI type */
194 function f_ensure_si_vec_contains_only(SystemInformationVectorPerTc arr, integer tc, RrMessageType key, boolean ext_bcch := false) {
195 if (not f_si_vecslot_contains_only(arr[tc], key, ext_bcch)) {
196 log("Fail: Not all ", key, " in TC=", tc, "!");
Harald Welteaf549412017-07-15 21:33:21 +0200197 setverdict(fail);
198 }
199 }
200
201 /* SI configuration of cell, against which we validate actual SI messages */
202 type set SystemInformationConfig {
203 boolean bcch_extended,
204 boolean si1_present,
205 boolean si2bis_present,
206 boolean si2ter_present,
207 boolean si2quater_present,
208 boolean si7_present,
209 boolean si8_present,
210 boolean si9_present,
211 boolean si13_present,
212 boolean si13alt_present,
213 boolean si15_present,
214 boolean si16_present,
215 boolean si17_present,
216 boolean si2n_present,
217 boolean si21_present,
218 boolean si22_present
219 }
220
221 /* validate the SI scheduling according to TS 45.002 version 14.1.0 Release 14, Section 6.3.1.3 */
222 function f_validate_si_scheduling(SystemInformationConfig cfg, SystemInformationVectorPerTc si_per_tc) {
223 var integer i;
224 for (i := 0; i < sizeof(si_per_tc); i := i + 1) {
225 if (sizeof(si_per_tc[i]) == 0) {
226 setverdict(fail, "No SI messages for TC=0!");
227 }
228 }
229 if (cfg.si1_present) {
230 /* ii) System Information Type 1 needs to be sent if frequency hopping is in use or
231 * when the NCH is present in a cell. If the MS finds another message on BCCH Norm
232 * when TC = 0, it can assume that System Information Type 1 is not in use. */
233 f_ensure_si_vec_contains(si_per_tc, 0, SYSTEM_INFORMATION_TYPE_1);
Harald Welte39276772017-07-16 01:07:42 +0200234 /* make sure *ALL* contain SI1 */
235 f_ensure_si_vec_contains_only(si_per_tc, 0, SYSTEM_INFORMATION_TYPE_1);
Harald Welteaf549412017-07-15 21:33:21 +0200236 }
237 f_ensure_si_vec_contains(si_per_tc, 1, SYSTEM_INFORMATION_TYPE_2);
238 /* iii) A SI 2 message will be sent at least every time TC = 1 */
239 f_ensure_si_vec_contains(si_per_tc, 2, SYSTEM_INFORMATION_TYPE_3);
240 f_ensure_si_vec_contains(si_per_tc, 6, SYSTEM_INFORMATION_TYPE_3);
241 f_ensure_si_vec_contains(si_per_tc, 3, SYSTEM_INFORMATION_TYPE_4);
242 f_ensure_si_vec_contains(si_per_tc, 7, SYSTEM_INFORMATION_TYPE_4);
243
244 /* iii) System information type 2 bis or 2 ter messages are sent if needed, as determined by the
245 * system operator. If only one of them is needed, it is sent when TC = 5. If both are
246 * needed, 2bis is sent when TC = 5 and 2ter is sent at least once within any of 4
247 * consecutive occurrences of TC = 4. */
248 if (cfg.si2bis_present and not cfg.si2ter_present) {
249 f_ensure_si_vec_contains(si_per_tc, 5, SYSTEM_INFORMATION_TYPE_2bis);
250 } else if (cfg.si2ter_present and not cfg.si2bis_present) {
251 f_ensure_si_vec_contains(si_per_tc, 5, SYSTEM_INFORMATION_TYPE_2ter);
252 } else if (cfg.si2ter_present and cfg.si2bis_present) {
253 f_ensure_si_vec_contains(si_per_tc, 5, SYSTEM_INFORMATION_TYPE_2bis);
Harald Welte39276772017-07-16 01:07:42 +0200254 f_ensure_si_vec_contains_n_of_m(si_per_tc, 4, SYSTEM_INFORMATION_TYPE_2ter, false, 1, 4);
Harald Welteaf549412017-07-15 21:33:21 +0200255 }
256
257 if (cfg.si7_present or cfg.si8_present) {
258 /* vi) Use of System Information type 7 and 8 is not always necessary. It is necessary
259 * if System Information type 4 does not contain all information needed for cell
260 * selection and reselection. */
261 if (not cfg.bcch_extended) {
262 setverdict(fail, "Error: SI7/SI8 require BCCH Extd.");
263 }
264 if (cfg.si7_present) {
265 f_ensure_si_vec_contains(si_per_tc, 7, SYSTEM_INFORMATION_TYPE_7, true);
266 }
267 if (cfg.si8_present) {
268 f_ensure_si_vec_contains(si_per_tc, 3, SYSTEM_INFORMATION_TYPE_8, true);
269 }
270 }
271
272 if (cfg.si2quater_present) {
273 /* iii) System information type 2 quater is sent if needed, as determined by the system
274 * operator. If sent on BCCH Norm, it shall be sent when TC = 5 if neither of 2bis
275 * and 2ter are used, otherwise it shall be sent at least once within any of 4
276 * consecutive occurrences of TC = 4. If sent on BCCH Ext, it is sent at least once
277 * within any of 4 consecutive occurrences of TC = 5. */
278 if (not (cfg.bcch_extended)) {
279 if (not (cfg.si2bis_present or cfg.si2ter_present)) {
280 f_ensure_si_vec_contains(si_per_tc, 5, SYSTEM_INFORMATION_TYPE_2quater);
281 } else {
Harald Welte39276772017-07-16 01:07:42 +0200282 f_ensure_si_vec_contains_n_of_m(si_per_tc, 4, SYSTEM_INFORMATION_TYPE_2quater, false, 1, 4);
Harald Welteaf549412017-07-15 21:33:21 +0200283 }
284 } else {
Harald Welte39276772017-07-16 01:07:42 +0200285 f_ensure_si_vec_contains_n_of_m(si_per_tc, 5, SYSTEM_INFORMATION_TYPE_2quater, true, 1, 4);
Harald Welteaf549412017-07-15 21:33:21 +0200286 }
287 }
288 if (cfg.si9_present) {
289 /* vi) System Information type 9 is sent in those blocks with TC = 4 which are specified
290 * in system information type 3 as defined in 3GPP TS 44.018. */
291 f_ensure_si_vec_contains(si_per_tc, 4, SYSTEM_INFORMATION_TYPE_9); // FIXME SI3
292 }
293 if (cfg.si13_present) {
294 /* vii) System Information type 13 is only related to the GPRS service. System Information
295 * Type 13 need only be sent if GPRS support is indicated in one or more of System
296 * Information Type 3 or 4 or 7 or 8 messages. These messages also indicate if the
297 * message is sent on the BCCH Norm or if the message is transmitted on the BCCH Ext.
298 * In the case that the message is sent on the BCCH Norm, it is sent at least once
299 * within any of 4 consecutive occurrences of TC=4. */
300 if (not cfg.bcch_extended) {
Harald Welte39276772017-07-16 01:07:42 +0200301 f_ensure_si_vec_contains_n_of_m(si_per_tc, 4, SYSTEM_INFORMATION_TYPE_13, false, 1, 4);
Harald Welteaf549412017-07-15 21:33:21 +0200302 } else {
303 f_ensure_si_vec_contains(si_per_tc, 0, SYSTEM_INFORMATION_TYPE_13, true);
304 }
305 if (f_si_vec_contains(si_per_tc, SYSTEM_INFORMATION_TYPE_13alt)) {
306 setverdict(fail, "Cannot have SI13alt and SI13");
307 }
308 }
309 if (cfg.si16_present or cfg.si17_present) {
310 /* viii) System Information type 16 and 17 are only related to the SoLSA service. They
311 * should not be sent in a cell where network sharing is used (see rule xv). */
312 if (cfg.si22_present) {
313 setverdict(fail, "Error: Cannot have SI16/SI17 and SI22!");
314 }
315 if (f_si_vec_contains(si_per_tc, SYSTEM_INFORMATION_TYPE_22)) {
316 setverdict(fail, "Cannot have SI16/SI17 and SI22!");
317 }
318 if (not cfg.bcch_extended) {
319 setverdict(fail, "Error: SI16/SI17 requires BCCH Extd!");
320 }
321 if (cfg.si16_present) {
322 f_ensure_si_vec_contains(si_per_tc, 6, SYSTEM_INFORMATION_TYPE_16, true);
323 }
324 if (cfg.si17_present) {
325 f_ensure_si_vec_contains(si_per_tc, 2, SYSTEM_INFORMATION_TYPE_17, true);
326 }
327 }
328
329 /* ix) System Information type 18 and 20 are sent in order to transmit non-GSM
330 * broadcast information. The frequency with which they are sent is determined by the
331 * system operator. System Information type 9 identifies the scheduling of System
332 * Information type 18 and 20 messages. */
333
334 /* x) System Information Type 19 is sent if COMPACT neighbours exist. If System
335 * Information Type 19 is present, then its scheduling shall be indicated in System
336 * Information Type 9. */
337
338 if (cfg.si15_present) {
339 /* xi) System Information Type 15 is broadcast if dynamic ARFCN mapping is used in the
340 * PLMN. If sent on BCCH Norm, it is sent at least once within any of 4 consecutive
341 * occurrences of TC = 4. If sent on BCCH Ext, it is sent at least once within any of
342 * 4 consecutive occurrences of TC = 1. */
343 if (not cfg.bcch_extended) {
Harald Welte39276772017-07-16 01:07:42 +0200344 f_ensure_si_vec_contains_n_of_m(si_per_tc, 4, SYSTEM_INFORMATION_TYPE_15, false, 1, 4);
Harald Welteaf549412017-07-15 21:33:21 +0200345 } else {
Harald Welte39276772017-07-16 01:07:42 +0200346 f_ensure_si_vec_contains_n_of_m(si_per_tc, 1, SYSTEM_INFORMATION_TYPE_15, true, 1, 4);
Harald Welteaf549412017-07-15 21:33:21 +0200347 }
348 }
349 if (cfg.si13alt_present) {
350 /* xii) System Information type 13 alt is only related to the GERAN Iu mode. System
351 * Information Type 13 alt need only be sent if GERAN Iu mode support is indicated in
352 * one or more of System Information Type 3 or 4 or 7 or 8 messages and SI 13 is not
353 * broadcast. These messages also indicate if the message is sent on the BCCH Norm or
354 * if the message is transmitted on the BCCH Ext. In the case that the message is sent
355 * on the BCCH Norm, it is sent at least once within any of 4 consecutive occurrences
356 * of TC = 4. */
357 if (cfg.si13_present) {
358 setverdict(fail, "Error: Cannot have SI13alt and SI13");
359 }
360 if (f_si_vec_contains(si_per_tc, SYSTEM_INFORMATION_TYPE_13)) {
361 setverdict(fail, "Cannot have SI13alt and SI13");
362 }
363 if (not cfg.bcch_extended) {
Harald Welte39276772017-07-16 01:07:42 +0200364 f_ensure_si_vec_contains_n_of_m(si_per_tc, 4, SYSTEM_INFORMATION_TYPE_13alt, false, 1, 4);
Harald Welteaf549412017-07-15 21:33:21 +0200365 } else {
366 f_ensure_si_vec_contains(si_per_tc, 0, SYSTEM_INFORMATION_TYPE_13alt, true);
367 }
368 }
369 if (cfg.si2n_present) {
370 /* xiii) System Information Type 2n is optionally sent on BCCH Norm or BCCH Ext if needed,
371 * as determined by the system operator. In the case that the message is sent on the
372 * BCCH Norm, it is sent at least once within any of 4 consecutive occurrences of TC =
373 * 4. If the message is sent on BCCH Ext, it is sent at least once within any of 2
374 * consecutive occurrences of TC = 4. */
375 if (not cfg.bcch_extended) {
Harald Welte39276772017-07-16 01:07:42 +0200376 f_ensure_si_vec_contains_n_of_m(si_per_tc, 4, SYSTEM_INFORMATION_TYPE_2n, false, 1, 4);
Harald Welteaf549412017-07-15 21:33:21 +0200377 } else {
Harald Welte39276772017-07-16 01:07:42 +0200378 f_ensure_si_vec_contains_n_of_m(si_per_tc, 4, SYSTEM_INFORMATION_TYPE_2n, true, 2, 4);
Harald Welteaf549412017-07-15 21:33:21 +0200379 }
380 }
381 if (cfg.si21_present) {
382 /* xiv) System Information Type 21 is optionally sent on BCCH Norm or BCCH Ext, as
383 * determined by the system operator. If Extended Access Barring is in use in the cell
384 * then this message is sent at least once within any of 4 consecutive occurrences of
385 * TC = 4 regardless if it is sent on BCCH Norm or BCCH Ext. If BCCH Ext is used in a
386 * cell then this message shall only be sent on BCCH Ext. */
387 if (not cfg.bcch_extended) {
Harald Welte39276772017-07-16 01:07:42 +0200388 f_ensure_si_vec_contains_n_of_m(si_per_tc, 4, SYSTEM_INFORMATION_TYPE_21, false, 1, 4);
Harald Welteaf549412017-07-15 21:33:21 +0200389 } else {
Harald Welte39276772017-07-16 01:07:42 +0200390 f_ensure_si_vec_contains_n_of_m(si_per_tc, 4, SYSTEM_INFORMATION_TYPE_21, true, 1, 4);
Harald Welteaf549412017-07-15 21:33:21 +0200391 if (f_si_vecslot_contains(si_per_tc[4], SYSTEM_INFORMATION_TYPE_21)) {
392 setverdict(fail, "Cannot have SI21 on BCCH Norm if BCCH Extd enabled!");
393 }
394 }
395 }
396 if (cfg.si22_present) {
397 /* xv) System Information Type 22 is sent if network sharing is in use in the cell. It
398 * should not be sent in a cell where SoLSA is used (see rule viii). System
399 * Information Type 22 instances shall be sent on BCCH Ext within any occurrence of TC
400 * =2 and TC=6. */
401 if (cfg.si16_present or cfg.si17_present) {
402 setverdict(fail, "Error: Cannot have SI16/SI17 and SI22!");
403 }
404 if (f_si_vec_contains(si_per_tc, SYSTEM_INFORMATION_TYPE_16) or
405 f_si_vec_contains(si_per_tc, SYSTEM_INFORMATION_TYPE_17)) {
406 setverdict(fail, "Cannot have SI16/SI17 and SI22!");
407 }
408 if (not cfg.bcch_extended) {
409 setverdict(fail, "Error: SI22 requires BCCH Extd!");
Harald Welte39276772017-07-16 01:07:42 +0200410 } else {
411 f_ensure_si_vec_contains_only(si_per_tc, 2, SYSTEM_INFORMATION_TYPE_22, true);
412 f_ensure_si_vec_contains_only(si_per_tc, 6, SYSTEM_INFORMATION_TYPE_22, true);
Harald Welteaf549412017-07-15 21:33:21 +0200413 }
414 }
415 }
416
417
Harald Welte39276772017-07-16 01:07:42 +0200418 function f_gsmtap_sample_si(GSMTAP_PT pt, float duration := 8.0) return SystemInformationVectorPerTc {
Harald Welteaf549412017-07-15 21:33:21 +0200419 timer T := duration;
420 var SystemInformationVectorPerTc si_per_tc;
421 var GSMTAP_RecvFrom rf;
422
423 /* initialize all per-TC vectors empty */
424 for (var integer i := 0; i < sizeof(si_per_tc); i := i + 1) {
425 si_per_tc[i] := {};
426 }
427
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200428 /* flush all previous/buffered elements */
429 pt.clear
430
Harald Welteaf549412017-07-15 21:33:21 +0200431 T.start;
432 alt {
433 [] pt.receive(t_recvfrom(GSMTAP_CHANNEL_BCCH)) -> value rf {
434 var SystemInformation si := dec_SystemInformation(rf.msg.payload);
435 var SystemInformationGsmtap sig := { rf.msg.header, si };
436 var integer tc := f_gsm_compute_tc(rf.msg.header.frame_number);
437 log("SI received at TC=", tc, ": ", si);
438 /* append to the per-TC bucket */
439 si_per_tc[tc] := si_per_tc[tc] & { sig };
440 repeat;
441 }
442 [] pt.receive { repeat; };
443 [] T.timeout { };
444 }
Harald Welte39276772017-07-16 01:07:42 +0200445 for (var integer i := 0; i < sizeof(si_per_tc); i := i + 1) {
446 log(testcasename(), ": TC=", i, " has #of SI=", sizeof(si_per_tc[i]));
447 }
Harald Welteaf549412017-07-15 21:33:21 +0200448 return si_per_tc;
449 }
450
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200451 function f_init() runs on dummy_CT {
452 if (initialized) {
453 return;
454 }
455 /* GSMTAP initialization */
Harald Welteb622a3d2017-07-14 22:26:33 +0200456 map(self:GSMTAP, system:GSMTAP);
457 IPL4_GSMTAP_CtrlFunct.f_IPL4_listen(GSMTAP, "0.0.0.0", GSMTAP_PORT, {udp := {}});
458
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200459 /* VTY initialization */
460 map(self:BSCVTY, system:BSCVTY);
461 f_vty_set_prompts(BSCVTY)
462
463 initialized := true;
464 }
465
466 testcase TC_si_default() runs on dummy_CT {
467 var SystemInformationVectorPerTc si_per_tc;
468
469 f_init();
470
Harald Welteaf549412017-07-15 21:33:21 +0200471 si_per_tc := f_gsmtap_sample_si(GSMTAP);
Harald Welteaf549412017-07-15 21:33:21 +0200472 f_validate_si_scheduling(si_cfg, si_per_tc);
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200473
Harald Welteaf549412017-07-15 21:33:21 +0200474 setverdict(pass);
Harald Welteb622a3d2017-07-14 22:26:33 +0200475 }
476
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200477 testcase TC_si_sched_2bis() runs on dummy_CT {
478 var SystemInformationVectorPerTc si_per_tc;
479 f_init();
480
481 /* Enable SI2bis + validate scheduling */
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200482 si_cfg.si2bis_present := true;
Harald Weltefe1052d2017-07-16 01:24:01 +0200483 f_si_cfg_to_vty();
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200484 si_per_tc := f_gsmtap_sample_si(GSMTAP);
485 f_validate_si_scheduling(si_cfg, si_per_tc);
486
487 /* cleanup */
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200488 si_cfg.si2bis_present := false;
Harald Weltefe1052d2017-07-16 01:24:01 +0200489 f_si_cfg_to_vty();
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200490
491 setverdict(pass);
492 }
493
494 testcase TC_si_sched_2ter() runs on dummy_CT {
495 var SystemInformationVectorPerTc si_per_tc;
496 f_init();
497
498 /* Enable SI2ter + validate scheduling */
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200499 si_cfg.si2ter_present := true;
Harald Weltefe1052d2017-07-16 01:24:01 +0200500 f_si_cfg_to_vty();
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200501 si_per_tc := f_gsmtap_sample_si(GSMTAP);
502 f_validate_si_scheduling(si_cfg, si_per_tc);
503
504 /* cleanup */
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200505 si_cfg.si2ter_present := false;
Harald Weltefe1052d2017-07-16 01:24:01 +0200506 f_si_cfg_to_vty();
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200507
508 setverdict(pass);
509 }
510
511 testcase TC_si_sched_2ter_2bis() runs on dummy_CT {
512 var SystemInformationVectorPerTc si_per_tc;
513 f_init();
514
515 /* Enable SI2bis + SI2ter + validate scheduling */
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200516 si_cfg.si2bis_present := true;
517 si_cfg.si2ter_present := true;
Harald Weltefe1052d2017-07-16 01:24:01 +0200518 f_si_cfg_to_vty();
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200519 si_per_tc := f_gsmtap_sample_si(GSMTAP);
520 f_validate_si_scheduling(si_cfg, si_per_tc);
521
522 /* cleanup */
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200523 si_cfg.si2bis_present := false;
524 si_cfg.si2ter_present := false;
Harald Weltefe1052d2017-07-16 01:24:01 +0200525 f_si_cfg_to_vty();
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200526
527 setverdict(pass);
528 }
529
530 testcase TC_si_sched_2quater() runs on dummy_CT {
531 var SystemInformationVectorPerTc si_per_tc;
532 f_init();
533
534 /* Enable SI2quater + validate scheduling */
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200535 si_cfg.si2quater_present := true;
Harald Weltefe1052d2017-07-16 01:24:01 +0200536 f_si_cfg_to_vty();
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200537
538 /* cleanup */
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200539 si_cfg.si2quater_present := false;
Harald Weltefe1052d2017-07-16 01:24:01 +0200540 f_si_cfg_to_vty();
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200541
542 setverdict(pass);
543 }
544
545 testcase TC_si_sched_13() runs on dummy_CT {
546 var SystemInformationVectorPerTc si_per_tc;
547 f_init();
548
549 /* Enable SI2ter + validate scheduling */
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200550 si_cfg.si13_present := true;
Harald Weltefe1052d2017-07-16 01:24:01 +0200551 f_si_cfg_to_vty();
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200552 si_per_tc := f_gsmtap_sample_si(GSMTAP);
553 f_validate_si_scheduling(si_cfg, si_per_tc);
554
555 /* cleanup */
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200556 si_cfg.si13_present := false;
Harald Weltefe1052d2017-07-16 01:24:01 +0200557 f_si_cfg_to_vty();
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200558
559 setverdict(pass);
560 }
Harald Welte9a907b32017-07-15 10:34:27 +0200561
Harald Weltefe1052d2017-07-16 01:24:01 +0200562 testcase TC_si_sched_13_2bis_2ter_2quater() runs on dummy_CT {
563 var SystemInformationVectorPerTc si_per_tc;
564 f_init();
565
566 si_cfg.si2bis_present := true;
567 si_cfg.si2ter_present := true;
568 si_cfg.si2quater_present := true;
569 si_cfg.si13_present := true;
570 f_si_cfg_to_vty();
571 si_per_tc := f_gsmtap_sample_si(GSMTAP);
572 f_validate_si_scheduling(si_cfg, si_per_tc);
573
574 /* cleanup */
575 si_cfg.si2bis_present := false;
576 si_cfg.si2ter_present := false;
577 si_cfg.si2quater_present := false;
578 si_cfg.si13_present := false;
579 f_si_cfg_to_vty();
580
581 setverdict(pass);
582 }
583
584 function f_si_cfg_to_vty() runs on dummy_CT {
585 if (si_cfg.si2bis_present) {
586 f_vty_si_static(BSCVTY, 0, "2bis", c_si2bis);
587 } else {
588 f_vty_si_computed(BSCVTY, 0, "2bis");
589 }
590 if (si_cfg.si2ter_present) {
591 f_vty_si_static(BSCVTY, 0, "2ter", c_si2ter);
592 } else {
593 f_vty_si_computed(BSCVTY, 0, "2ter");
594 }
595 if (si_cfg.si13_present) {
596 f_vty_gprs_mode(BSCVTY, 0, "gprs");
597 } else {
598 f_vty_gprs_mode(BSCVTY, 0, "none");
599 }
600 if (si_cfg.si2quater_present) {
601 f_vty_si2q_add_uarfcn(BSCVTY, 0, 23, 42);
602 } else {
603 f_vty_si2q_del_uarfcn(BSCVTY, 0, 23, 42);
604 }
605 /* for debugging */
606 f_vty_transceive(BSCVTY, "write terminal");
607 /* actually commit the changes from BSC -> BTS */
608 f_vty_si_resend(BSCVTY, 0);
609 }
Harald Welte9a907b32017-07-15 10:34:27 +0200610
611 /* permitted prompts on VTY */
612 const charstring NORMAL_PROMPT := "OpenBSC> ";
613 const charstring ENABLE_PROMPT := "OpenBSC# ";
614 const charstring CONFIG_PROMPT := "OpenBSC(*)\#";
615
616 const ASP_TelnetDynamicConfig vty_prompt[3] := {
617 {
618 prompt := {
619 id := 1,
620 prompt := NORMAL_PROMPT,
621 has_wildcards := false
622 }
623 }, {
624 prompt := {
625 id := 2,
626 prompt := ENABLE_PROMPT,
627 has_wildcards := false
628 }
629 }, {
630 prompt := {
631 id := 3,
632 prompt := CONFIG_PROMPT,
633 has_wildcards := true
634 }
635 }
636 };
637
638 /* configure prompts in TELNETasp module */
639 function f_vty_set_prompts(TELNETasp_PT pt) {
640 /* set some configuration that isn't possible to express
641 * in the config file due to syntactic restrictions (Who invents config
642 * files that don't permit regular expressions? */
643 for (var integer i := 0; i < sizeof(vty_prompt); i:= i + 1) {
644 pt.send(vty_prompt[i])
645 }
646 }
647
648 /* wait for any of the permitted prompts; buffer + return all intermediate output */
649 function f_vty_wait_for_prompt(TELNETasp_PT pt) return charstring {
650 template charstring config_pattern := pattern CONFIG_PROMPT;
651 var charstring rx, buf := "";
652 timer T := 2.0;
653
654 T.start;
655 alt {
656 [] pt.receive(NORMAL_PROMPT) { };
657 [] pt.receive(ENABLE_PROMPT) { };
658 [] pt.receive(config_pattern) { };
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200659 /* FIXME: "% Unknown command" and the like! */
Harald Welte9a907b32017-07-15 10:34:27 +0200660 [] pt.receive(charstring:?) -> value rx { buf := buf & rx; repeat };
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200661 [] T.timeout { setverdict(fail, "VTY Timeout for prompt"); return ""};
Harald Welte9a907b32017-07-15 10:34:27 +0200662 }
663 T.stop;
664 return buf;
665 }
666
667 /* send a VTY command and obtain response until prompt is received */
668 function f_vty_transceive(TELNETasp_PT pt, charstring tx) return charstring {
669 pt.send(tx);
670 return f_vty_wait_for_prompt(pt);
671 }
672
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200673 type integer BtsNr (0..255);
674 type integer BtsTrxNr (0..255);
675 type integer BtsTimeslotNr (0..7);
676
677 type charstring BtsGprsMode ("none", "gprs", "egrps");
678
Harald Welte9a907b32017-07-15 10:34:27 +0200679 /* enter the'confiugration' mode of the VTY */
680 function f_vty_enter_config(TELNETasp_PT pt) {
681 f_vty_transceive(pt, "enable");
682 f_vty_transceive(pt, "configure terminal")
683 }
684
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200685 function f_vty_enter_cfg_network(TELNETasp_PT pt) {
686 f_vty_enter_config(pt);
687 f_vty_transceive(pt, "network")
688 }
Harald Welte9a907b32017-07-15 10:34:27 +0200689
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200690 function f_vty_enter_cfg_bts(TELNETasp_PT pt, BtsNr bts := 0) {
691 f_vty_enter_cfg_network(pt);
692 f_vty_transceive(pt, "bts " & int2str(bts));
693 }
694
695 function f_vty_enter_cfg_trx(TELNETasp_PT pt, BtsNr bts := 0, BtsTrxNr trx := 0) {
696 f_vty_enter_cfg_bts(pt, bts);
697 f_vty_transceive(pt, "trx " & int2str(trx));
698 }
699
700 function f_vty_enter_cfg_ts(TELNETasp_PT pt, BtsNr bts := 0, BtsTrxNr trx := 0, BtsTimeslotNr ts) {
701 f_vty_enter_cfg_trx(pt, bts, trx);
702 f_vty_transceive(pt, "timeslot " & int2str(ts));
703 }
704
705 function f_vty_si_static(TELNETasp_PT pt, BtsNr bts, charstring si, octetstring bytes) {
706 f_vty_enter_cfg_bts(pt, bts);
707 f_vty_transceive(pt, "system-information " & si & " mode static");
708 f_vty_transceive(pt, "system-information " & si & " static " & hex2str(oct2hex(bytes)));
709 f_vty_transceive(pt, "end");
710 }
711
712 function f_vty_si_computed(TELNETasp_PT pt, BtsNr bts, charstring si) {
713 f_vty_enter_cfg_bts(pt, bts);
714 f_vty_transceive(pt, "system-information " & si & " mode computed");
715 f_vty_transceive(pt, "end");
716 }
717
718 function f_vty_si_resend(TELNETasp_PT pt, BtsNr bts := 0) {
719 f_vty_transceive(pt, "bts " & int2str(bts) & " resend-system-information");
Harald Weltec17c88e2017-07-16 00:39:59 +0200720 /* wait for 1s until changes propagate */
721 timer T := 1.0;
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200722 T.start;
723 T.timeout;
724 }
725
726 function f_vty_gprs_mode(TELNETasp_PT pt, integer bts, BtsGprsMode mode) {
727 f_vty_enter_cfg_bts(pt, bts);
728 f_vty_transceive(pt, "gprs mode " & mode);
729 f_vty_transceive(pt, "end");
730 }
731
732 function f_vty_si2q_add_uarfcn(TELNETasp_PT pt, BtsNr bts, UmtsArfcn uarfcn, UmtsScramblingCode sc, integer diversity := 0) {
733 f_vty_enter_cfg_bts(pt, bts);
734 f_vty_transceive(pt, "si2quater neighbor-list add uarfcn " & int2str(uarfcn) & " " & int2str(sc) & " " & int2str(diversity));
735 f_vty_transceive(pt, "end");
736 }
737
738 function f_vty_si2q_del_uarfcn(TELNETasp_PT pt, BtsNr bts, UmtsArfcn uarfcn, UmtsScramblingCode sc) {
739 f_vty_enter_cfg_bts(pt, bts);
740 f_vty_transceive(pt, "si2quater neighbor-list del uarfcn " & int2str(uarfcn) & " " & int2str(sc));
741 f_vty_transceive(pt, "end");
742 }
743
744 testcase TC_telnet() runs on dummy_CT {
745 f_init();
Harald Welte9a907b32017-07-15 10:34:27 +0200746
747 f_vty_transceive(BSCVTY, "show network")
Harald Welte9a907b32017-07-15 10:34:27 +0200748 f_vty_transceive(BSCVTY, "network")
749 f_vty_transceive(BSCVTY, "bts 0")
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200750 f_vty_transceive(BSCVTY, "end")
751 setverdict(pass);
Harald Welte9a907b32017-07-15 10:34:27 +0200752 }
753
Harald Welte56db5fd2017-07-14 18:25:59 +0200754 control {
755 execute(TC_si1());
Harald Welte9a907b32017-07-15 10:34:27 +0200756 execute(TC_telnet());
Harald Weltebdc5dbd2017-07-16 00:00:43 +0200757 execute(TC_si_default());
758 execute(TC_si_sched_2bis());
759 execute(TC_si_sched_2ter());
760 execute(TC_si_sched_2ter_2bis());
761 execute(TC_si_sched_2quater());
762 execute(TC_si_sched_13());
Harald Weltefe1052d2017-07-16 01:24:01 +0200763 execute(TC_si_sched_13_2bis_2ter_2quater());
Harald Welte56db5fd2017-07-14 18:25:59 +0200764 }
765}