Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 1 | # osmo_gsm_tester: specifics for running an SRS EPC 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 | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 24 | from ..core import schema |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 25 | from . import epc |
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 | def on_register_schemas(): |
| 28 | config_schema = { |
| 29 | 'enable_pcap': schema.BOOL_STR, |
Andre Puschmann | 82ced3f | 2020-06-18 14:52:39 +0200 | [diff] [blame] | 30 | 'log_all_level': schema.STR, |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 31 | } |
| 32 | schema.register_config_schema('epc', config_schema) |
| 33 | |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 34 | class srsEPC(epc.EPC): |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 35 | |
| 36 | REMOTE_DIR = '/osmo-gsm-tester-srsepc' |
| 37 | BINFILE = 'srsepc' |
| 38 | CFGFILE = 'srsepc.conf' |
| 39 | DBFILE = 'srsepc_user_db.csv' |
| 40 | PCAPFILE = 'srsepc.pcap' |
| 41 | LOGFILE = 'srsepc.log' |
| 42 | |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 43 | def __init__(self, testenv, run_node): |
| 44 | super().__init__(testenv, run_node, 'srsepc') |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 45 | self.run_dir = None |
| 46 | self.config_file = None |
| 47 | self.db_file = None |
| 48 | self.log_file = None |
| 49 | self.pcap_file = None |
| 50 | self.process = None |
| 51 | self.rem_host = None |
Pau Espin Pedrol | 3373703 | 2020-04-16 13:55:57 +0200 | [diff] [blame] | 52 | self.remote_inst = None |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 53 | self.remote_config_file = None |
| 54 | self.remote_db_file = None |
| 55 | self.remote_log_file = None |
| 56 | self.remote_pcap_file = None |
Pau Espin Pedrol | 1e81b5a | 2020-03-16 12:42:17 +0100 | [diff] [blame] | 57 | self.enable_pcap = False |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 58 | self.subscriber_list = [] |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 59 | |
| 60 | def cleanup(self): |
| 61 | if self.process is None: |
| 62 | return |
| 63 | if self._run_node.is_local(): |
| 64 | return |
| 65 | # copy back files (may not exist, for instance if there was an early error of process): |
| 66 | try: |
| 67 | self.rem_host.scpfrom('scp-back-log', self.remote_log_file, self.log_file) |
| 68 | except Exception as e: |
| 69 | self.log(repr(e)) |
Pau Espin Pedrol | 1e81b5a | 2020-03-16 12:42:17 +0100 | [diff] [blame] | 70 | if self.enable_pcap: |
| 71 | try: |
| 72 | self.rem_host.scpfrom('scp-back-pcap', self.remote_pcap_file, self.pcap_file) |
| 73 | except Exception as e: |
| 74 | self.log(repr(e)) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 75 | |
| 76 | def start(self): |
| 77 | self.log('Starting srsepc') |
Pau Espin Pedrol | 2a2d846 | 2020-05-11 10:56:52 +0200 | [diff] [blame] | 78 | self.run_dir = util.Dir(self.testenv.test().get_run_dir().new_dir(self.name())) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 79 | self.configure() |
| 80 | if self._run_node.is_local(): |
| 81 | self.start_locally() |
| 82 | else: |
| 83 | self.start_remotely() |
| 84 | |
| 85 | def start_remotely(self): |
Pau Espin Pedrol | 3373703 | 2020-04-16 13:55:57 +0200 | [diff] [blame] | 86 | remote_lib = self.remote_inst.child('lib') |
| 87 | remote_binary = self.remote_inst.child('bin', srsEPC.BINFILE) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 88 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 89 | # setting capabilities will later disable use of LD_LIBRARY_PATH from ELF loader -> modify RPATH instead. |
| 90 | self.log('Setting RPATH for srsepc') |
| 91 | self.rem_host.change_elf_rpath(remote_binary, remote_lib) |
| 92 | # srsepc requires CAP_NET_ADMIN to create tunnel devices: ioctl(TUNSETIFF): |
| 93 | self.log('Applying CAP_NET_ADMIN capability to srsepc') |
| 94 | self.rem_host.setcap_net_admin(remote_binary) |
| 95 | |
Pau Espin Pedrol | 3373703 | 2020-04-16 13:55:57 +0200 | [diff] [blame] | 96 | args = (remote_binary, self.remote_config_file) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 97 | |
| 98 | self.process = self.rem_host.RemoteProcess(srsEPC.BINFILE, args) |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 99 | self.testenv.remember_to_stop(self.process) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 100 | self.process.launch() |
| 101 | |
| 102 | def start_locally(self): |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 103 | binary = inst.child('bin', BINFILE) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 104 | lib = inst.child('lib') |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 105 | env = {} |
Pau Espin Pedrol | 3373703 | 2020-04-16 13:55:57 +0200 | [diff] [blame] | 106 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 107 | # setting capabilities will later disable use of LD_LIBRARY_PATH from ELF loader -> modify RPATH instead. |
| 108 | self.log('Setting RPATH for srsepc') |
| 109 | # srsepc binary needs patchelf <= 0.9 (0.10 and current master fail) to avoid failing during patch. OS#4389, patchelf-GH#192. |
| 110 | util.change_elf_rpath(binary, util.prepend_library_path(lib), self.run_dir.new_dir('patchelf')) |
| 111 | # srsepc requires CAP_NET_ADMIN to create tunnel devices: ioctl(TUNSETIFF): |
| 112 | self.log('Applying CAP_NET_ADMIN capability to srsepc') |
| 113 | util.setcap_net_admin(binary, self.run_dir.new_dir('setcap_net_admin')) |
| 114 | |
Pau Espin Pedrol | 3373703 | 2020-04-16 13:55:57 +0200 | [diff] [blame] | 115 | args = (binary, os.path.abspath(self.config_file)) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 116 | |
| 117 | self.process = process.Process(self.name(), self.run_dir, args, env=env) |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 118 | self.testenv.remember_to_stop(self.process) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 119 | self.process.launch() |
| 120 | |
| 121 | def configure(self): |
Pau Espin Pedrol | e921995 | 2020-05-25 20:04:52 +0200 | [diff] [blame] | 122 | self.inst = util.Dir(os.path.abspath(self.testenv.suite().trial().get_inst('srslte', self._run_node.run_label()))) |
Pau Espin Pedrol | 3373703 | 2020-04-16 13:55:57 +0200 | [diff] [blame] | 123 | if not os.path.isdir(self.inst.child('lib')): |
| 124 | raise log.Error('No lib/ in', self.inst) |
| 125 | if not self.inst.isfile('bin', srsEPC.BINFILE): |
| 126 | raise log.Error('No %s binary in' % srsEPC.BINFILE, self.inst) |
| 127 | |
Pau Espin Pedrol | 1e81b5a | 2020-03-16 12:42:17 +0100 | [diff] [blame] | 128 | self.config_file = self.run_dir.child(srsEPC.CFGFILE) |
| 129 | self.db_file = self.run_dir.child(srsEPC.DBFILE) |
| 130 | self.log_file = self.run_dir.child(srsEPC.LOGFILE) |
| 131 | self.pcap_file = self.run_dir.child(srsEPC.PCAPFILE) |
Pau Espin Pedrol | 3373703 | 2020-04-16 13:55:57 +0200 | [diff] [blame] | 132 | |
| 133 | if not self._run_node.is_local(): |
| 134 | self.rem_host = remote.RemoteHost(self.run_dir, self._run_node.ssh_user(), self._run_node.ssh_addr()) |
| 135 | remote_prefix_dir = util.Dir(srsEPC.REMOTE_DIR) |
| 136 | self.remote_inst = util.Dir(remote_prefix_dir.child(os.path.basename(str(self.inst)))) |
| 137 | remote_run_dir = util.Dir(remote_prefix_dir.child(srsEPC.BINFILE)) |
| 138 | |
| 139 | self.remote_config_file = remote_run_dir.child(srsEPC.CFGFILE) |
| 140 | self.remote_db_file = remote_run_dir.child(srsEPC.DBFILE) |
| 141 | self.remote_log_file = remote_run_dir.child(srsEPC.LOGFILE) |
| 142 | self.remote_pcap_file = remote_run_dir.child(srsEPC.PCAPFILE) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 143 | |
Pau Espin Pedrol | c04528c | 2020-04-01 13:55:51 +0200 | [diff] [blame] | 144 | values = super().configure(['srsepc']) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 145 | |
Pau Espin Pedrol | 3373703 | 2020-04-16 13:55:57 +0200 | [diff] [blame] | 146 | dbfile = self.db_file if self._run_node.is_local() else self.remote_db_file |
| 147 | logfile = self.log_file if self._run_node.is_local() else self.remote_log_file |
| 148 | pcapfile = self.pcap_file if self._run_node.is_local() else self.remote_pcap_file |
| 149 | config.overlay(values, dict(epc=dict(db_filename=dbfile, |
| 150 | log_filename=logfile, |
| 151 | pcap_filename=pcapfile))) |
| 152 | |
Pau Espin Pedrol | 1e81b5a | 2020-03-16 12:42:17 +0100 | [diff] [blame] | 153 | # Convert parsed boolean string to Python boolean: |
| 154 | self.enable_pcap = util.str2bool(values['epc'].get('enable_pcap', 'false')) |
| 155 | config.overlay(values, dict(epc={'enable_pcap': self.enable_pcap})) |
| 156 | |
Pau Espin Pedrol | b693771 | 2020-02-27 18:02:20 +0100 | [diff] [blame] | 157 | # Set qci for each subscriber: |
Pau Espin Pedrol | 04ad3b5 | 2020-04-06 12:25:22 +0200 | [diff] [blame] | 158 | qci = values['epc'].get('qci', None) |
| 159 | assert qci is not None |
Pau Espin Pedrol | b693771 | 2020-02-27 18:02:20 +0100 | [diff] [blame] | 160 | for i in range(len(self.subscriber_list)): |
Pau Espin Pedrol | 04ad3b5 | 2020-04-06 12:25:22 +0200 | [diff] [blame] | 161 | self.subscriber_list[i]['qci'] = qci |
Pau Espin Pedrol | b693771 | 2020-02-27 18:02:20 +0100 | [diff] [blame] | 162 | config.overlay(values, dict(epc=dict(hss=dict(subscribers=self.subscriber_list)))) |
| 163 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 164 | self.dbg('SRSEPC CONFIG:\n' + pprint.pformat(values)) |
| 165 | |
| 166 | with open(self.config_file, 'w') as f: |
| 167 | r = template.render(srsEPC.CFGFILE, values) |
| 168 | self.dbg(r) |
| 169 | f.write(r) |
| 170 | with open(self.db_file, 'w') as f: |
| 171 | r = template.render(srsEPC.DBFILE, values) |
| 172 | self.dbg(r) |
| 173 | f.write(r) |
| 174 | |
Pau Espin Pedrol | 3373703 | 2020-04-16 13:55:57 +0200 | [diff] [blame] | 175 | if not self._run_node.is_local(): |
| 176 | self.rem_host.recreate_remote_dir(self.remote_inst) |
| 177 | self.rem_host.scp('scp-inst-to-remote', str(self.inst), remote_prefix_dir) |
| 178 | self.rem_host.recreate_remote_dir(remote_run_dir) |
| 179 | self.rem_host.scp('scp-cfg-to-remote', self.config_file, self.remote_config_file) |
| 180 | self.rem_host.scp('scp-db-to-remote', self.db_file, self.remote_db_file) |
| 181 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 182 | def subscriber_add(self, modem, msisdn=None, algo_str=None): |
| 183 | if msisdn is None: |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 184 | msisdn = self.testenv.msisdn() |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 185 | modem.set_msisdn(msisdn) |
| 186 | |
| 187 | if algo_str is None: |
| 188 | algo_str = modem.auth_algo() or util.OSMO_AUTH_ALGO_NONE |
| 189 | |
| 190 | if algo_str != util.OSMO_AUTH_ALGO_NONE and not modem.ki(): |
| 191 | raise log.Error("Auth algo %r selected but no KI specified" % algo_str) |
| 192 | |
Pau Espin Pedrol | 0f7f265 | 2020-07-13 12:01:10 +0200 | [diff] [blame] | 193 | if algo_str == 'milenage': |
| 194 | if not modem.opc(): |
| 195 | raise log.Error("Auth algo milenage selected but no OPC specified") |
| 196 | # srsepc's used_db uses token 'mil' for milenage: |
| 197 | algo_str = 'mil' |
| 198 | |
| 199 | opc = (modem.opc() or '') |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 200 | subscriber_id = len(self.subscriber_list) # list index |
Pau Espin Pedrol | 0f7f265 | 2020-07-13 12:01:10 +0200 | [diff] [blame] | 201 | self.subscriber_list.append({'id': subscriber_id, 'imsi': modem.imsi(), 'msisdn': msisdn, 'auth_algo': algo_str, 'ki': modem.ki(), 'opc': opc, 'apn_ipaddr': modem.apn_ipaddr()}) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 202 | |
| 203 | self.log('Add subscriber', msisdn=msisdn, imsi=modem.imsi(), subscriber_id=subscriber_id, |
| 204 | algo_str=algo_str) |
| 205 | return subscriber_id |
| 206 | |
| 207 | def enb_is_connected(self, enb): |
Pau Espin Pedrol | 491f77c | 2020-04-20 14:20:43 +0200 | [diff] [blame] | 208 | # Match against sample line: "S1 Setup Request - eNB Name: srsenb01, eNB id: 0x19" |
| 209 | stdout_lines = (self.process.get_stdout() or '').splitlines() |
| 210 | for l in stdout_lines: |
| 211 | if l.startswith('S1 Setup Request') and l.endswith('eNB id: %s' % hex(enb.id()).lower()): |
| 212 | return True |
| 213 | return False |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 214 | |
| 215 | def running(self): |
| 216 | return not self.process.terminated() |
| 217 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 218 | def tun_addr(self): |
| 219 | return '172.16.0.1' |
| 220 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 221 | # vim: expandtab tabstop=4 shiftwidth=4 |