Harald Welte | ffe55fc | 2018-01-17 22:39:54 +0100 | [diff] [blame] | 1 | module Osmocom_CTRL_Adapter { |
| 2 | |
Harald Welte | 34b5a95 | 2019-05-27 11:54:11 +0200 | [diff] [blame] | 3 | /* Module that test suites can 'inherit' in order to have a CTRL connection to the IUT which they're testing |
| 4 | * (C) 2018 Harald Welte <laforge@gnumonks.org> |
| 5 | * contributions by sysmocom - s.f.m.c. GmbH |
| 6 | * All rights reserved. |
| 7 | * |
| 8 | * Released under the terms of GNU General Public License, Version 2 or |
| 9 | * (at your option) any later version. |
| 10 | * |
| 11 | * SPDX-License-Identifier: GPL-2.0-or-later |
| 12 | */ |
Harald Welte | ffe55fc | 2018-01-17 22:39:54 +0100 | [diff] [blame] | 13 | |
| 14 | import from IPL4asp_Types all; |
| 15 | |
| 16 | import from IPA_Emulation all; |
| 17 | import from IPA_Types all; |
| 18 | |
| 19 | import from Osmocom_CTRL_Functions all; |
| 20 | import from Osmocom_CTRL_Types all; |
| 21 | |
| 22 | |
| 23 | type component CTRL_Adapter_CT { |
| 24 | var IPA_Emulation_CT vc_CTRL_IPA; |
Pau Espin Pedrol | f28fd08 | 2021-09-07 20:02:25 +0200 | [diff] [blame] | 25 | var boolean ipa_is_up := false; |
Harald Welte | ffe55fc | 2018-01-17 22:39:54 +0100 | [diff] [blame] | 26 | /* test port for the CTRL interface of the BSC */ |
| 27 | port IPA_CTRL_PT IPA_CTRL; |
| 28 | } |
| 29 | |
Pau Espin Pedrol | 9a5b8ff | 2021-01-04 19:01:31 +0100 | [diff] [blame] | 30 | /* wait for IPA CTRL link to connect and send UP */ |
| 31 | function f_ipa_ctrl_wait_link_up() |
Harald Welte | ffe55fc | 2018-01-17 22:39:54 +0100 | [diff] [blame] | 32 | runs on CTRL_Adapter_CT { |
Pau Espin Pedrol | f28fd08 | 2021-09-07 20:02:25 +0200 | [diff] [blame] | 33 | if (ipa_is_up == true) { |
| 34 | return; |
| 35 | } |
Harald Welte | ffe55fc | 2018-01-17 22:39:54 +0100 | [diff] [blame] | 36 | timer T := 10.0; |
Pau Espin Pedrol | 9a5b8ff | 2021-01-04 19:01:31 +0100 | [diff] [blame] | 37 | T.start; |
| 38 | alt { |
Pau Espin Pedrol | f28fd08 | 2021-09-07 20:02:25 +0200 | [diff] [blame] | 39 | [] IPA_CTRL.receive(tr_ASP_IPA_EV(ASP_IPA_EVENT_UP)) { ipa_is_up := true; } |
Pau Espin Pedrol | 9a5b8ff | 2021-01-04 19:01:31 +0100 | [diff] [blame] | 40 | [] T.timeout { |
| 41 | setverdict(fail, "Timeout CTRL waiting for ASP_IPA_EVENT_UP"); |
| 42 | mtc.stop; |
| 43 | } |
| 44 | } |
| 45 | } |
| 46 | |
Pau Espin Pedrol | f28fd08 | 2021-09-07 20:02:25 +0200 | [diff] [blame] | 47 | /* wait for IPA CTRL link to connect and send DOWN */ |
Pau Espin Pedrol | a948d14 | 2021-01-28 19:53:06 +0100 | [diff] [blame] | 48 | function f_ipa_ctrl_wait_link_down() |
| 49 | runs on CTRL_Adapter_CT { |
Pau Espin Pedrol | f28fd08 | 2021-09-07 20:02:25 +0200 | [diff] [blame] | 50 | if (ipa_is_up == false) { |
| 51 | return; |
| 52 | } |
Pau Espin Pedrol | a948d14 | 2021-01-28 19:53:06 +0100 | [diff] [blame] | 53 | timer T := 10.0; |
| 54 | T.start; |
| 55 | alt { |
Pau Espin Pedrol | f28fd08 | 2021-09-07 20:02:25 +0200 | [diff] [blame] | 56 | [] IPA_CTRL.receive(tr_ASP_IPA_EV(ASP_IPA_EVENT_DOWN)) { ipa_is_up := false; } |
Pau Espin Pedrol | a948d14 | 2021-01-28 19:53:06 +0100 | [diff] [blame] | 57 | [] T.timeout { |
| 58 | setverdict(fail, "Timeout CTRL waiting for ASP_IPA_EVENT_DOWN"); |
| 59 | mtc.stop; |
| 60 | } |
| 61 | } |
| 62 | } |
| 63 | |
Pau Espin Pedrol | 9a5b8ff | 2021-01-04 19:01:31 +0100 | [diff] [blame] | 64 | /*! Start the CTRL client connection to the specified CTRL IP+Port server*/ |
| 65 | function f_ipa_ctrl_start_client(charstring bsc_host, PortNumber bsc_port) |
| 66 | runs on CTRL_Adapter_CT { |
| 67 | var charstring id := "IPA-CTRL-CLI" |
Harald Welte | ffe55fc | 2018-01-17 22:39:54 +0100 | [diff] [blame] | 68 | |
| 69 | vc_CTRL_IPA := IPA_Emulation_CT.create(id & "-IPA"); |
| 70 | |
| 71 | map(vc_CTRL_IPA:IPA_PORT, system:IPA_CODEC_PT); |
| 72 | connect(vc_CTRL_IPA:IPA_CTRL_PORT, self:IPA_CTRL); |
| 73 | |
Philipp Maier | 1f581b4 | 2018-12-18 17:04:25 +0100 | [diff] [blame] | 74 | vc_CTRL_IPA.start(IPA_Emulation.main_client(bsc_host, bsc_port, "", 0, |
Harald Welte | 2d86aff | 2018-04-17 11:23:04 +0200 | [diff] [blame] | 75 | c_IPA_default_ccm_pars, false)); |
Harald Welte | ffe55fc | 2018-01-17 22:39:54 +0100 | [diff] [blame] | 76 | |
Pau Espin Pedrol | 9a5b8ff | 2021-01-04 19:01:31 +0100 | [diff] [blame] | 77 | f_ipa_ctrl_wait_link_up(); |
| 78 | } |
| 79 | |
| 80 | /*! Start the CTRL server on the specified CTRL IP+Port */ |
| 81 | function f_ipa_ctrl_start_server(charstring listen_host, PortNumber listen_port) |
| 82 | runs on CTRL_Adapter_CT { |
| 83 | var charstring id := "IPA-CTRL-SRV" |
| 84 | timer T := 10.0; |
| 85 | |
| 86 | vc_CTRL_IPA := IPA_Emulation_CT.create(id & "-IPA"); |
| 87 | |
| 88 | map(vc_CTRL_IPA:IPA_PORT, system:IPA_CODEC_PT); |
| 89 | connect(vc_CTRL_IPA:IPA_CTRL_PORT, self:IPA_CTRL); |
| 90 | |
Pau Espin Pedrol | 77783ca | 2021-01-28 19:58:55 +0100 | [diff] [blame] | 91 | vc_CTRL_IPA.start(IPA_Emulation.main_server(listen_host, listen_port, false, |
| 92 | server_stop_on_ipa_ev_down := false)); |
Harald Welte | ffe55fc | 2018-01-17 22:39:54 +0100 | [diff] [blame] | 93 | } |
| 94 | |
Harald Welte | 1205547 | 2018-03-17 20:10:08 +0100 | [diff] [blame] | 95 | function f_ipa_ctrl_stop() runs on CTRL_Adapter_CT { |
| 96 | vc_CTRL_IPA.stop; |
| 97 | } |
Harald Welte | ffe55fc | 2018-01-17 22:39:54 +0100 | [diff] [blame] | 98 | |
| 99 | |
| 100 | /* BSC specific CTRL helper functions */ |
| 101 | function f_ctrl_get_bts(IPA_CTRL_PT pt, integer bts_nr, charstring suffix) return CtrlValue { |
| 102 | return f_ctrl_get(pt, "bts." & int2str(bts_nr) & "." & suffix); |
| 103 | } |
Pau Espin Pedrol | 5a2d743 | 2019-06-07 19:43:45 +0200 | [diff] [blame] | 104 | function f_ctrl_set_bts(IPA_CTRL_PT pt, integer bts_nr, charstring suffix, CtrlValue val) { |
| 105 | f_ctrl_set(pt, "bts." & int2str(bts_nr) & "." & suffix, val); |
| 106 | } |
Harald Welte | ffe55fc | 2018-01-17 22:39:54 +0100 | [diff] [blame] | 107 | |
| 108 | template charstring ts_bts(integer bts_nr) := "bts." & int2str(bts_nr) & "."; |
| 109 | template charstring ts_bts_trx(integer bts_nr, integer trx_nr ) := |
| 110 | valueof(ts_bts(bts_nr)) & "trx." & int2str(trx_nr) & "."; |
| 111 | |
| 112 | function f_ctrl_get_exp_bts(IPA_CTRL_PT pt, integer bts_nr, CtrlVariable suffix, template CtrlValue exp) { |
| 113 | f_ctrl_get_exp(pt, valueof(ts_bts(bts_nr)) & suffix, exp); |
| 114 | } |
| 115 | |
| 116 | function f_ctrl_get_exp_trx(IPA_CTRL_PT pt, integer bts_nr, integer trx_nr, CtrlVariable suffix, |
| 117 | template CtrlValue exp) |
| 118 | { |
| 119 | f_ctrl_get_exp(pt, valueof(ts_bts_trx(bts_nr, trx_nr)) & suffix, exp); |
| 120 | } |
| 121 | |
Harald Welte | 8396096 | 2021-03-30 13:50:02 +0200 | [diff] [blame] | 122 | template (value) charstring ts_fsm_inst_id(charstring class_name, charstring inst_id) := |
| 123 | "fsm." & class_name & ".id." & inst_id & "."; |
| 124 | |
| 125 | /* obtain the state of a specified FSM instance */ |
| 126 | function f_ctrl_get_fsm_inst_state(IPA_CTRL_PT pt, charstring fsm_class_name, charstring fsm_inst_id) |
| 127 | return charstring { |
| 128 | return f_ctrl_get(pt, valueof(ts_fsm_inst_id(fsm_class_name, fsm_inst_id)) & "state"); |
| 129 | } |
| 130 | |
| 131 | /* expect the state of a specified FSM instance to match template */ |
| 132 | function f_ctrl_get_exp_inst_state(IPA_CTRL_PT pt, charstring fsm_class_name, |
| 133 | template (value) charstring fsm_inst_id, |
| 134 | template (present) CtrlValue exp) |
| 135 | { |
| 136 | f_ctrl_get_exp(pt, valueof(ts_fsm_inst_id(fsm_class_name, valueof(fsm_inst_id))) & "state", exp); |
| 137 | } |
| 138 | |
Harald Welte | ffe55fc | 2018-01-17 22:39:54 +0100 | [diff] [blame] | 139 | |
| 140 | } |