Skip to content

Commit

Permalink
[lldp] add new OIDs - lldpRemTable & lldpLocPortTable (sonic-net#70)
Browse files Browse the repository at this point in the history 
* [lldp] add new OIDs - lldpRemTable & lldpLocPortTable
* [lldp] add new OIDs - lldpLocalSystemData
* pr comments - change mock table indent, remove commented out code, imports ordering
* pr comments - avoid updating data too frequently
  • Loading branch information
@mykolaf @qiluo-msft
mykolaf authored and qiluo-msft committed Jul 18, 2018
1 parent bf1b165 commit d49c345
Show file tree
Hide file tree
Showing 5 changed files with 799 additions and 250 deletions.
1 change: 1 addition & 0 deletions src/sonic_ax_impl/main.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ class SonicMIB(
rfc4292.IpCidrRouteTable,
ieee802_1ab.LLDPLocPortTable,
ieee802_1ab.LLDPRemTable,
ieee802_1ab.LLDPLocalSystemData,
dell.force10.SSeriesMIB,
cisco.ciscoPfcExtMIB.cpfcIfTable,
cisco.ciscoPfcExtMIB.cpfcIfPriorityTable,
Expand Down
1 change: 1 addition & 0 deletions src/sonic_ax_impl/mibs/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
COUNTERS_QUEUE_NAME_MAP = b'COUNTERS_QUEUE_NAME_MAP'
LAG_TABLE = b'LAG_TABLE'
LAG_MEMBER_TABLE = b'LAG_MEMBER_TABLE'
LOC_CHASSIS_TABLE = b'LLDP_LOC_CHASSIS'
APPL_DB = 'APPL_DB'
ASIC_DB = 'ASIC_DB'
COUNTERS_DB = 'COUNTERS_DB'
Expand Down
284 changes: 242 additions & 42 deletions src/sonic_ax_impl/mibs/ieee802_1ab.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,197 @@
from bisect import bisect_right

from sonic_ax_impl import mibs, logger
from ax_interface import MIBMeta, SubtreeMIBEntry, MIBUpdater, ValueType
from ax_interface import MIBMeta, SubtreeMIBEntry, MIBEntry, MIBUpdater, ValueType


@unique
class LLDPRemoteTables(int, Enum):
"""
REDIS_KEY_NAME <--> OID_INDEX
"""
lldp_rem_time_mark = 1
# lldp_rem_local_port_num = 2
# lldp_rem_index = 3
lldp_rem_local_port_num = 2
lldp_rem_index = 3
lldp_rem_chassis_id_subtype = 4
lldp_rem_chassis_id = 5
lldp_rem_port_id_subtype = 6
lldp_rem_port_id = 7
lldp_rem_port_desc = 8
lldp_rem_sys_name = 9
lldp_rem_sys_desc = 10
# lldp_rem_sys_cap_supported = 11
# lldp_rem_sys_cap_enabled = 12
lldp_rem_sys_cap_supported = 11
lldp_rem_sys_cap_enabled = 12

@unique
class LLDPLocalChassis(int, Enum):
"""
REDIS_KEY_NAME <--> OID_INDEX
"""
lldp_loc_chassis_id_subtype = 1
lldp_loc_chassis_id = 2
lldp_loc_sys_name = 3
lldp_loc_sys_desc = 4
# *lldp_rem_sys_cap_supported = 5
# *lldp_rem_sys_cap_enabled = 6


class LocPortUpdater(MIBUpdater):

def __init__(self):
super().__init__()

self.db_conn = mibs.init_db()
self.if_name_map = {}
self.if_alias_map = {}
self.if_id_map = {}
self.oid_sai_map = {}
self.oid_name_map = {}
self.if_range = []

# cache of port data
# { if_name -> { 'key': 'value' } }
self.loc_port_data = {}
self.pubsub = None

def reinit_data(self):
"""
Subclass update interface information
"""
self.if_name_map, \
self.if_alias_map, \
self.if_id_map, \
self.oid_sai_map, \
self.oid_name_map = mibs.init_sync_d_interface_tables(self.db_conn)

# establish connection to application database.
self.db_conn.connect(mibs.APPL_DB)
self.if_range = []
# get local port kvs from APP_BD's PORT_TABLE
self.loc_port_data = {}
for if_oid, if_name in self.oid_name_map.items():
self.update_interface_data(if_name)
self.if_range.append((if_oid, ))
self.if_range.sort()
if not self.loc_port_data:
logger.warning("0 - b'PORT_TABLE' is empty. No local port information could be retrieved.")

def update_interface_data(self, if_name):
"""
Update data from the DB for a single interface
"""
loc_port_kvs = self.db_conn.get_all(mibs.APPL_DB, mibs.if_entry_table(bytes(if_name, 'utf-8')))
if not loc_port_kvs:
return
self.loc_port_data.update({if_name: loc_port_kvs})

def get_next(self, sub_id):
"""
:param sub_id: The 1-based sub-identifier query.
:return: the next sub id.
"""
right = bisect_right(self.if_range, sub_id)
if right == len(self.if_range):
return None
return self.if_range[right]

def update_data(self):
"""
Listen to updates in APP DB, update local cache
"""
if not self.pubsub:
redis_client = self.db_conn.get_redis_client(self.db_conn.APPL_DB)
db = self.db_conn.db_map[self.db_conn.APPL_DB]["db"]
self.pubsub = redis_client.pubsub()
self.pubsub.psubscribe("__keyspace@{}__:{}".format(db, "LLDP_ENTRY_TABLE:*"))

while True:
msg = self.pubsub.get_message()

if not msg:
break

lldp_entry = msg["channel"].split(b":")[-1].decode()
data = msg['data'] # event data

# extract interface name
interface = lldp_entry.split('|')[-1]
# get interface from interface name
if_index = port_util.get_index_from_str(interface)

if if_index is None:
# interface name invalid, skip this entry
logger.warning("Invalid interface name in {} in APP_DB, skipping"
.format(lldp_entry))
continue

if b"set" in data:
self.update_interface_data(interface.encode('utf-8'))

def local_port_num(self, sub_id):
if len(sub_id) <= 0:
return None
sub_id = sub_id[0]
if sub_id not in self.oid_name_map:
return None
return int(sub_id)

def local_port_id(self, sub_id):
if len(sub_id) <= 0:
return None
sub_id = sub_id[0]
if sub_id not in self.oid_name_map:
return None
if_name = self.oid_name_map[sub_id]
if if_name not in self.loc_port_data:
# no LLDP data for this interface--we won't report the local interface
return None
return self.if_alias_map[if_name]

def port_table_lookup(self, sub_id, table_name):
if len(sub_id) <= 0:
return None
sub_id = sub_id[0]
if sub_id not in self.oid_name_map:
return None
if_name = self.oid_name_map[sub_id]
if if_name not in self.loc_port_data:
# no data for this interface
return None
counters = self.loc_port_data[if_name]
_table_name = bytes(getattr(table_name, 'name', table_name), 'utf-8')
try:
return counters[_table_name]
except KeyError as e:
logger.warning(" 0 - b'PORT_TABLE' missing attribute '{}'.".format(e))
return None


class LLDPLocalSystemDataUpdater(MIBUpdater):
def __init__(self):
super().__init__()

self.db_conn = mibs.init_db()
self.loc_chassis_data = {}

def reinit_data(self):
"""
Subclass update data routine.
"""
# establish connection to application database.
self.db_conn.connect(mibs.APPL_DB)
self.loc_chassis_data = self.db_conn.get_all(mibs.APPL_DB, mibs.LOC_CHASSIS_TABLE)

def table_lookup(self, table_name):
try:
_table_name = bytes(getattr(table_name, 'name', table_name), 'utf-8')
return self.loc_chassis_data[_table_name]
except KeyError as e:
mibs.logger.warning(" 0 - b'LOC_CHASSIS' missing attribute '{}'.".format(e))
return None

def table_lookup_integer(self, table_name):
subtype_str = self.table_lookup(table_name)
return int(subtype_str) if subtype_str is not None else None


class LLDPUpdater(MIBUpdater):
Expand Down Expand Up @@ -79,17 +251,13 @@ def update_data(self):
self.lldp_counters.update({if_name: lldp_kvs})
self.if_range.sort()

def local_port_id(self, sub_id):
def local_port_num(self, sub_id):
if len(sub_id) <= 0:
return None
sub_id = sub_id[0]
if sub_id not in self.oid_name_map:
return None
if_name = self.oid_name_map[sub_id]
if if_name not in self.lldp_counters:
# no LLDP data for this interface--we won't report the local interface
return None
return self.if_alias_map[if_name]
return int(sub_id)

def lldp_table_lookup(self, sub_id, table_name):
if len(sub_id) <= 0:
Expand Down Expand Up @@ -120,22 +288,56 @@ def lldp_table_lookup_integer(self, sub_id, table_name):


_lldp_updater = LLDPUpdater()
_port_updater = LocPortUpdater()
_chassis_updater = LLDPLocalSystemDataUpdater()


class LLDPLocalSystemData(metaclass=MIBMeta, prefix='.1.0.8802.1.1.2.1.3'):
"""
"""
chassis_updater = _chassis_updater
lldpLocChassisIdSubtype = MIBEntry('1', ValueType.INTEGER, chassis_updater.table_lookup_integer, LLDPLocalChassis(1))

lldpLocChassisId = MIBEntry('2', ValueType.OCTET_STRING, chassis_updater.table_lookup, LLDPLocalChassis(2))

lldpLocSysName = MIBEntry('3', ValueType.OCTET_STRING, chassis_updater.table_lookup, LLDPLocalChassis(3))

lldpLocSysDesc = MIBEntry('4', ValueType.OCTET_STRING, chassis_updater.table_lookup, LLDPLocalChassis(4))


class LLDPLocPortTable(metaclass=MIBMeta, prefix='.1.0.8802.1.1.2.1.3.7'):
"""
'lldpLocPortTable'
lldpLocPortTable OBJECT-TYPE
SYNTAX SEQUENCE OF LldpLocPortEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This table contains one or more rows per port information
associated with the local system known to this agent."
::= { lldpLocalSystemData 7 }
LldpLocPortEntry ::= SEQUENCE {
lldpLocPortNum LldpPortNumber,
lldpLocPortIdSubtype LldpPortIdSubtype,
lldpLocPortId LldpPortId,
lldpLocPortDesc SnmpAdminString
}
"""
lldp_updater = _lldp_updater
port_updater = _port_updater

# lldpLocPortEntry = '1'

# lldpLocPortNum = '1.1'
lldpLocPortNum = SubtreeMIBEntry('1.1', port_updater, ValueType.INTEGER, port_updater.local_port_num)

# lldpLocPortIdSubtype = '1.2'
# We're using interface name as port id, so according to textual convention, the subtype is 5
lldpLocPortIdSubtype = SubtreeMIBEntry('1.2', port_updater, ValueType.INTEGER, lambda _: 5)

lldpLocPortId = SubtreeMIBEntry('1.3', lldp_updater, ValueType.OCTET_STRING, lldp_updater.local_port_id)
lldpLocPortId = SubtreeMIBEntry('1.3', port_updater, ValueType.OCTET_STRING, port_updater.local_port_id)

# lldpLocPortDesc = '1.4'
lldpLocPortDesc = SubtreeMIBEntry('1.4', port_updater, ValueType.OCTET_STRING, port_updater.port_table_lookup,
"description")


class LLDPRemTable(metaclass=MIBMeta, prefix='.1.0.8802.1.1.2.1.4.1'):
Expand Down Expand Up @@ -230,50 +432,48 @@ class LLDPRemTable(metaclass=MIBMeta, prefix='.1.0.8802.1.1.2.1.4.1'):

lldpRemTimeMark = \
SubtreeMIBEntry('1.1', lldp_updater, ValueType.TIME_TICKS, lldp_updater.lldp_table_lookup_integer,
LLDPRemoteTables(1))
LLDPRemoteTables(1))

lldpRemLocalPortNum = \
SubtreeMIBEntry('1.2', lldp_updater, ValueType.INTEGER, lldp_updater.local_port_num)

# TODO: Impl.
# lldpRemLocalPortNum = \
# ContextualMIBEntry('1.2', if_range, ValueType.INTEGER, lldp_updater.lldp_subtype_id,
# LLDPRemoteTables(2))
# TODO: Impl.
# lldpRemIndex = \
# ContextualMIBEntry('1.3', if_range, ValueType.INTEGER, lldp_updater.lldp_subtype_id,
# LLDPRemoteTables(3))
lldpRemIndex = \
SubtreeMIBEntry('1.3', lldp_updater, ValueType.INTEGER, lldp_updater.lldp_table_lookup_integer,
LLDPRemoteTables(3))

lldpRemChassisIdSubtype = \
SubtreeMIBEntry('1.4', lldp_updater, ValueType.INTEGER, lldp_updater.lldp_table_lookup_integer,
LLDPRemoteTables(4))
LLDPRemoteTables(4))

