from osm_common import dbmongo, dbmemory, msglocal, msgkafka
from osm_common.dbbase import DbException
from osm_common.msgbase import MsgException
-from osm_ng_ro.ns import NsException
from time import time
__author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
Exception.__init__(self, message)
+class LockRenew:
+
+ renew_list = []
+ # ^ static method, common for all RO. Time ordered list of dictionaries with information of locks that needs to
+ # be renewed. The time order is achieved as it is appended at the end
+
+ def __init__(self, config, logger):
+ """
+ Constructor of class
+ :param config: configuration parameters of database and messaging
+ """
+ self.config = config
+ self.logger = logger
+ self.to_terminate = False
+ self.loop = None
+ self.db = None
+ self.task_locked_time = config["global"]["task_locked_time"]
+ self.task_relock_time = config["global"]["task_relock_time"]
+ self.task_max_locked_time = config["global"]["task_max_locked_time"]
+
+ def start(self, db, loop):
+ self.db = db
+ self.loop = loop
+
+ @staticmethod
+ def add_lock_object(database_table, database_object, thread_object):
+ """
+ Insert a task to renew the locking
+ :param database_table: database collection where to maintain the lock
+ :param database_object: database object. '_id' and 'locked_at' are mandatory keys
+ :param thread_object: Thread object that has locked to check if it is alive
+ :return: a locked_object needed for calling remove_lock_object. It will contain uptodya database 'locked_at'
+ """
+ lock_object = {
+ "table": database_table,
+ "_id": database_object["_id"],
+ "initial_lock_time": database_object["locked_at"],
+ "locked_at": database_object["locked_at"],
+ "thread": thread_object,
+ "unlocked": False # True when it is not needed any more
+ }
+ LockRenew.renew_list.append(lock_object)
+ return lock_object
+
+ @staticmethod
+ def remove_lock_object(lock_object):
+ lock_object["unlocked"] = True
+
+ async def renew_locks(self):
+ while not self.to_terminate:
+ if not self.renew_list:
+ await asyncio.sleep(self.task_locked_time - self.task_relock_time, loop=self.loop)
+ continue
+ lock_object = self.renew_list[0]
+ if lock_object["unlocked"] or not lock_object["thread"] or not lock_object["thread"].is_alive():
+ # task has been finished or locker thread is dead, not needed to re-locked.
+ self.renew_list.pop(0)
+ continue
+
+ locked_at = lock_object["locked_at"]
+ now = time()
+ time_to_relock = locked_at + self.task_locked_time - self.task_relock_time - now
+ if time_to_relock < 1:
+ if lock_object["initial_lock_time"] + self.task_max_locked_time < now:
+ self.renew_list.pop(0)
+ # re-lock
+ new_locked_at = locked_at + self.task_locked_time
+ try:
+ if self.db.set_one(lock_object["table"],
+ update_dict={"locked_at": new_locked_at, "modified_at": now},
+ q_filter={"_id": lock_object["_id"], "locked_at": locked_at},
+ fail_on_empty=False):
+ self.logger.debug("Renew lock for {}.{}".format(lock_object["table"], lock_object["_id"]))
+ lock_object["locked_at"] = new_locked_at
+ self.renew_list.append(lock_object)
+ else:
+ self.logger.info("Cannot renew lock for {}.{}".format(lock_object["table"],
+ lock_object["_id"]))
+ except Exception as e:
+ self.logger.error("Exception when trying to renew lock for {}.{}: {}".format(
+ lock_object["table"], lock_object["_id"], e))
+ else:
+ # wait until it is time to re-lock it
+ await asyncio.sleep(time_to_relock, loop=self.loop)
+
+ def stop(self):
+ # unlock all locked items
+ now = time()
+ for lock_object in self.renew_list:
+ locked_at = lock_object["locked_at"]
+ if not lock_object["unlocked"] or locked_at + self.task_locked_time >= now:
+ self.db.set_one(lock_object["table"], update_dict={"locked_at": 0},
+ q_filter={"_id": lock_object["_id"], "locked_at": locked_at},
+ fail_on_empty=False)
+
+
class VimAdminThread(threading.Thread):
- MAX_TIME_LOCKED = 3600 # 1h
MAX_TIME_UNATTENDED = 600 # 10min
TIME_CHECK_UNUSED_VIM = 3600 * 2 # 2h
kafka_topics = ("vim_account", "wim_account", "sdn")
self.logger = logging.getLogger("ro.vimadmin")
self.aiomain_task_kafka = None # asyncio task for receiving vim actions from kafka bus
self.aiomain_task_vim = None # asyncio task for watching ro_tasks not processed by nobody
+ self.aiomain_task_renew_lock = None
+ # ^asyncio task for maintain an ro_task locked when VIM plugin takes too much time processing an order
+ self.lock_renew = LockRenew(config, self.logger)
+ self.task_locked_time = config["global"]["task_locked_time"]
async def vim_watcher(self):
""" Reads database periodically looking for tasks not processed by nobody because of a reboot
ro_tasks = self.db.get_list("ro_tasks",
q_filter={"target_id.ncont": self.engine.get_assigned_vims(),
"tasks.status": ['SCHEDULED', 'BUILD', 'DONE', 'FAILED'],
- "locked_at.lt": now - self.MAX_TIME_LOCKED,
+ "locked_at.lt": now - self.task_locked_time,
"to_check_at.gt": self.last_rotask_time,
"to_check_at.lte": now - self.MAX_TIME_UNATTENDED})
self.last_rotask_time = now - self.MAX_TIME_UNATTENDED
if self.db.get_list("ro_tasks",
q_filter={"target_id": ro_task["target_id"],
"tasks.status": ['SCHEDULED', 'BUILD', 'DONE', 'FAILED'],
- "locked_at.gt": now - self.MAX_TIME_LOCKED}):
+ "locked_at.gt": now - self.task_locked_time}):
continue
# unattended, assign vim
self.engine.assign_vim(ro_task["target_id"])
self.aiomain_task_vim = asyncio.ensure_future(
self.vim_watcher(),
loop=self.loop)
- done, _ = await asyncio.wait([self.aiomain_task_kafka, self.aiomain_task_vim],
- timeout=None, loop=self.loop, return_when=asyncio.FIRST_COMPLETED)
+ if not self.aiomain_task_renew_lock:
+ self.aiomain_task_renew_lock = asyncio.ensure_future(self.lock_renew.renew_locks(), loop=self.loop)
+
+ done, _ = await asyncio.wait(
+ [self.aiomain_task_kafka, self.aiomain_task_vim, self.aiomain_task_renew_lock],
+ timeout=None, loop=self.loop, return_when=asyncio.FIRST_COMPLETED)
try:
if self.aiomain_task_kafka in done:
exc = self.aiomain_task_kafka.exception()
exc = self.aiomain_task_vim.exception()
self.logger.error("vim_account watcher task exception: {}".format(exc))
self.aiomain_task_vim = None
+ if self.aiomain_task_renew_lock in done:
+ exc = self.aiomain_task_renew_lock.exception()
+ self.logger.error("renew_locks task exception: {}".format(exc))
+ self.aiomain_task_renew_lock = None
except asyncio.CancelledError:
pass
else:
raise VimAdminException("Invalid configuration param '{}' at '[database]':'driver'".format(
self.config["database"]["driver"]))
+ self.lock_renew.start(self.db, self.loop)
+
if not self.msg:
config_msg = self.config["message"].copy()
config_msg["loop"] = self.loop
self.engine.check_vim(target_id)
self.logger.debug("ordered to check {}".format(target_id))
- except (NsException, DbException, MsgException) as e:
+ except (DbException, MsgException) as e:
self.logger.error("Error while processing topic={} command={}: {}".format(topic, command, e))
except Exception as e:
self.logger.exception("Exception while processing topic={} command={}: {}".format(topic, command, e),
:return: None
"""
self.to_terminate = True
+ self.lock_renew.to_terminate = True
if self.aiomain_task_kafka:
self.loop.call_soon_threadsafe(self.aiomain_task_kafka.cancel)
if self.aiomain_task_vim:
self.loop.call_soon_threadsafe(self.aiomain_task_vim.cancel)
+ if self.aiomain_task_renew_lock:
+ self.loop.call_soon_threadsafe(self.aiomain_task_renew_lock.cancel)
+ self.lock_renew.stop()
projects / osm / RO.git / blobdiff