Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 1 | # osmo_gsm_tester: specifics for running an SRS eNodeB process |
| 2 | # |
| 3 | # Copyright (C) 2020 by sysmocom - s.f.m.c. GmbH |
| 4 | # |
| 5 | # Author: Pau Espin Pedrol <pespin@sysmocom.de> |
| 6 | # |
| 7 | # This program is free software: you can redistribute it and/or modify |
| 8 | # it under the terms of the GNU General Public License as |
| 9 | # published by the Free Software Foundation, either version 3 of the |
| 10 | # License, or (at your option) any later version. |
| 11 | # |
| 12 | # This program is distributed in the hope that it will be useful, |
| 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 | # GNU General Public License for more details. |
| 16 | # |
| 17 | # You should have received a copy of the GNU General Public License |
| 18 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 19 | |
| 20 | import os |
| 21 | import pprint |
| 22 | |
Pau Espin Pedrol | e1a58bd | 2020-04-10 20:46:07 +0200 | [diff] [blame] | 23 | from ..core import log, util, config, template, process, remote |
Pau Espin Pedrol | 786a6bc | 2020-03-30 13:51:21 +0200 | [diff] [blame] | 24 | from . import enb |
Pau Espin Pedrol | d4404d5 | 2020-04-20 13:29:31 +0200 | [diff] [blame] | 25 | from . import rfemu |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 26 | |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 27 | from ..core import schema |
| 28 | |
| 29 | def on_register_schemas(): |
| 30 | config_schema = { |
| 31 | 'enable_pcap': schema.BOOL_STR, |
| 32 | } |
| 33 | schema.register_config_schema('enb', config_schema) |
| 34 | |
Pau Espin Pedrol | a9a2fe2 | 2020-02-13 19:29:55 +0100 | [diff] [blame] | 35 | def rf_type_valid(rf_type_str): |
Pau Espin Pedrol | 12ae6d7 | 2020-04-01 14:12:10 +0200 | [diff] [blame] | 36 | return rf_type_str in ('zmq', 'uhd', 'soapy', 'bladerf') |
Pau Espin Pedrol | a9a2fe2 | 2020-02-13 19:29:55 +0100 | [diff] [blame] | 37 | |
Pau Espin Pedrol | 786a6bc | 2020-03-30 13:51:21 +0200 | [diff] [blame] | 38 | class srsENB(enb.eNodeB): |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 39 | |
| 40 | REMOTE_DIR = '/osmo-gsm-tester-srsenb' |
| 41 | BINFILE = 'srsenb' |
| 42 | CFGFILE = 'srsenb.conf' |
| 43 | CFGFILE_SIB = 'srsenb_sib.conf' |
| 44 | CFGFILE_RR = 'srsenb_rr.conf' |
| 45 | CFGFILE_DRB = 'srsenb_drb.conf' |
| 46 | LOGFILE = 'srsenb.log' |
Pau Espin Pedrol | 1e81b5a | 2020-03-16 12:42:17 +0100 | [diff] [blame] | 47 | PCAPFILE = 'srsenb.pcap' |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 48 | |
| 49 | def __init__(self, suite_run, conf): |
Pau Espin Pedrol | 786a6bc | 2020-03-30 13:51:21 +0200 | [diff] [blame] | 50 | super().__init__(suite_run, conf, srsENB.BINFILE) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 51 | self.ue = None |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 52 | self.run_dir = None |
Pau Espin Pedrol | d4404d5 | 2020-04-20 13:29:31 +0200 | [diff] [blame] | 53 | self.gen_conf = None |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 54 | self.config_file = None |
| 55 | self.config_sib_file = None |
| 56 | self.config_rr_file = None |
| 57 | self.config_drb_file = None |
Pau Espin Pedrol | 1e81b5a | 2020-03-16 12:42:17 +0100 | [diff] [blame] | 58 | self.log_file = None |
| 59 | self.pcap_file = None |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 60 | self.process = None |
| 61 | self.rem_host = None |
| 62 | self.remote_config_file = None |
| 63 | self.remote_config_sib_file = None |
| 64 | self.remote_config_rr_file = None |
| 65 | self.remote_config_drb_file = None |
| 66 | self.remote_log_file = None |
Pau Espin Pedrol | 1e81b5a | 2020-03-16 12:42:17 +0100 | [diff] [blame] | 67 | self.remote_pcap_file = None |
Pau Espin Pedrol | 1e81b5a | 2020-03-16 12:42:17 +0100 | [diff] [blame] | 68 | self.enable_pcap = False |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 69 | self.suite_run = suite_run |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 70 | self.remote_user = conf.get('remote_user', None) |
Pau Espin Pedrol | 76b2c2a | 2020-04-01 19:51:08 +0200 | [diff] [blame] | 71 | self._additional_args = [] |
Pau Espin Pedrol | a9a2fe2 | 2020-02-13 19:29:55 +0100 | [diff] [blame] | 72 | if not rf_type_valid(conf.get('rf_dev_type', None)): |
| 73 | raise log.Error('Invalid rf_dev_type=%s' % conf.get('rf_dev_type', None)) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 74 | |
| 75 | def cleanup(self): |
| 76 | if self.process is None: |
| 77 | return |
| 78 | if self.setup_runs_locally(): |
| 79 | return |
| 80 | # copy back files (may not exist, for instance if there was an early error of process): |
| 81 | try: |
| 82 | self.rem_host.scpfrom('scp-back-log', self.remote_log_file, self.log_file) |
| 83 | except Exception as e: |
| 84 | self.log(repr(e)) |
Pau Espin Pedrol | 1e81b5a | 2020-03-16 12:42:17 +0100 | [diff] [blame] | 85 | if self.enable_pcap: |
| 86 | try: |
| 87 | self.rem_host.scpfrom('scp-back-pcap', self.remote_pcap_file, self.pcap_file) |
| 88 | except Exception as e: |
| 89 | self.log(repr(e)) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 90 | |
| 91 | def setup_runs_locally(self): |
| 92 | return self.remote_user is None |
| 93 | |
| 94 | def start(self, epc): |
| 95 | self.log('Starting srsENB') |
Pau Espin Pedrol | e44e76a | 2020-03-31 12:35:19 +0200 | [diff] [blame] | 96 | self._epc = epc |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 97 | self.run_dir = util.Dir(self.suite_run.get_test_run_dir().new_dir(self.name())) |
| 98 | self.configure() |
| 99 | if self.remote_user: |
| 100 | self.start_remotely() |
| 101 | else: |
| 102 | self.start_locally() |
| 103 | |
Andre Puschmann | c2c8221 | 2020-03-24 16:39:35 +0100 | [diff] [blame] | 104 | # send t+Enter to enable console trace |
| 105 | self.dbg('Enabling console trace') |
| 106 | self.process.stdin_write('t\n') |
| 107 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 108 | def start_remotely(self): |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 109 | remote_env = { 'LD_LIBRARY_PATH': self.remote_inst.child('lib') } |
| 110 | remote_binary = self.remote_inst.child('bin', srsENB.BINFILE) |
Pau Espin Pedrol | 135c609 | 2020-04-16 13:35:59 +0200 | [diff] [blame] | 111 | args = (remote_binary, self.remote_config_file) |
Pau Espin Pedrol | 76b2c2a | 2020-04-01 19:51:08 +0200 | [diff] [blame] | 112 | args += tuple(self._additional_args) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 113 | |
Andre Puschmann | c2c8221 | 2020-03-24 16:39:35 +0100 | [diff] [blame] | 114 | self.process = self.rem_host.RemoteProcess(srsENB.BINFILE, args, remote_env=remote_env) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 115 | self.suite_run.remember_to_stop(self.process) |
| 116 | self.process.launch() |
| 117 | |
| 118 | def start_locally(self): |
Pau Espin Pedrol | 135c609 | 2020-04-16 13:35:59 +0200 | [diff] [blame] | 119 | binary = self.inst.child('bin', srsENB.BINFILE) |
| 120 | lib = self.inst.child('lib') |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 121 | env = { 'LD_LIBRARY_PATH': util.prepend_library_path(lib) } |
Pau Espin Pedrol | 135c609 | 2020-04-16 13:35:59 +0200 | [diff] [blame] | 122 | args = (binary, os.path.abspath(self.config_file)) |
Pau Espin Pedrol | 76b2c2a | 2020-04-01 19:51:08 +0200 | [diff] [blame] | 123 | args += tuple(self._additional_args) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 124 | |
| 125 | self.process = process.Process(self.name(), self.run_dir, args, env=env) |
| 126 | self.suite_run.remember_to_stop(self.process) |
| 127 | self.process.launch() |
| 128 | |
Pau Espin Pedrol | f4cce26 | 2020-03-31 10:49:47 +0200 | [diff] [blame] | 129 | def gen_conf_file(self, path, filename, values): |
| 130 | self.dbg('srsENB ' + filename + ':\n' + pprint.pformat(values)) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 131 | |
Pau Espin Pedrol | f4cce26 | 2020-03-31 10:49:47 +0200 | [diff] [blame] | 132 | with open(path, 'w') as f: |
| 133 | r = template.render(filename, values) |
| 134 | self.dbg(r) |
| 135 | f.write(r) |
| 136 | |
| 137 | def configure(self): |
Pau Espin Pedrol | 135c609 | 2020-04-16 13:35:59 +0200 | [diff] [blame] | 138 | self.inst = util.Dir(os.path.abspath(self.suite_run.trial.get_inst('srslte'))) |
| 139 | if not os.path.isdir(self.inst.child('lib')): |
| 140 | raise log.Error('No lib/ in', self.inst) |
| 141 | if not self.inst.isfile('bin', srsENB.BINFILE): |
| 142 | raise log.Error('No %s binary in' % srsENB.BINFILE, self.inst) |
| 143 | |
| 144 | self.config_file = self.run_dir.child(srsENB.CFGFILE) |
| 145 | self.config_sib_file = self.run_dir.child(srsENB.CFGFILE_SIB) |
| 146 | self.config_rr_file = self.run_dir.child(srsENB.CFGFILE_RR) |
| 147 | self.config_drb_file = self.run_dir.child(srsENB.CFGFILE_DRB) |
| 148 | self.log_file = self.run_dir.child(srsENB.LOGFILE) |
| 149 | self.pcap_file = self.run_dir.child(srsENB.PCAPFILE) |
| 150 | |
| 151 | if not self.setup_runs_locally(): |
| 152 | self.rem_host = remote.RemoteHost(self.run_dir, self.remote_user, self._addr) |
| 153 | remote_prefix_dir = util.Dir(srsENB.REMOTE_DIR) |
| 154 | self.remote_inst = util.Dir(remote_prefix_dir.child(os.path.basename(str(self.inst)))) |
| 155 | remote_run_dir = util.Dir(remote_prefix_dir.child(srsENB.BINFILE)) |
| 156 | |
| 157 | self.remote_config_file = remote_run_dir.child(srsENB.CFGFILE) |
| 158 | self.remote_config_sib_file = remote_run_dir.child(srsENB.CFGFILE_SIB) |
| 159 | self.remote_config_rr_file = remote_run_dir.child(srsENB.CFGFILE_RR) |
| 160 | self.remote_config_drb_file = remote_run_dir.child(srsENB.CFGFILE_DRB) |
| 161 | self.remote_log_file = remote_run_dir.child(srsENB.LOGFILE) |
| 162 | self.remote_pcap_file = remote_run_dir.child(srsENB.PCAPFILE) |
| 163 | |
Pau Espin Pedrol | c04528c | 2020-04-01 13:55:51 +0200 | [diff] [blame] | 164 | values = super().configure(['srsenb']) |
Pau Espin Pedrol | a9a2fe2 | 2020-02-13 19:29:55 +0100 | [diff] [blame] | 165 | |
Pau Espin Pedrol | 135c609 | 2020-04-16 13:35:59 +0200 | [diff] [blame] | 166 | sibfile = self.config_sib_file if self.setup_runs_locally() else self.remote_config_sib_file |
| 167 | rrfile = self.config_rr_file if self.setup_runs_locally() else self.remote_config_rr_file |
| 168 | drbfile = self.config_drb_file if self.setup_runs_locally() else self.remote_config_drb_file |
| 169 | logfile = self.log_file if self.setup_runs_locally() else self.remote_log_file |
| 170 | pcapfile = self.pcap_file if self.setup_runs_locally() else self.remote_pcap_file |
| 171 | config.overlay(values, dict(enb=dict(sib_filename=sibfile, |
| 172 | rr_filename=rrfile, |
| 173 | drb_filename=drbfile, |
| 174 | log_filename=logfile, |
| 175 | pcap_filename=pcapfile, |
| 176 | ))) |
| 177 | |
Pau Espin Pedrol | 1e81b5a | 2020-03-16 12:42:17 +0100 | [diff] [blame] | 178 | # Convert parsed boolean string to Python boolean: |
| 179 | self.enable_pcap = util.str2bool(values['enb'].get('enable_pcap', 'false')) |
| 180 | config.overlay(values, dict(enb={'enable_pcap': self.enable_pcap})) |
| 181 | |
Pau Espin Pedrol | 76b2c2a | 2020-04-01 19:51:08 +0200 | [diff] [blame] | 182 | self._additional_args = values['enb'].get('additional_args', '').split() |
| 183 | |
Pau Espin Pedrol | a9a2fe2 | 2020-02-13 19:29:55 +0100 | [diff] [blame] | 184 | # We need to set some specific variables programatically here to match IP addresses: |
| 185 | if self._conf.get('rf_dev_type') == 'zmq': |
Andre Puschmann | e2a6da6 | 2020-04-20 20:39:34 +0200 | [diff] [blame] | 186 | rf_dev_args = self.get_zmq_rf_dev_args() |
Pau Espin Pedrol | 6c42bb5 | 2020-02-27 15:05:11 +0100 | [diff] [blame] | 187 | config.overlay(values, dict(enb=dict(rf_dev_args=rf_dev_args))) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 188 | |
Andre Puschmann | 7225d52 | 2020-03-26 20:54:45 +0100 | [diff] [blame] | 189 | # Set UHD frame size as a function of the cell bandwidth on B2XX |
Pau Espin Pedrol | 6b8f5ae | 2020-04-07 18:51:57 +0200 | [diff] [blame] | 190 | if self._conf.get('rf_dev_type') == 'uhd' and values['enb'].get('rf_dev_args', None) is not None: |
Andre Puschmann | 7225d52 | 2020-03-26 20:54:45 +0100 | [diff] [blame] | 191 | if 'b200' in values['enb'].get('rf_dev_args'): |
| 192 | rf_dev_args = values['enb'].get('rf_dev_args', '') |
| 193 | rf_dev_args += ',' if rf_dev_args != '' and not rf_dev_args.endswith(',') else '' |
| 194 | |
| 195 | if self._num_prb < 25: |
| 196 | rf_dev_args += 'send_frame_size=512,recv_frame_size=512' |
| 197 | elif self._num_prb == 25: |
| 198 | rf_dev_args += 'send_frame_size=1024,recv_frame_size=1024' |
| 199 | elif self._num_prb > 25: |
| 200 | rf_dev_args += 'num_recv_frames=64,num_send_frames=64' |
| 201 | |
| 202 | if self._num_prb > 50: |
| 203 | # Reduce over the wire format to sc12 |
| 204 | rf_dev_args += ',otw_format=sc12' |
| 205 | |
| 206 | config.overlay(values, dict(enb=dict(rf_dev_args=rf_dev_args))) |
| 207 | |
Pau Espin Pedrol | d4404d5 | 2020-04-20 13:29:31 +0200 | [diff] [blame] | 208 | self.gen_conf = values |
| 209 | |
Pau Espin Pedrol | f4cce26 | 2020-03-31 10:49:47 +0200 | [diff] [blame] | 210 | self.gen_conf_file(self.config_file, srsENB.CFGFILE, values) |
| 211 | self.gen_conf_file(self.config_sib_file, srsENB.CFGFILE_SIB, values) |
| 212 | self.gen_conf_file(self.config_rr_file, srsENB.CFGFILE_RR, values) |
| 213 | self.gen_conf_file(self.config_drb_file, srsENB.CFGFILE_DRB, values) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 214 | |
Pau Espin Pedrol | 135c609 | 2020-04-16 13:35:59 +0200 | [diff] [blame] | 215 | if not self.setup_runs_locally(): |
| 216 | self.rem_host.recreate_remote_dir(self.remote_inst) |
| 217 | self.rem_host.scp('scp-inst-to-remote', str(self.inst), remote_prefix_dir) |
| 218 | self.rem_host.recreate_remote_dir(remote_run_dir) |
| 219 | self.rem_host.scp('scp-cfg-to-remote', self.config_file, self.remote_config_file) |
| 220 | self.rem_host.scp('scp-cfg-sib-to-remote', self.config_sib_file, self.remote_config_sib_file) |
| 221 | self.rem_host.scp('scp-cfg-rr-to-remote', self.config_rr_file, self.remote_config_rr_file) |
| 222 | self.rem_host.scp('scp-cfg-drb-to-remote', self.config_drb_file, self.remote_config_drb_file) |
| 223 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 224 | def ue_add(self, ue): |
| 225 | if self.ue is not None: |
| 226 | raise log.Error("More than one UE per ENB not yet supported (ZeroMQ)") |
| 227 | self.ue = ue |
| 228 | |
| 229 | def running(self): |
| 230 | return not self.process.terminated() |
| 231 | |
Pau Espin Pedrol | d4404d5 | 2020-04-20 13:29:31 +0200 | [diff] [blame] | 232 | def get_rfemu(self, cell=0, dl=True): |
| 233 | cell_list = self.gen_conf['enb'].get('cell_list', None) |
| 234 | if cell_list is None or len(cell_list) < cell + 1: |
| 235 | raise log.Error('cell_list attribute or subitem not found!') |
| 236 | rfemu_cfg = cell_list[cell].get('dl_rfemu', None) |
| 237 | if rfemu_cfg is None: # craft amarisfot by default: |
| 238 | raise log.Error('rfemu attribute not found in cell_list item!') |
| 239 | rfemu_obj = rfemu.get_instance_by_type(rfemu_cfg['type'], rfemu_cfg) |
| 240 | return rfemu_obj |
| 241 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 242 | # vim: expandtab tabstop=4 shiftwidth=4 |