sonic-buildimage/platform/mellanox/mlnx-platform-api/sonic_platform/module.py
Junchao-Mellanox e8b4c2a1f4
[Mellanox] Refactor Mellanox platform API to support dynamic port configuration (#8422)
- Why I did it
* To support systems with dynamic port configuration
* Apply lazy initialization to faster the speed of loading platform API

- How I did it
* Add module.py to implement dynamic port configuration (aka line card model)
* Adjust chassis.py, platform.py, thermal.py, sfp.py to support dynamic port configuration
* Optimize existing code

- How to verify it
Platform regression on MSN4700, MSN3800 and MSN2700, 100% pass
Unit test covers all new changes.
2021-10-25 07:59:06 +03:00

250 lines
8.3 KiB
Python

#
# Copyright (c) 2021 NVIDIA CORPORATION & AFFILIATES.
# Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
import redis
import threading
from sonic_platform_base.module_base import ModuleBase
from sonic_py_common.logger import Logger
from . import utils
from .device_data import DeviceDataManager
from .vpd_parser import VpdParser
# Global logger class instance
logger = Logger()
class Module(ModuleBase):
STATE_ACTIVATED = 1
STATE_DEACTIVATED = 0
STATE_DB = 6
STATE_MODULAR_CHASSIS_SLOT_TABLE = 'MODULAR_CHASSIS_SLOT|{}'
FIELD_SEQ_NO = 'seq_no'
redis_client = redis.Redis(db = STATE_DB)
def __init__(self, slot_id):
super(Module, self).__init__()
self.slot_id = slot_id
self.seq_no = 0
self.current_state = Module.STATE_DEACTIVATED
self.lock = threading.Lock()
self.sfp_initialized_count = 0
self.sfp_count = 0
self.vpd_parser = VpdParser('/run/hw-management/lc{}/eeprom/vpd_parsed')
def get_name(self):
return 'LINE-CARD{}'.format(self.slot_id)
def get_model(self):
"""
Retrieves the model number (or part number) of the device
Returns:
string: Model/part number of device
"""
return self.vpd_parser.get_model()
def get_serial(self):
"""
Retrieves the serial number of the device
Returns:
string: Serial number of device
"""
return self.vpd_parser.get_serial()
def get_revision(self):
"""
Retrieves the hardware revision of the device
Returns:
string: Revision value of device
"""
return self.vpd_parser.get_revision()
def get_type(self):
return ModuleBase.MODULE_TYPE_LINE
def get_slot(self):
return self.slot_id
def get_presence(self):
return utils.read_int_from_file('/run/hw-management/system/lc{}_present'.format(self.slot_id)) == 1
def get_position_in_parent(self):
return self.slot_id
def is_replaceable(self):
return True
def get_oper_status(self): # TODO: read from DB?
if utils.read_int_from_file('/run/hw-management/system/lc{}_active'.format(self.slot_id)) == 1:
return ModuleBase.MODULE_STATUS_ONLINE
elif utils.read_int_from_file('/run/hw-management/system/lc{}_present'.format(self.slot_id)) == 1:
return ModuleBase.MODULE_STATUS_PRESENT
elif utils.read_int_from_file('/run/hw-management/system/lc{}_present'.format(self.slot_id)) == 0:
return ModuleBase.MODULE_STATUS_EMPTY
else:
return ModuleBase.MODULE_STATUS_FAULT
def _check_state(self):
"""Check Module status change:
1. If status sysfs file value has been changed TODO: read from DB?
2. If sequence NO has been changed which means line card has been removed and inserted again.
"""
seq_no = self._get_seq_no()
state = utils.read_int_from_file('/run/hw-management/system/lc{}_powered'.format(self.slot_id), log_func=None)
if state != self.current_state:
self._re_init()
elif seq_no != self.seq_no:
if state == Module.STATE_ACTIVATED: # LC has been replaced, need re-initialize
self._re_init()
self.current_state = state
self.seq_no = seq_no
def _get_seq_no(self):
try:
seq_no = Module.redis_client.hget(Module.STATE_MODULAR_CHASSIS_SLOT_TABLE.format(self.slot_id), Module.FIELD_SEQ_NO)
seq_no = seq_no.decode().strip()
except Exception as e:
seq_no = 0
return seq_no
def _re_init(self):
self._thermal_list = []
self._sfp_list = []
self._sfp_count = 0
##############################################
# THERMAL methods
##############################################
def initialize_thermals(self):
self._check_state()
if self.current_state == Module.STATE_ACTIVATED and not self._thermal_list:
from .thermal import initialize_linecard_thermals
self._thermal_list = initialize_linecard_thermals(self.get_name(), self.slot_id) # TODO: add presence_cb?
def get_num_thermals(self):
"""
Retrieves the number of thermals available on this module
Returns:
An integer, the number of thermals available on this module
"""
return DeviceDataManager.get_gearbox_count('/run/hw-management/lc{}/config'.format(self.slot_id))
def get_all_thermals(self):
"""
Retrieves all thermals available on this module
Returns:
A list of objects derived from ThermalBase representing all thermals
available on this module
"""
with self.lock:
self.initialize_thermals()
return self._thermal_list
def get_thermal(self, index):
"""
Retrieves thermal unit represented by (0-based) index <index>
Args:
index: An integer, the index (0-based) of the thermal to
retrieve
Returns:
An object dervied from ThermalBase representing the specified thermal
"""
with self.lock:
self.initialize_thermals()
return super(Module, self).get_thermal(index)
##############################################
# SFP methods
##############################################
def _create_sfp_object(self, index):
from .sfp import SFP
return SFP(index, slot_id=self.slot_id, linecard_port_count=self.sfp_count, lc_name=self.get_name())
def initialize_single_sfp(self, index):
self._check_state()
if self.current_state == Module.STATE_ACTIVATED:
sfp_count = self.get_num_sfps()
if index < sfp_count:
if not self._sfp_list:
self._sfp_list = [None] * sfp_count
if not self._sfp_list[index]:
self._sfp_list[index] = self._create_sfp_object(index)
self.sfp_initialized_count += 1
def initialize_sfps(self):
self._check_state()
if self.current_state == Module.STATE_ACTIVATED:
if not self._sfp_list:
sfp_count = self.get_num_sfps()
for index in range(sfp_count):
self._sfp_list.append(self._create_sfp_object(index))
self.sfp_initialized_count = sfp_count
elif self.sfp_initialized_count != len(self._sfp_list):
for index in range(len(self._sfp_list)):
if self._sfp_list[index] is None:
self._sfp_list[index] = self._create_sfp_object(index)
self.sfp_initialized_count = len(self._sfp_list)
def get_num_sfps(self):
"""
Retrieves the number of sfps available on this module
Returns:
An integer, the number of sfps available on this module
"""
if self.sfp_count == 0:
self.sfp_count = DeviceDataManager.get_linecard_sfp_count(self.slot_id)
return self.sfp_count
def get_all_sfps(self):
"""
Retrieves all sfps available on this module
Returns:
A list of objects derived from PsuBase representing all sfps
available on this module
"""
with self.lock:
self.initialize_sfps()
return self._sfp_list
def get_sfp(self, index):
"""
Retrieves sfp represented by (0-based) index <index>
Args:
index: An integer, the index (0-based) of the sfp to retrieve
Returns:
An object dervied from SfpBase representing the specified sfp
"""
with self.lock:
self.initialize_single_sfp(index)
return super(Module, self).get_sfp(index)