lldpRemChassisId = \
SubtreeMIBEntry('1.5', lldp_updater, ValueType.OCTET_STRING, lldp_updater.lldp_table_lookup,
LLDPRemoteTables(5))
LLDPRemoteTables(5))

lldpRemPortIdSubtype = \
SubtreeMIBEntry('1.6', lldp_updater, ValueType.INTEGER, lldp_updater.lldp_table_lookup_integer,
LLDPRemoteTables(6))
LLDPRemoteTables(6))

lldpRemPortId = \
SubtreeMIBEntry('1.7', lldp_updater, ValueType.OCTET_STRING, lldp_updater.lldp_table_lookup,
LLDPRemoteTables(7))
LLDPRemoteTables(7))

lldpRemPortDesc = \
SubtreeMIBEntry('1.8', lldp_updater, ValueType.OCTET_STRING, lldp_updater.lldp_table_lookup,
LLDPRemoteTables(8))
LLDPRemoteTables(8))

lldpRemSysName = \
SubtreeMIBEntry('1.9', lldp_updater, ValueType.OCTET_STRING, lldp_updater.lldp_table_lookup,
LLDPRemoteTables(9))
LLDPRemoteTables(9))

lldpRemSysDesc = \
SubtreeMIBEntry('1.10', lldp_updater, ValueType.OCTET_STRING, lldp_updater.lldp_table_lookup,
LLDPRemoteTables(10))

# TODO: Impl.
# lldpRemSysCapSupported = \
# ContextualMIBEntry('1.11', if_range, ValueType.INTEGER, lldp_updater.lldp_subtype_id,
# LLDPRemoteTables(11))
# TODO: Impl.
# lldpRemSysCapEnabled = \
# ContextualMIBEntry('1.12', if_range, ValueType.INTEGER, lldp_updater.lldp_subtype_id,
# LLDPRemoteTables(12))
LLDPRemoteTables(10))

lldpRemSysCapSupported = \
SubtreeMIBEntry('1.11', lldp_updater, ValueType.OCTET_STRING, lldp_updater.lldp_table_lookup,
LLDPRemoteTables(11))

lldpRemSysCapEnabled = \
SubtreeMIBEntry('1.12', lldp_updater, ValueType.OCTET_STRING, lldp_updater.lldp_table_lookup,
LLDPRemoteTables(12))

Loading

0 comments on commit d49c345

Please sign in to comment.