@@ -359,9 +359,51 @@ def wait(self):
self._qmp.close()
self._post_shutdown()
- def shutdown(self, has_quit=False, hard=False):
+ def _hard_shutdown(self) -> None:
"""
- Terminate the VM and clean up
+ Kill the VM if it is running.
+ """
+ if not self.is_running():
+ return
+
+ self._popen.kill()
+ self._popen.wait(timeout=60)
+
+ def _soft_shutdown(self, has_quit: bool = False, timeout: int = 3) -> None:
+ """
+ Attempt to shutdown the VM gracefully if it is running.
+
+ :param has_quit: When True, don't attempt to issue 'quit' QMP command
+ :param timeout: Timeout for graceful shutdown. Default 3 seconds.
+ """
+ if not self.is_running():
+ return
+
+ if self._qmp is not None:
+ if not has_quit:
+ self._qmp.cmd('quit')
+ self._qmp.close()
+
+ self._popen.wait(timeout=timeout)
+
+ def _do_shutdown(self, has_quit: bool = False, timeout: int = 3) -> None:
+ """
+ Attempt to shutdown the VM gracefully; fallback to a hard shutdown.
+
+ :param has_quit: When True, don't attempt to issue 'quit' QMP command
+ :param timeout: Timeout for graceful shutdown. Default 3 seconds.
+ """
+ try:
+ self._soft_shutdown(has_quit, timeout)
+ except subprocess.TimeoutExpired:
+ self._hard_shutdown()
+ except:
+ self._hard_shutdown()
+ raise
+
+ def shutdown(self, has_quit: bool = False, hard: bool = False) -> None:
+ """
+ Terminate the VM (gracefully if possible) and perform cleanup.
"""
# If we keep the console socket open, we may deadlock waiting
# for QEMU to exit, while QEMU is waiting for the socket to
@@ -370,22 +412,18 @@ def shutdown(self, has_quit=False, hard=False):
self._console_socket.close()
self._console_socket = None
- if self.is_running():
+ try:
if hard:
- self._popen.kill()
- elif self._qmp:
- try:
- if not has_quit:
- self._qmp.cmd('quit')
- self._qmp.close()
- self._popen.wait(timeout=3)
- except:
- self._popen.kill()
- self._popen.wait()
-
- self._post_shutdown()
+ self._hard_shutdown()
+ else:
+ self._do_shutdown(has_quit)
+ finally:
+ self._post_shutdown()
def kill(self):
+ """
+ Terminate the VM forcefully and perform cleanup.
+ """
self.shutdown(hard=True)
def set_qmp_monitor(self, enabled=True):
This is done primarily to avoid the 'bare except' pattern, which suppresses ALL exceptions and not just ones that we are anticipating to see. Replace this with a pattern that isolates the different kind of shutdown paradigms and a new fallback shutdown handler that gracefully attempts one before the other. Ensure that the main shutdown() function ALWAYS calls the post_shutdown logic, no matter what kind of error we encountered. Subprocess wait timeouts are considered expected, everything else is unexpected. In cases where we encounter an expected error in the graceful shutdown timeout, we will not re-raise an exception above shutdown(). Otherwise, after post_shutdown cleanup, we will. I anticipate that this WILL lead to additional bug reports filed against this module, but that is unfortunately somewhat the point: This code shouldn't be hiding failures that exist elsewhere within the python code. Signed-off-by: John Snow <jsnow@redhat.com> --- python/qemu/machine.py | 68 ++++++++++++++++++++++++++++++++---------- 1 file changed, 53 insertions(+), 15 deletions(-)