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