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 | c9817a5 | 2017-12-13 19:52:27 +0100 | [diff] [blame] | 22 | from . import log, config, util, template, process, pcu_sysmo, bts_osmo |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 23 | |
Pau Espin Pedrol | c9817a5 | 2017-12-13 19:52:27 +0100 | [diff] [blame] | 24 | class SysmoBts(bts_osmo.OsmoBts): |
Pau Espin Pedrol | 81aaeef | 2017-12-14 19:14:12 +0100 | [diff] [blame] | 25 | ############## |
| 26 | # PROTECTED |
| 27 | ############## |
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 |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 31 | remote_dir = None |
| 32 | |
Pau Espin Pedrol | ce35d91 | 2017-11-23 11:01:24 +0100 | [diff] [blame] | 33 | REMOTE_DIR = '/osmo-gsm-tester-bts' |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 34 | BTS_SYSMO_BIN = 'osmo-bts-sysmo' |
| 35 | BTS_SYSMO_CFG = 'osmo-bts-sysmo.cfg' |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 36 | |
| 37 | def __init__(self, suite_run, conf): |
Pau Espin Pedrol | e519462 | 2018-05-07 13:36:58 +0200 | [diff] [blame] | 38 | super().__init__(suite_run, conf, SysmoBts.BTS_SYSMO_BIN, 'osmo_bts_sysmo') |
Pau Espin Pedrol | 3895fec | 2017-04-28 16:13:03 +0200 | [diff] [blame] | 39 | self.remote_user = 'root' |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 40 | |
Pau Espin Pedrol | 81aaeef | 2017-12-14 19:14:12 +0100 | [diff] [blame] | 41 | def _direct_pcu_enabled(self): |
| 42 | return util.str2bool(self.conf.get('direct_pcu')) |
| 43 | |
| 44 | def _process_remote(self, name, popen_args, remote_cwd=None): |
| 45 | run_dir = self.run_dir.new_dir(name) |
| 46 | return process.RemoteProcess(name, run_dir, self.remote_user, self.remote_addr(), remote_cwd, |
| 47 | popen_args) |
| 48 | |
| 49 | def run_remote(self, name, popen_args, remote_cwd=None): |
| 50 | proc = self._process_remote(name, popen_args, remote_cwd) |
| 51 | proc.launch() |
| 52 | proc.wait() |
| 53 | if proc.result != 0: |
| 54 | log.ctx(proc) |
| 55 | raise log.Error('Exited in error') |
| 56 | |
| 57 | def launch_remote(self, name, popen_args, remote_cwd=None): |
| 58 | proc = self._process_remote(name, popen_args, remote_cwd) |
| 59 | self.suite_run.remember_to_stop(proc) |
| 60 | proc.launch() |
| 61 | return proc |
| 62 | |
| 63 | def run_local(self, name, popen_args): |
| 64 | run_dir = self.run_dir.new_dir(name) |
| 65 | proc = process.Process(name, run_dir, popen_args) |
| 66 | proc.launch() |
| 67 | proc.wait() |
| 68 | if proc.result != 0: |
| 69 | log.ctx(proc) |
| 70 | raise log.Error('Exited in error') |
| 71 | |
| 72 | def create_pcu(self): |
| 73 | return pcu_sysmo.OsmoPcuSysmo(self.suite_run, self, self.conf) |
| 74 | |
| 75 | def configure(self): |
| 76 | if self.bsc is None: |
| 77 | raise RuntimeError('BTS needs to be added to a BSC or NITB before it can be configured') |
| 78 | |
| 79 | self.config_file = self.run_dir.new_file(SysmoBts.BTS_SYSMO_CFG) |
| 80 | self.dbg(config_file=self.config_file) |
| 81 | |
| 82 | values = { 'osmo_bts_sysmo': config.get_defaults('osmo_bts_sysmo') } |
| 83 | config.overlay(values, self.suite_run.config()) |
| 84 | config.overlay(values, { |
| 85 | 'osmo_bts_sysmo': { |
| 86 | 'oml_remote_ip': self.bsc.addr(), |
| 87 | 'pcu_socket_path': self.pcu_socket_path(), |
| 88 | } |
| 89 | }) |
| 90 | config.overlay(values, { 'osmo_bts_sysmo': self.conf }) |
| 91 | |
| 92 | self.dbg('SYSMOBTS CONFIG:\n' + pprint.pformat(values)) |
| 93 | |
| 94 | with open(self.config_file, 'w') as f: |
| 95 | r = template.render(SysmoBts.BTS_SYSMO_CFG, values) |
| 96 | self.dbg(r) |
| 97 | f.write(r) |
| 98 | |
| 99 | ######################## |
| 100 | # PUBLIC - INTERNAL API |
| 101 | ######################## |
| 102 | def pcu_socket_path(self): |
| 103 | return os.path.join(SysmoBts.REMOTE_DIR, 'pcu_bts') |
| 104 | |
| 105 | def conf_for_bsc(self): |
Pau Espin Pedrol | e519462 | 2018-05-07 13:36:58 +0200 | [diff] [blame] | 106 | values = self.conf_for_bsc_prepare() |
Pau Espin Pedrol | 81aaeef | 2017-12-14 19:14:12 +0100 | [diff] [blame] | 107 | self.dbg(conf=values) |
| 108 | return values |
| 109 | |
| 110 | ################### |
| 111 | # PUBLIC (test API included) |
| 112 | ################### |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 113 | def start(self): |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 114 | if self.bsc is None: |
| 115 | raise RuntimeError('BTS needs to be added to a BSC or NITB before it can be started') |
| 116 | log.log('Starting sysmoBTS to connect to', self.bsc) |
Pau Espin Pedrol | d091233 | 2017-06-14 13:27:08 +0200 | [diff] [blame] | 117 | 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] | 118 | self.configure() |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 119 | |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 120 | self.inst = util.Dir(os.path.abspath(self.suite_run.trial.get_inst(SysmoBts.BTS_SYSMO_BIN))) |
| 121 | lib = self.inst.child('lib') |
| 122 | if not os.path.isdir(lib): |
| 123 | raise log.Error('No lib/ in', self.inst) |
| 124 | if not self.inst.isfile('bin', SysmoBts.BTS_SYSMO_BIN): |
| 125 | raise log.Error('No osmo-bts-sysmo binary in', self.inst) |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 126 | |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 127 | self.remote_dir = util.Dir(SysmoBts.REMOTE_DIR) |
| 128 | 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] | 129 | |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 130 | self.run_remote('rm-remote-dir', ('test', '!', '-d', SysmoBts.REMOTE_DIR, '||', 'rm', '-rf', SysmoBts.REMOTE_DIR)) |
| 131 | self.run_remote('mk-remote-dir', ('mkdir', '-p', SysmoBts.REMOTE_DIR)) |
| 132 | self.run_local('scp-inst-to-sysmobts', |
| 133 | ('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] | 134 | |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 135 | remote_run_dir = self.remote_dir.child(SysmoBts.BTS_SYSMO_BIN) |
| 136 | self.run_remote('mk-remote-run-dir', ('mkdir', '-p', remote_run_dir)) |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 137 | |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 138 | remote_config_file = self.remote_dir.child(SysmoBts.BTS_SYSMO_CFG) |
| 139 | self.run_local('scp-cfg-to-sysmobts', |
| 140 | ('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] | 141 | |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 142 | 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] | 143 | |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 144 | remote_lib = self.remote_inst.child('lib') |
| 145 | remote_binary = self.remote_inst.child('bin', 'osmo-bts-sysmo') |
Pau Espin Pedrol | ce35d91 | 2017-11-23 11:01:24 +0100 | [diff] [blame] | 146 | |
| 147 | args = ('LD_LIBRARY_PATH=%s' % remote_lib, |
| 148 | remote_binary, '-c', remote_config_file, '-r', '1', |
| 149 | '-i', self.bsc.addr()) |
| 150 | |
| 151 | if self._direct_pcu_enabled(): |
| 152 | args += ('-M',) |
| 153 | |
| 154 | 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] | 155 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 156 | # vim: expandtab tabstop=4 shiftwidth=4 |