Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 1 | # osmo_gsm_tester: specifics for running a sysmoBTS |
| 2 | # |
| 3 | # Copyright (C) 2016-2017 by sysmocom - s.f.m.c. GmbH |
| 4 | # |
| 5 | # Author: Neels Hofmeyr <neels@hofmeyr.de> |
| 6 | # |
| 7 | # This program is free software: you can redistribute it and/or modify |
Harald Welte | 2720534 | 2017-06-03 09:51:45 +0200 | [diff] [blame] | 8 | # it under the terms of the GNU General Public License as |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 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 |
Harald Welte | 2720534 | 2017-06-03 09:51:45 +0200 | [diff] [blame] | 15 | # GNU General Public License for more details. |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 16 | # |
Harald Welte | 2720534 | 2017-06-03 09:51:45 +0200 | [diff] [blame] | 17 | # You should have received a copy of the GNU General Public License |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 18 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 19 | |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 20 | import os |
Neels Hofmeyr | 943c81d | 2017-05-22 20:16:03 +0200 | [diff] [blame] | 21 | import pprint |
Pau Espin Pedrol | ce35d91 | 2017-11-23 11:01:24 +0100 | [diff] [blame^] | 22 | from . import log, config, util, template, process, pcu_sysmo |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 23 | |
| 24 | class SysmoBts(log.Origin): |
| 25 | suite_run = None |
Neels Hofmeyr | c4ba4a6 | 2017-05-18 19:31:44 +0200 | [diff] [blame] | 26 | bsc = None |
Pau Espin Pedrol | ce35d91 | 2017-11-23 11:01:24 +0100 | [diff] [blame^] | 27 | sgsn = None |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 28 | run_dir = None |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 29 | inst = None |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 30 | remote_inst = None |
| 31 | remote_env = None |
| 32 | remote_dir = None |
Pau Espin Pedrol | 5e0c251 | 2017-11-06 18:40:23 +0100 | [diff] [blame] | 33 | lac = None |
Pau Espin Pedrol | 4ccce7c | 2017-11-07 11:13:20 +0100 | [diff] [blame] | 34 | cellid = None |
Pau Espin Pedrol | d0a0111 | 2017-11-28 12:15:10 +0100 | [diff] [blame] | 35 | proc_bts = None |
Pau Espin Pedrol | ce35d91 | 2017-11-23 11:01:24 +0100 | [diff] [blame^] | 36 | _pcu = None |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 37 | |
Pau Espin Pedrol | ce35d91 | 2017-11-23 11:01:24 +0100 | [diff] [blame^] | 38 | REMOTE_DIR = '/osmo-gsm-tester-bts' |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 39 | BTS_SYSMO_BIN = 'osmo-bts-sysmo' |
| 40 | BTS_SYSMO_CFG = 'osmo-bts-sysmo.cfg' |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 41 | |
| 42 | def __init__(self, suite_run, conf): |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 43 | super().__init__(log.C_RUN, self.BTS_SYSMO_BIN) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 44 | self.suite_run = suite_run |
| 45 | self.conf = conf |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 46 | self.remote_env = {} |
Pau Espin Pedrol | 3895fec | 2017-04-28 16:13:03 +0200 | [diff] [blame] | 47 | self.remote_user = 'root' |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 48 | |
| 49 | def start(self): |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 50 | if self.bsc is None: |
| 51 | raise RuntimeError('BTS needs to be added to a BSC or NITB before it can be started') |
| 52 | log.log('Starting sysmoBTS to connect to', self.bsc) |
Pau Espin Pedrol | d091233 | 2017-06-14 13:27:08 +0200 | [diff] [blame] | 53 | self.run_dir = util.Dir(self.suite_run.get_test_run_dir().new_dir(self.name())) |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 54 | self.configure() |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 55 | |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 56 | self.inst = util.Dir(os.path.abspath(self.suite_run.trial.get_inst(SysmoBts.BTS_SYSMO_BIN))) |
| 57 | lib = self.inst.child('lib') |
| 58 | if not os.path.isdir(lib): |
| 59 | raise log.Error('No lib/ in', self.inst) |
| 60 | if not self.inst.isfile('bin', SysmoBts.BTS_SYSMO_BIN): |
| 61 | raise log.Error('No osmo-bts-sysmo binary in', self.inst) |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 62 | |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 63 | self.remote_dir = util.Dir(SysmoBts.REMOTE_DIR) |
| 64 | self.remote_inst = util.Dir(self.remote_dir.child(os.path.basename(str(self.inst)))) |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 65 | |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 66 | self.run_remote('rm-remote-dir', ('test', '!', '-d', SysmoBts.REMOTE_DIR, '||', 'rm', '-rf', SysmoBts.REMOTE_DIR)) |
| 67 | self.run_remote('mk-remote-dir', ('mkdir', '-p', SysmoBts.REMOTE_DIR)) |
| 68 | self.run_local('scp-inst-to-sysmobts', |
| 69 | ('scp', '-r', str(self.inst), '%s@%s:%s' % (self.remote_user, self.remote_addr(), str(self.remote_inst)))) |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 70 | |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 71 | remote_run_dir = self.remote_dir.child(SysmoBts.BTS_SYSMO_BIN) |
| 72 | self.run_remote('mk-remote-run-dir', ('mkdir', '-p', remote_run_dir)) |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 73 | |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 74 | remote_config_file = self.remote_dir.child(SysmoBts.BTS_SYSMO_CFG) |
| 75 | self.run_local('scp-cfg-to-sysmobts', |
| 76 | ('scp', '-r', self.config_file, '%s@%s:%s' % (self.remote_user, self.remote_addr(), remote_config_file))) |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 77 | |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 78 | self.run_remote('reload-dsp-firmware', ('/bin/sh', '-c', '"cat /lib/firmware/sysmobts-v?.bit > /dev/fpgadl_par0 ; cat /lib/firmware/sysmobts-v?.out > /dev/dspdl_dm644x_0"')) |
Neels Hofmeyr | 96ed9ab | 2017-05-04 14:30:39 +0200 | [diff] [blame] | 79 | |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 80 | remote_lib = self.remote_inst.child('lib') |
| 81 | remote_binary = self.remote_inst.child('bin', 'osmo-bts-sysmo') |
Pau Espin Pedrol | ce35d91 | 2017-11-23 11:01:24 +0100 | [diff] [blame^] | 82 | |
| 83 | args = ('LD_LIBRARY_PATH=%s' % remote_lib, |
| 84 | remote_binary, '-c', remote_config_file, '-r', '1', |
| 85 | '-i', self.bsc.addr()) |
| 86 | |
| 87 | if self._direct_pcu_enabled(): |
| 88 | args += ('-M',) |
| 89 | |
| 90 | self.proc_bts = self.launch_remote('osmo-bts-sysmo', args, remote_cwd=remote_run_dir) |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 91 | |
Pau Espin Pedrol | 15aae98 | 2017-09-08 13:55:54 +0200 | [diff] [blame] | 92 | def cleanup(self): |
| 93 | pass |
| 94 | |
Pau Espin Pedrol | ce35d91 | 2017-11-23 11:01:24 +0100 | [diff] [blame^] | 95 | def _direct_pcu_enabled(self): |
| 96 | return util.str2bool(self.conf.get('direct_pcu')) |
| 97 | |
Pau Espin Pedrol | 15aae98 | 2017-09-08 13:55:54 +0200 | [diff] [blame] | 98 | def pcu_socket_path(self): |
| 99 | return os.path.join(SysmoBts.REMOTE_DIR, 'pcu_bts') |
| 100 | |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 101 | def _process_remote(self, name, popen_args, remote_cwd=None): |
| 102 | run_dir = self.run_dir.new_dir(name) |
Neels Hofmeyr | d41dae9 | 2017-05-22 19:58:41 +0200 | [diff] [blame] | 103 | return process.RemoteProcess(name, run_dir, self.remote_user, self.remote_addr(), remote_cwd, |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 104 | popen_args) |
| 105 | |
| 106 | def run_remote(self, name, popen_args, remote_cwd=None): |
| 107 | proc = self._process_remote(name, popen_args, remote_cwd) |
| 108 | proc.launch() |
| 109 | proc.wait() |
| 110 | if proc.result != 0: |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 111 | log.ctx(proc) |
| 112 | raise log.Error('Exited in error') |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 113 | |
| 114 | def launch_remote(self, name, popen_args, remote_cwd=None): |
| 115 | proc = self._process_remote(name, popen_args, remote_cwd) |
| 116 | self.suite_run.remember_to_stop(proc) |
| 117 | proc.launch() |
Pau Espin Pedrol | d0a0111 | 2017-11-28 12:15:10 +0100 | [diff] [blame] | 118 | return proc |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 119 | |
| 120 | def run_local(self, name, popen_args): |
| 121 | run_dir = self.run_dir.new_dir(name) |
| 122 | proc = process.Process(name, run_dir, popen_args) |
| 123 | proc.launch() |
| 124 | proc.wait() |
| 125 | if proc.result != 0: |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 126 | log.ctx(proc) |
| 127 | raise log.Error('Exited in error') |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 128 | |
Pau Espin Pedrol | ce35d91 | 2017-11-23 11:01:24 +0100 | [diff] [blame^] | 129 | def pcu(self): |
| 130 | if self._pcu is None: |
| 131 | self._pcu = pcu_sysmo.OsmoPcuSysmo(self.suite_run, self, self.conf) |
| 132 | return self._pcu |
| 133 | |
Neels Hofmeyr | d41dae9 | 2017-05-22 19:58:41 +0200 | [diff] [blame] | 134 | def remote_addr(self): |
| 135 | return self.conf.get('addr') |
| 136 | |
Pau Espin Pedrol | ce35d91 | 2017-11-23 11:01:24 +0100 | [diff] [blame^] | 137 | def pcu_socket_path(self): |
| 138 | return os.path.join(SysmoBts.REMOTE_DIR, 'pcu_bts') |
| 139 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 140 | def configure(self): |
Neels Hofmeyr | c4ba4a6 | 2017-05-18 19:31:44 +0200 | [diff] [blame] | 141 | if self.bsc is None: |
| 142 | raise RuntimeError('BTS needs to be added to a BSC or NITB before it can be configured') |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 143 | |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 144 | self.config_file = self.run_dir.new_file(SysmoBts.BTS_SYSMO_CFG) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 145 | self.dbg(config_file=self.config_file) |
| 146 | |
| 147 | values = { 'osmo_bts_sysmo': config.get_defaults('osmo_bts_sysmo') } |
| 148 | config.overlay(values, self.suite_run.config()) |
Pau Espin Pedrol | 329b6f4 | 2017-08-08 13:55:24 +0200 | [diff] [blame] | 149 | config.overlay(values, { |
| 150 | 'osmo_bts_sysmo': { |
| 151 | 'oml_remote_ip': self.bsc.addr(), |
Pau Espin Pedrol | 15aae98 | 2017-09-08 13:55:54 +0200 | [diff] [blame] | 152 | 'pcu_socket_path': self.pcu_socket_path(), |
Pau Espin Pedrol | 329b6f4 | 2017-08-08 13:55:24 +0200 | [diff] [blame] | 153 | } |
| 154 | }) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 155 | config.overlay(values, { 'osmo_bts_sysmo': self.conf }) |
Neels Hofmeyr | 943c81d | 2017-05-22 20:16:03 +0200 | [diff] [blame] | 156 | |
| 157 | self.dbg('SYSMOBTS CONFIG:\n' + pprint.pformat(values)) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 158 | |
| 159 | with open(self.config_file, 'w') as f: |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 160 | r = template.render(SysmoBts.BTS_SYSMO_CFG, values) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 161 | self.dbg(r) |
| 162 | f.write(r) |
| 163 | |
Neels Hofmeyr | c4ba4a6 | 2017-05-18 19:31:44 +0200 | [diff] [blame] | 164 | def conf_for_bsc(self): |
| 165 | values = config.get_defaults('bsc_bts') |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 166 | config.overlay(values, config.get_defaults('osmo_bts_sysmo')) |
Pau Espin Pedrol | 5e0c251 | 2017-11-06 18:40:23 +0100 | [diff] [blame] | 167 | if self.lac is not None: |
| 168 | config.overlay(values, { 'location_area_code': self.lac }) |
Pau Espin Pedrol | 4ccce7c | 2017-11-07 11:13:20 +0100 | [diff] [blame] | 169 | if self.cellid is not None: |
| 170 | config.overlay(values, { 'cell_identity': self.cellid }) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 171 | config.overlay(values, self.conf) |
Pau Espin Pedrol | ce35d91 | 2017-11-23 11:01:24 +0100 | [diff] [blame^] | 172 | |
| 173 | sgsn_conf = {} if self.sgsn is None else self.sgsn.conf_for_client() |
| 174 | config.overlay(values, sgsn_conf) |
| 175 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 176 | self.dbg(conf=values) |
| 177 | return values |
| 178 | |
Pau Espin Pedrol | d0a0111 | 2017-11-28 12:15:10 +0100 | [diff] [blame] | 179 | def ready_for_pcu(self): |
| 180 | if not self.proc_bts or not self.proc_bts.is_running: |
| 181 | return False |
| 182 | return 'BTS is up' in (self.proc_bts.get_stderr() or '') |
| 183 | |
Neels Hofmeyr | c4ba4a6 | 2017-05-18 19:31:44 +0200 | [diff] [blame] | 184 | def set_bsc(self, bsc): |
| 185 | self.bsc = bsc |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 186 | |
Pau Espin Pedrol | ce35d91 | 2017-11-23 11:01:24 +0100 | [diff] [blame^] | 187 | def set_sgsn(self, sgsn): |
| 188 | self.sgsn = sgsn |
| 189 | |
Pau Espin Pedrol | 5e0c251 | 2017-11-06 18:40:23 +0100 | [diff] [blame] | 190 | def set_lac(self, lac): |
| 191 | self.lac = lac |
| 192 | |
Pau Espin Pedrol | 4ccce7c | 2017-11-07 11:13:20 +0100 | [diff] [blame] | 193 | def set_cellid(self, cellid): |
| 194 | self.cellid = cellid |
| 195 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 196 | # vim: expandtab tabstop=4 shiftwidth=4 |