VPP-635: CLI Memory leak with invalid parameter - vpp

diff options

author	Billy McFall <bmcfall@redhat.com>	2017-02-15 11:39:12 -0500
committer	Dave Barach <openvpp@barachs.net>	2017-02-22 16:23:12 +0000
commit	a9a20e7f69f4a91a4d5267ab5ce14125bdc7d6c6 (patch)
tree	58647f28d51d1cac3e7aa4e9ca94280192e6ec25 /src/vpp-api-test.am
parent	2291a36008e197423a0f0414f6dcca4afa3ac4c1 (diff)

VPP-635: CLI Memory leak with invalid parameter

In the CLI parsing, below is a common pattern: /* Get a line of input. */ if (!unformat_user (input, unformat_line_input, line_input)) return 0; while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) { if (unformat (line_input, "x")) x = 1; : else return clib_error_return (0, "unknown input `%U'", format_unformat_error, line_input); } unformat_free (line_input); The 'else' returns if an unknown string is encountered. There a memory leak because the 'unformat_free(line_input)' is not called. There is a large number of instances of this pattern. Replaced the previous pattern with: /* Get a line of input. */ if (!unformat_user (input, unformat_line_input, line_input)) return 0; while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) { if (unformat (line_input, "x")) x = 1; : else { error = clib_error_return (0, "unknown input `%U'", format_unformat_error, line_input); goto done: } } /* ...Remaining code... */ done: unformat_free (line_input); return error; } In multiple files, 'unformat_free (line_input);' was never called, so there was a memory leak whether an invalid string was entered or not. Also, there were multiple instance where: error = clib_error_return (0, "unknown input `%U'", format_unformat_error, line_input); used 'input' as the last parameter instead of 'line_input'. The result is that output did not contain the substring in error, instead just an empty string. Fixed all of those as well. There are a lot of file, and very mind numbing work, so tried to keep it to a pattern to avoid mistakes. Change-Id: I8902f0c32a47dd7fb3bb3471a89818571702f1d2 Signed-off-by: Billy McFall <bmcfall@redhat.com> Signed-off-by: Dave Barach <dave@barachs.net>

Diffstat (limited to 'src/vpp-api-test.am')

0 files changed, 0 insertions, 0 deletions

""" abstract vpp object and object registry """ import abc class VppObject(metaclass=abc.ABCMeta): """ Abstract vpp object """ @abc.abstractmethod def add_vpp_config(self) -> None: """ Add the configuration for this object to vpp. """ pass @abc.abstractmethod def query_vpp_config(self) -> bool: """Query the vpp configuration. :return: True if the object is configured""" pass @abc.abstractmethod def remove_vpp_config(self) -> None: """ Remove the configuration for this object from vpp. """ pass def object_id(self) -> str: """ Return a unique string representing this object. """ return "Undefined. for <%s %s>" % (self.__class__.__name__, id(self)) def __str__(self) -> str: return self.object_id() def __repr__(self) -> str: return '<%s>' % self.object_id() def __hash__(self) -> int: return hash(self.object_id()) def __eq__(self, other) -> bool: if not isinstance(other, self.__class__): return NotImplemented if other.object_id() == self.object_id(): return True return False # This can be removed when python2 support is dropped. def __ne__(self, other): return not self.__eq__(other) class VppObjectRegistry: """ Class which handles automatic configuration cleanup. """ _shared_state = {} def __init__(self) -> None: self.__dict__ = self._shared_state if not hasattr(self, "_object_registry"): self._object_registry = [] if not hasattr(self, "_object_dict"): self._object_dict = dict() def register(self, obj: VppObject, logger) -> None: """ Register an object in the registry. """ if obj.object_id() not in self._object_dict: self._object_registry.append(obj) self._object_dict[obj.object_id()] = obj logger.debug("REG: registering %s" % obj) else: logger.debug("REG: duplicate add, ignoring (%s)" % obj) def unregister_all(self, logger) -> None: """ Remove all object registrations from registry. """ logger.debug("REG: removing all object registrations") self._object_registry = [] self._object_dict = dict() def remove_vpp_config(self, logger) -> None: """ Remove configuration (if present) from vpp and then remove all objects from the registry. """ if not self._object_registry: logger.info("REG: No objects registered for auto-cleanup.") return logger.info("REG: Removing VPP configuration for registered objects") # remove the config in reverse order as there might be dependencies failed = [] for obj in reversed(self._object_registry): if obj.query_vpp_config(): logger.info("REG: Removing configuration for %s" % obj) obj.remove_vpp_config() if obj.query_vpp_config(): failed.append(obj) else: logger.info( "REG: Skipping removal for %s, configuration not present" % obj) self.unregister_all(logger) if failed: logger.error("REG: Couldn't remove configuration for object(s):") for obj in failed: logger.error(repr(obj)) raise Exception("Couldn't remove configuration for object(s): %s" % (", ".join(str(x) for x in failed)))


context:
space:
mode: