Skip to content

Fix swsscommon psubscribe code break in frrcfgd #13836

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 1, 2023
Merged

Fix swsscommon psubscribe code break in frrcfgd #13836

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1e74d40
Fix swsscvommon psub break in frrcfgd
liuh-80 Feb 16, 2023
3c53ecf
Fix build issue
liuh-80 Feb 17, 2023
c7944a5
Fix code bug
liuh-80 Feb 21, 2023
64faf8c
Fix PR comments
liuh-80 Feb 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions src/sonic-frr-mgmt-framework/frrcfgd/frrcfgd.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1445,6 +1445,7 @@ class ExtConfigDBConnector(ConfigDBConnector):
def __init__(self, ns_attrs = None):
super(ExtConfigDBConnector, self).__init__()
self.nosort_attrs = ns_attrs if ns_attrs is not None else {}
self.__listen_thread_running = False
def raw_to_typed(self, raw_data, table = ''):
if len(raw_data) == 0:
raw_data = None
Expand All @@ -1469,12 +1470,28 @@ def sub_msg_handler(self, msg_item):
except Exception as e:
syslog.syslog(syslog.LOG_ERR, '[bgp cfgd] Failed handling config DB update with exception:' + str(e))
logging.exception(e)

def listen_thread(self, timeout):
self.__listen_thread_running = True
sub_key_space = "__keyspace@{}__:*".format(self.get_dbid(self.db_name))
self.pubsub.psubscribe(sub_key_space)
while self.__listen_thread_running:
msg = self.pubsub.get_message(timeout, True)
if msg:
self.sub_msg_handler(msg)

self.pubsub.punsubscribe(sub_key_space)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

punsubscribe

Found similar code in https://github.com/sonic-net/sonic-swss-common/blob/85f3776ae6da44a083c617ff4ce6e54e1e2d5dac/common/configdb.h#L78. Do we also need punsubscribe there?

Copy link
Contributor Author

@liuh-80 liuh-80 Feb 23, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After investigation the code of ConfigDBConnector, we don't need punsubscribe there because inside the listen() there is a infinity loop. as my understand the design is listen() will stop when process exit, so not necessary to unsub.


def listen(self):
"""Start listen Redis keyspace events and will trigger corresponding handlers when content of a table changes.
"""
self.pubsub = self.get_redis_client(self.db_name).pubsub()
self.pubsub.psubscribe(**{"__keyspace@{}__:*".format(self.get_dbid(self.db_name)): self.sub_msg_handler})
self.sub_thread = self.pubsub.run_in_thread(sleep_time = 0.01)
self.sub_thread = threading.Thread(target=self.listen_thread, args=(0.01,))
self.sub_thread.start()

def stop_listen(self):
self.__listen_thread_running = False

@staticmethod
def get_table_key(table, key):
return table + '&&' + key
Expand Down Expand Up @@ -3774,7 +3791,7 @@ def start(self):
self.subscribe_all()
self.config_db.listen()
def stop(self):
self.config_db.sub_thread.stop()
self.config_db.stop_listen()
if self.config_db.sub_thread.is_alive():
self.config_db.sub_thread.join()

Expand Down
6 changes: 3 additions & 3 deletions src/sonic-frr-mgmt-framework/tests/test_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ def test_contructor():
for table, hdlr in daemon.table_handler_list:
daemon.config_db.subscribe.assert_any_call(table, hdlr)
daemon.config_db.pubsub.psubscribe.assert_called_once()
assert(daemon.config_db.sub_thread.is_alive() == True)
daemon.stop()
daemon.config_db.sub_thread.stop.assert_called()
daemon.config_db.sub_thread.is_alive.assert_called_once()
daemon.config_db.sub_thread.join.assert_called_once()
daemon.config_db.pubsub.punsubscribe.assert_called_once()
assert(daemon.config_db.sub_thread.is_alive() == False)

class CmdMapTestInfo:
data_buf = {}
Expand Down