Pau Espin Pedrol | 52ad3a6 | 2018-03-08 17:50:14 +0100 | [diff] [blame] | 1 | # osmo_gsm_tester: base classes to share code among BTS subclasses. |
| 2 | # |
| 3 | # Copyright (C) 2018 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 | |
Pau Espin Pedrol | 698ad4c | 2018-07-27 16:15:59 +0200 | [diff] [blame] | 20 | import copy |
Pau Espin Pedrol | 52ad3a6 | 2018-03-08 17:50:14 +0100 | [diff] [blame] | 21 | from abc import ABCMeta, abstractmethod |
Holger Hans Peter Freyther | d03acdf | 2018-09-23 18:06:48 +0100 | [diff] [blame] | 22 | from . import log, config, schema |
Pau Espin Pedrol | 52ad3a6 | 2018-03-08 17:50:14 +0100 | [diff] [blame] | 23 | |
| 24 | class Bts(log.Origin, metaclass=ABCMeta): |
Pau Espin Pedrol | 52ad3a6 | 2018-03-08 17:50:14 +0100 | [diff] [blame] | 25 | |
| 26 | ############## |
| 27 | # PROTECTED |
| 28 | ############## |
Pau Espin Pedrol | e519462 | 2018-05-07 13:36:58 +0200 | [diff] [blame] | 29 | def __init__(self, suite_run, conf, name, defaults_cfg_name): |
Pau Espin Pedrol | 52ad3a6 | 2018-03-08 17:50:14 +0100 | [diff] [blame] | 30 | super().__init__(log.C_RUN, name) |
Pau Espin Pedrol | 5860367 | 2018-08-09 13:45:55 +0200 | [diff] [blame] | 31 | self.bsc = None |
| 32 | self.sgsn = None |
| 33 | self.lac = None |
| 34 | self.rac = None |
| 35 | self.cellid = None |
| 36 | self.bvci = None |
| 37 | self._num_trx = 1 |
| 38 | self._max_trx = None |
| 39 | self.overlay_trx_list = [] |
Pau Espin Pedrol | 52ad3a6 | 2018-03-08 17:50:14 +0100 | [diff] [blame] | 40 | self.suite_run = suite_run |
| 41 | self.conf = conf |
Pau Espin Pedrol | e519462 | 2018-05-07 13:36:58 +0200 | [diff] [blame] | 42 | self.defaults_cfg_name = defaults_cfg_name |
Pau Espin Pedrol | 39df7f4 | 2018-05-07 13:49:33 +0200 | [diff] [blame] | 43 | self._init_num_trx() |
| 44 | |
| 45 | def _resolve_bts_cfg(self, cfg_name): |
| 46 | res = None |
| 47 | val = config.get_defaults('bsc_bts').get(cfg_name) |
| 48 | if val is not None: |
| 49 | res = val |
| 50 | val = config.get_defaults(self.defaults_cfg_name).get(cfg_name) |
| 51 | if val is not None: |
| 52 | res = val |
| 53 | val = self.conf.get(cfg_name) |
| 54 | if val is not None: |
| 55 | res = val |
| 56 | return res |
| 57 | |
| 58 | def _init_num_trx(self): |
| 59 | self._num_trx = 1 |
| 60 | self._max_trx = None |
| 61 | val = self._resolve_bts_cfg('num_trx') |
| 62 | if val is not None: |
| 63 | self._num_trx = int(val) |
| 64 | val = self._resolve_bts_cfg('max_trx') |
| 65 | if val is not None: |
| 66 | self._max_trx = int(val) |
| 67 | self._validate_new_num_trx(self._num_trx) |
| 68 | self.overlay_trx_list = [Bts._new_default_trx_cfg() for trx in range(self._num_trx)] |
| 69 | |
| 70 | def _validate_new_num_trx(self, num_trx): |
| 71 | if self._max_trx is not None and num_trx > self._max_trx: |
| 72 | raise log.Error('Amount of TRX requested is too high for maximum allowed: %u > %u' %(num_trx, self._max_trx)) |
| 73 | |
| 74 | @staticmethod |
| 75 | def _new_default_trx_cfg(): |
| 76 | return {'timeslot_list':[{} for ts in range(8)]} |
| 77 | |
| 78 | @staticmethod |
| 79 | def _trx_list_recreate(trx_list, new_size): |
| 80 | curr_len = len(trx_list) |
| 81 | if new_size < curr_len: |
| 82 | trx_list = trx_list[0:new_size] |
| 83 | elif new_size > curr_len: |
| 84 | for i in range(new_size - curr_len): |
| 85 | trx_list.append(Bts._new_default_trx_cfg()) |
| 86 | return trx_list |
Pau Espin Pedrol | e699912 | 2018-05-08 14:38:24 +0200 | [diff] [blame] | 87 | |
| 88 | def conf_for_bsc_prepare(self): |
| 89 | values = config.get_defaults('bsc_bts') |
Pau Espin Pedrol | 39df7f4 | 2018-05-07 13:49:33 +0200 | [diff] [blame] | 90 | # Make sure the trx_list is adapted to num of trx configured at runtime |
| 91 | # to avoid overlay issues. |
| 92 | trx_list = values.get('trx_list') |
| 93 | if trx_list and len(trx_list) != self.num_trx(): |
| 94 | values['trx_list'] = Bts._trx_list_recreate(trx_list, self.num_trx()) |
| 95 | |
| 96 | bts_defaults = config.get_defaults(self.defaults_cfg_name) |
| 97 | trx_list = bts_defaults.get('trx_list') |
| 98 | if trx_list and len(trx_list) != self.num_trx(): |
| 99 | bts_defaults['trx_list'] = Bts._trx_list_recreate(trx_list, self.num_trx()) |
| 100 | |
| 101 | config.overlay(values, bts_defaults) |
Pau Espin Pedrol | e699912 | 2018-05-08 14:38:24 +0200 | [diff] [blame] | 102 | if self.lac is not None: |
| 103 | config.overlay(values, { 'location_area_code': self.lac }) |
| 104 | if self.rac is not None: |
| 105 | config.overlay(values, { 'routing_area_code': self.rac }) |
| 106 | if self.cellid is not None: |
| 107 | config.overlay(values, { 'cell_identity': self.cellid }) |
| 108 | if self.bvci is not None: |
| 109 | config.overlay(values, { 'bvci': self.bvci }) |
Pau Espin Pedrol | 698ad4c | 2018-07-27 16:15:59 +0200 | [diff] [blame] | 110 | |
| 111 | conf = copy.deepcopy(self.conf) |
| 112 | trx_list = conf.get('trx_list') |
| 113 | if trx_list and len(trx_list) != self.num_trx(): |
| 114 | conf['trx_list'] = Bts._trx_list_recreate(trx_list, self.num_trx()) |
| 115 | config.overlay(values, conf) |
Pau Espin Pedrol | e699912 | 2018-05-08 14:38:24 +0200 | [diff] [blame] | 116 | |
| 117 | sgsn_conf = {} if self.sgsn is None else self.sgsn.conf_for_client() |
| 118 | config.overlay(values, sgsn_conf) |
Pau Espin Pedrol | 39df7f4 | 2018-05-07 13:49:33 +0200 | [diff] [blame] | 119 | |
| 120 | config.overlay(values, { 'trx_list': self.overlay_trx_list }) |
Pau Espin Pedrol | e699912 | 2018-05-08 14:38:24 +0200 | [diff] [blame] | 121 | return values |
| 122 | |
Pau Espin Pedrol | 52ad3a6 | 2018-03-08 17:50:14 +0100 | [diff] [blame] | 123 | ######################## |
| 124 | # PUBLIC - INTERNAL API |
| 125 | ######################## |
| 126 | @abstractmethod |
| 127 | def conf_for_bsc(self): |
| 128 | 'Used by bsc objects to get path to socket.' |
| 129 | pass |
| 130 | |
| 131 | def remote_addr(self): |
| 132 | return self.conf.get('addr') |
| 133 | |
| 134 | def cleanup(self): |
| 135 | 'Nothing to do by default. Subclass can override if required.' |
| 136 | pass |
| 137 | |
| 138 | ################### |
| 139 | # PUBLIC (test API included) |
| 140 | ################### |
| 141 | @abstractmethod |
Pau Espin Pedrol | b1526b9 | 2018-05-22 20:32:30 +0200 | [diff] [blame] | 142 | def start(self, keepalive=False): |
| 143 | '''Starts BTS. If keepalive is set, it will expect internal issues and |
| 144 | respawn related processes when detected''' |
Pau Espin Pedrol | 52ad3a6 | 2018-03-08 17:50:14 +0100 | [diff] [blame] | 145 | pass |
| 146 | |
| 147 | @abstractmethod |
| 148 | def ready_for_pcu(self): |
| 149 | 'True if the BTS is prepared to have a PCU connected, false otherwise' |
| 150 | pass |
| 151 | |
| 152 | @abstractmethod |
| 153 | def pcu(self): |
| 154 | 'Get the Pcu object associated with the BTS' |
| 155 | pass |
| 156 | |
Pau Espin Pedrol | f616614 | 2018-10-11 17:49:34 +0200 | [diff] [blame] | 157 | def bts_type(self): |
| 158 | 'Get the type of BTS' |
| 159 | return self.conf.get('type') |
| 160 | |
Pau Espin Pedrol | 52ad3a6 | 2018-03-08 17:50:14 +0100 | [diff] [blame] | 161 | def set_bsc(self, bsc): |
| 162 | self.bsc = bsc |
| 163 | |
| 164 | def set_sgsn(self, sgsn): |
| 165 | self.sgsn = sgsn |
| 166 | |
| 167 | def set_lac(self, lac): |
| 168 | self.lac = lac |
| 169 | |
| 170 | def set_rac(self, rac): |
| 171 | self.rac = rac |
| 172 | |
| 173 | def set_cellid(self, cellid): |
| 174 | self.cellid = cellid |
| 175 | |
| 176 | def set_bvci(self, bvci): |
| 177 | self.bvci = bvci |
| 178 | |
Pau Espin Pedrol | 39df7f4 | 2018-05-07 13:49:33 +0200 | [diff] [blame] | 179 | def set_num_trx(self, num_trx): |
| 180 | assert num_trx > 0 |
| 181 | self._validate_new_num_trx(num_trx) |
| 182 | if num_trx == self._num_trx: |
| 183 | return |
| 184 | self._num_trx = num_trx |
| 185 | self.overlay_trx_list = Bts._trx_list_recreate(self.overlay_trx_list, num_trx) |
| 186 | |
| 187 | def num_trx(self): |
| 188 | return self._num_trx |
| 189 | |
| 190 | def set_trx_phy_channel(self, trx_idx, ts_idx, config): |
| 191 | assert trx_idx < self._num_trx |
| 192 | assert ts_idx < 8 |
| 193 | schema.phy_channel_config(config) # validation |
| 194 | self.overlay_trx_list[trx_idx]['timeslot_list'][ts_idx]['phys_chan_config'] = config |
| 195 | |
Pau Espin Pedrol | 52ad3a6 | 2018-03-08 17:50:14 +0100 | [diff] [blame] | 196 | # vim: expandtab tabstop=4 shiftwidth=4 |