Pau Espin Pedrol | 786a6bc | 2020-03-30 13:51:21 +0200 | [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 | 786a6bc | 2020-03-30 13:51:21 +0200 | [diff] [blame] | 26 | |
| 27 | def rf_type_valid(rf_type_str): |
Pau Espin Pedrol | d45a29e | 2020-04-02 17:21:47 +0200 | [diff] [blame] | 28 | return rf_type_str in ('uhd', 'zmq') |
Pau Espin Pedrol | 786a6bc | 2020-03-30 13:51:21 +0200 | [diff] [blame] | 29 | |
| 30 | #reference: srsLTE.git srslte_symbol_sz() |
| 31 | def num_prb2symbol_sz(num_prb): |
| 32 | if num_prb <= 6: |
| 33 | return 128 |
| 34 | if num_prb <= 15: |
| 35 | return 256 |
| 36 | if num_prb <= 25: |
| 37 | return 384 |
| 38 | if num_prb <= 50: |
| 39 | return 768 |
| 40 | if num_prb <= 75: |
| 41 | return 1024 |
| 42 | if num_prb <= 110: |
| 43 | return 1536 |
| 44 | raise log.Error('invalid num_prb %r', num_prb) |
| 45 | |
| 46 | def num_prb2base_srate(num_prb): |
| 47 | return num_prb2symbol_sz(num_prb) * 15 * 1000 |
| 48 | |
| 49 | class AmarisoftENB(enb.eNodeB): |
| 50 | |
| 51 | REMOTE_DIR = '/osmo-gsm-tester-amarisoftenb' |
| 52 | BINFILE = 'lteenb' |
Andre Puschmann | e4d5a13 | 2020-04-14 22:23:06 +0200 | [diff] [blame] | 53 | CFGFILE = 'amarisoft_enb.cfg' |
Pau Espin Pedrol | 786a6bc | 2020-03-30 13:51:21 +0200 | [diff] [blame] | 54 | CFGFILE_SIB1 = 'amarisoft_sib1.asn' |
| 55 | CFGFILE_SIB23 = 'amarisoft_sib23.asn' |
| 56 | CFGFILE_RF = 'amarisoft_rf_driver.cfg' |
| 57 | CFGFILE_DRB = 'amarisoft_drb.cfg' |
| 58 | LOGFILE = 'lteenb.log' |
| 59 | |
| 60 | def __init__(self, suite_run, conf): |
| 61 | super().__init__(suite_run, conf, 'amarisoftenb') |
| 62 | self.ue = None |
Pau Espin Pedrol | 786a6bc | 2020-03-30 13:51:21 +0200 | [diff] [blame] | 63 | self.run_dir = None |
Pau Espin Pedrol | 214f15e | 2020-04-03 16:56:12 +0200 | [diff] [blame] | 64 | self.inst = None |
Pau Espin Pedrol | 786a6bc | 2020-03-30 13:51:21 +0200 | [diff] [blame] | 65 | self._bin_prefix = None |
Pau Espin Pedrol | d4404d5 | 2020-04-20 13:29:31 +0200 | [diff] [blame] | 66 | self.gen_conf = None |
Pau Espin Pedrol | 786a6bc | 2020-03-30 13:51:21 +0200 | [diff] [blame] | 67 | self.config_file = None |
| 68 | self.config_sib1_file = None |
| 69 | self.config_sib23_file = None |
| 70 | self.config_rf_file = None |
| 71 | self.config_drb_file = None |
| 72 | self.log_file = None |
| 73 | self.process = None |
| 74 | self.rem_host = None |
Pau Espin Pedrol | 214f15e | 2020-04-03 16:56:12 +0200 | [diff] [blame] | 75 | self.remote_inst = None |
Pau Espin Pedrol | 786a6bc | 2020-03-30 13:51:21 +0200 | [diff] [blame] | 76 | self.remote_config_file = None |
| 77 | self.remote_config_sib1_file = None |
| 78 | self.remote_config_sib23_file = None |
| 79 | self.remote_config_rf_file = None |
| 80 | self.remote_config_drb_file = None |
| 81 | self.remote_log_file = None |
Andre Puschmann | a7f1983 | 2020-04-07 14:38:27 +0200 | [diff] [blame] | 82 | self.enable_measurements = False |
Pau Espin Pedrol | 786a6bc | 2020-03-30 13:51:21 +0200 | [diff] [blame] | 83 | self.suite_run = suite_run |
| 84 | self.remote_user = conf.get('remote_user', None) |
| 85 | if not rf_type_valid(conf.get('rf_dev_type', None)): |
| 86 | raise log.Error('Invalid rf_dev_type=%s' % conf.get('rf_dev_type', None)) |
| 87 | |
| 88 | def bin_prefix(self): |
| 89 | if self._bin_prefix is None: |
Pau Espin Pedrol | 17253af | 2020-04-02 21:11:19 +0200 | [diff] [blame] | 90 | self._bin_prefix = os.getenv('AMARISOFT_PATH_ENB', None) |
| 91 | if self._bin_prefix == None: |
| 92 | self._bin_prefix = self.suite_run.trial.get_inst('amarisoftenb') |
Pau Espin Pedrol | 786a6bc | 2020-03-30 13:51:21 +0200 | [diff] [blame] | 93 | return self._bin_prefix |
| 94 | |
| 95 | def cleanup(self): |
| 96 | if self.process is None: |
| 97 | return |
| 98 | if self.setup_runs_locally(): |
| 99 | return |
| 100 | # copy back files (may not exist, for instance if there was an early error of process): |
| 101 | try: |
| 102 | self.rem_host.scpfrom('scp-back-log', self.remote_log_file, self.log_file) |
| 103 | except Exception as e: |
| 104 | self.log(repr(e)) |
| 105 | |
| 106 | |
| 107 | def setup_runs_locally(self): |
| 108 | return self.remote_user is None |
| 109 | |
| 110 | def start(self, epc): |
| 111 | self.log('Starting AmarisoftENB') |
Pau Espin Pedrol | e44e76a | 2020-03-31 12:35:19 +0200 | [diff] [blame] | 112 | self._epc = epc |
Pau Espin Pedrol | 786a6bc | 2020-03-30 13:51:21 +0200 | [diff] [blame] | 113 | self.run_dir = util.Dir(self.suite_run.get_test_run_dir().new_dir(self.name())) |
| 114 | self.configure() |
| 115 | self._start() |
| 116 | |
| 117 | # send t+Enter to enable console trace |
| 118 | self.dbg('Enabling console trace') |
| 119 | self.process.stdin_write('t\n') |
| 120 | |
| 121 | def _start(self): |
| 122 | if self.setup_runs_locally(): |
| 123 | env = { 'LD_LIBRARY_PATH': util.prepend_library_path(self.inst) } |
| 124 | binary = self.inst.child('.', AmarisoftENB.BINFILE) |
| 125 | self.dbg(run_dir=self.run_dir, binary=binary, env=env) |
| 126 | args = (binary, os.path.abspath(self.config_file)) |
| 127 | self.process = process.Process(self.name(), self.run_dir, args, env=env) |
| 128 | else: |
| 129 | remote_env = { 'LD_LIBRARY_PATH': self.remote_inst } |
| 130 | remote_binary = self.remote_inst.child('', AmarisoftENB.BINFILE) |
| 131 | args = (remote_binary, self.remote_config_file) |
| 132 | self.process = self.rem_host.RemoteProcess(AmarisoftENB.BINFILE, args, remote_env=remote_env) |
| 133 | |
| 134 | self.suite_run.remember_to_stop(self.process) |
| 135 | self.process.launch() |
| 136 | |
| 137 | def gen_conf_file(self, path, filename, values): |
| 138 | self.dbg('AmarisoftENB ' + filename + ':\n' + pprint.pformat(values)) |
| 139 | with open(path, 'w') as f: |
| 140 | r = template.render(filename, values) |
| 141 | self.dbg(r) |
| 142 | f.write(r) |
| 143 | |
| 144 | def configure(self): |
Pau Espin Pedrol | 786a6bc | 2020-03-30 13:51:21 +0200 | [diff] [blame] | 145 | self.inst = util.Dir(os.path.abspath(self.bin_prefix())) |
Pau Espin Pedrol | 786a6bc | 2020-03-30 13:51:21 +0200 | [diff] [blame] | 146 | if not self.inst.isfile('', AmarisoftENB.BINFILE): |
| 147 | raise log.Error('No %s binary in' % AmarisoftENB.BINFILE, self.inst) |
| 148 | |
| 149 | self.config_file = self.run_dir.child(AmarisoftENB.CFGFILE) |
| 150 | self.config_sib1_file = self.run_dir.child(AmarisoftENB.CFGFILE_SIB1) |
| 151 | self.config_sib23_file = self.run_dir.child(AmarisoftENB.CFGFILE_SIB23) |
| 152 | self.config_rf_file = self.run_dir.child(AmarisoftENB.CFGFILE_RF) |
| 153 | self.config_drb_file = self.run_dir.child(AmarisoftENB.CFGFILE_DRB) |
| 154 | self.log_file = self.run_dir.child(AmarisoftENB.LOGFILE) |
| 155 | |
| 156 | if not self.setup_runs_locally(): |
| 157 | self.rem_host = remote.RemoteHost(self.run_dir, self.remote_user, self._addr) |
| 158 | remote_prefix_dir = util.Dir(AmarisoftENB.REMOTE_DIR) |
| 159 | self.remote_inst = util.Dir(remote_prefix_dir.child(os.path.basename(str(self.inst)))) |
| 160 | remote_run_dir = util.Dir(remote_prefix_dir.child(AmarisoftENB.BINFILE)) |
| 161 | |
| 162 | self.remote_config_file = remote_run_dir.child(AmarisoftENB.CFGFILE) |
| 163 | self.remote_config_sib1_file = remote_run_dir.child(AmarisoftENB.CFGFILE_SIB1) |
| 164 | self.remote_config_sib23_file = remote_run_dir.child(AmarisoftENB.CFGFILE_SIB23) |
| 165 | self.remote_config_rf_file = remote_run_dir.child(AmarisoftENB.CFGFILE_RF) |
| 166 | self.remote_config_drb_file = remote_run_dir.child(AmarisoftENB.CFGFILE_DRB) |
| 167 | self.remote_log_file = remote_run_dir.child(AmarisoftENB.LOGFILE) |
| 168 | |
Pau Espin Pedrol | c04528c | 2020-04-01 13:55:51 +0200 | [diff] [blame] | 169 | values = super().configure(['amarisoft', 'amarisoftenb']) |
Pau Espin Pedrol | 786a6bc | 2020-03-30 13:51:21 +0200 | [diff] [blame] | 170 | |
Andre Puschmann | a7f1983 | 2020-04-07 14:38:27 +0200 | [diff] [blame] | 171 | # Convert parsed boolean string to Python boolean: |
| 172 | self.enable_measurements = util.str2bool(values['enb'].get('enable_measurements', 'false')) |
| 173 | config.overlay(values, dict(enb={'enable_measurements': self.enable_measurements})) |
| 174 | |
Pau Espin Pedrol | d45a29e | 2020-04-02 17:21:47 +0200 | [diff] [blame] | 175 | # We need to set some specific variables programatically here to match IP addresses: |
| 176 | if self._conf.get('rf_dev_type') == 'zmq': |
| 177 | base_srate = num_prb2base_srate(self.num_prb()) |
| 178 | rf_dev_args = 'fail_on_disconnect=true' \ |
| 179 | + ',tx_port0=tcp://' + self.addr() + ':2000' \ |
| 180 | + ',tx_port1=tcp://' + self.addr() + ':2002' \ |
| 181 | + ',rx_port0=tcp://' + self.ue.addr() + ':2001' \ |
| 182 | + ',rx_port1=tcp://' + self.ue.addr() + ':2003' \ |
Pau Espin Pedrol | d45a29e | 2020-04-02 17:21:47 +0200 | [diff] [blame] | 183 | + ',id=enb,base_srate=' + str(base_srate) |
| 184 | config.overlay(values, dict(enb=dict(sample_rate = base_srate / (1000*1000), |
| 185 | rf_dev_args=rf_dev_args))) |
| 186 | |
| 187 | # 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] | 188 | if self._conf.get('rf_dev_type') == 'uhd' and values['enb'].get('rf_dev_args', None) is not None: |
Pau Espin Pedrol | d45a29e | 2020-04-02 17:21:47 +0200 | [diff] [blame] | 189 | if 'b200' in values['enb'].get('rf_dev_args'): |
| 190 | rf_dev_args = values['enb'].get('rf_dev_args', '') |
| 191 | rf_dev_args += ',' if rf_dev_args != '' and not rf_dev_args.endswith(',') else '' |
| 192 | |
| 193 | if self._num_prb < 25: |
| 194 | rf_dev_args += 'send_frame_size=512,recv_frame_size=512' |
| 195 | elif self._num_prb == 25: |
| 196 | rf_dev_args += 'send_frame_size=1024,recv_frame_size=1024' |
| 197 | elif self._num_prb > 25: |
| 198 | rf_dev_args += 'num_recv_frames=64,num_send_frames=64' |
| 199 | |
| 200 | if self._num_prb > 50: |
| 201 | # Reduce over the wire format to sc12 |
| 202 | rf_dev_args += ',otw_format=sc12' |
| 203 | |
| 204 | config.overlay(values, dict(enb=dict(rf_dev_args=rf_dev_args))) |
| 205 | |
Pau Espin Pedrol | 786a6bc | 2020-03-30 13:51:21 +0200 | [diff] [blame] | 206 | logfile = self.log_file if self.setup_runs_locally() else self.remote_log_file |
| 207 | config.overlay(values, dict(enb=dict(log_filename=logfile))) |
| 208 | |
Pau Espin Pedrol | 65beb8f | 2020-03-31 12:03:19 +0200 | [diff] [blame] | 209 | # rf driver is shared between amarisoft enb and ue, so it has a |
| 210 | # different cfg namespace 'trx'. Copy needed values over there: |
| 211 | config.overlay(values, dict(trx=dict(rf_dev_type=values['enb'].get('rf_dev_type', None), |
Pau Espin Pedrol | a6d6304 | 2020-04-20 15:14:51 +0200 | [diff] [blame] | 212 | rf_dev_args=values['enb'].get('rf_dev_args', None), |
| 213 | rx_gain=values['enb'].get('rx_gain', None), |
| 214 | tx_gain=values['enb'].get('tx_gain', None), |
| 215 | ))) |
Pau Espin Pedrol | 65beb8f | 2020-03-31 12:03:19 +0200 | [diff] [blame] | 216 | |
Pau Espin Pedrol | d4404d5 | 2020-04-20 13:29:31 +0200 | [diff] [blame] | 217 | self.gen_conf = values |
| 218 | |
Pau Espin Pedrol | 786a6bc | 2020-03-30 13:51:21 +0200 | [diff] [blame] | 219 | self.gen_conf_file(self.config_file, AmarisoftENB.CFGFILE, values) |
| 220 | self.gen_conf_file(self.config_sib1_file, AmarisoftENB.CFGFILE_SIB1, values) |
| 221 | self.gen_conf_file(self.config_sib23_file, AmarisoftENB.CFGFILE_SIB23, values) |
| 222 | self.gen_conf_file(self.config_rf_file, AmarisoftENB.CFGFILE_RF, values) |
| 223 | self.gen_conf_file(self.config_drb_file, AmarisoftENB.CFGFILE_DRB, values) |
| 224 | |
| 225 | if not self.setup_runs_locally(): |
| 226 | self.rem_host.recreate_remote_dir(self.remote_inst) |
| 227 | self.rem_host.scp('scp-inst-to-remote', str(self.inst), remote_prefix_dir) |
| 228 | self.rem_host.recreate_remote_dir(remote_run_dir) |
| 229 | self.rem_host.scp('scp-cfg-to-remote', self.config_file, self.remote_config_file) |
| 230 | self.rem_host.scp('scp-cfg-sib1-to-remote', self.config_sib1_file, self.remote_config_sib1_file) |
| 231 | self.rem_host.scp('scp-cfg-sib23-to-remote', self.config_sib23_file, self.remote_config_sib23_file) |
| 232 | self.rem_host.scp('scp-cfg-rr-to-remote', self.config_rf_file, self.remote_config_rf_file) |
| 233 | self.rem_host.scp('scp-cfg-drb-to-remote', self.config_drb_file, self.remote_config_drb_file) |
| 234 | |
| 235 | def ue_add(self, ue): |
| 236 | if self.ue is not None: |
| 237 | raise log.Error("More than one UE per ENB not yet supported (ZeroMQ)") |
| 238 | self.ue = ue |
| 239 | |
| 240 | def running(self): |
| 241 | return not self.process.terminated() |
| 242 | |
Pau Espin Pedrol | d4404d5 | 2020-04-20 13:29:31 +0200 | [diff] [blame] | 243 | def get_rfemu(self, cell=0, dl=True): |
| 244 | cell_list = self.gen_conf['enb'].get('cell_list', None) |
| 245 | if cell_list is None or len(cell_list) < cell + 1: |
| 246 | raise log.Error('cell_list attribute or subitem not found!') |
| 247 | rfemu_cfg = cell_list[cell].get('dl_rfemu', None) |
| 248 | if rfemu_cfg is None: # craft amarisfot by default: |
| 249 | rfemu_cfg = {'type': 'amarisoftctl', |
| 250 | 'addr': self.addr(), |
| 251 | 'ports': [9001] |
| 252 | } |
| 253 | if rfemu_cfg['type'] == 'amarisoftctl': # this one requires extra config: |
| 254 | config.overlay(rfemu_cfg, dict(cell_id=cell_list[cell]['cell_id'])) |
| 255 | rfemu_obj = rfemu.get_instance_by_type(rfemu_cfg['type'], rfemu_cfg) |
| 256 | return rfemu_obj |
| 257 | |
Pau Espin Pedrol | 786a6bc | 2020-03-30 13:51:21 +0200 | [diff] [blame] | 258 | # vim: expandtab tabstop=4 shiftwidth=4 |