Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/807830/?format=api
{ "id": 807830, "url": "http://patchwork.ozlabs.org/api/patches/807830/?format=api", "web_url": "http://patchwork.ozlabs.org/project/qemu-devel/patch/1504113297-22052-2-git-send-email-chugh.ishani@research.iiit.ac.in/", "project": { "id": 14, "url": "http://patchwork.ozlabs.org/api/projects/14/?format=api", "name": "QEMU Development", "link_name": "qemu-devel", "list_id": "qemu-devel.nongnu.org", "list_email": "qemu-devel@nongnu.org", "web_url": "", "scm_url": "", "webscm_url": "", "list_archive_url": "", "list_archive_url_format": "", "commit_url_format": "" }, "msgid": "<1504113297-22052-2-git-send-email-chugh.ishani@research.iiit.ac.in>", "list_archive_url": null, "date": "2017-08-30T17:14:55", "name": "[v3,1/3] backup: QEMU Backup Tool", "commit_ref": null, "pull_url": null, "state": "new", "archived": false, "hash": "79074e1681881295a6e6fca096adacaad4e4e0be", "submitter": { "id": 71382, "url": "http://patchwork.ozlabs.org/api/people/71382/?format=api", "name": "Ishani", "email": "chugh.ishani@research.iiit.ac.in" }, "delegate": null, "mbox": "http://patchwork.ozlabs.org/project/qemu-devel/patch/1504113297-22052-2-git-send-email-chugh.ishani@research.iiit.ac.in/mbox/", "series": [ { "id": 668, "url": "http://patchwork.ozlabs.org/api/series/668/?format=api", "web_url": "http://patchwork.ozlabs.org/project/qemu-devel/list/?series=668", "date": "2017-08-30T17:14:56", "name": "QEMU Backup Tool", "version": 3, "mbox": "http://patchwork.ozlabs.org/series/668/mbox/" } ], "comments": "http://patchwork.ozlabs.org/api/patches/807830/comments/", "check": "pending", "checks": "http://patchwork.ozlabs.org/api/patches/807830/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org>", "X-Original-To": "incoming@patchwork.ozlabs.org", "Delivered-To": "patchwork-incoming@bilbo.ozlabs.org", "Authentication-Results": [ "ozlabs.org;\n\tspf=pass (mailfrom) smtp.mailfrom=nongnu.org\n\t(client-ip=2001:4830:134:3::11; helo=lists.gnu.org;\n\tenvelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org;\n\treceiver=<UNKNOWN>)", "ozlabs.org;\n\tdkim=fail reason=\"signature verification failed\" (1024-bit key;\n\tunprotected) header.d=research.iiit.ac.in\n\theader.i=@research.iiit.ac.in header.b=\"FhgRSGko\"; \n\tdkim-atps=neutral" ], "Received": [ "from lists.gnu.org (lists.gnu.org [IPv6:2001:4830:134:3::11])\n\t(using TLSv1 with cipher AES256-SHA (256/256 bits))\n\t(No client certificate requested)\n\tby ozlabs.org (Postfix) with ESMTPS id 3xjCrK45jZz9s7f\n\tfor <incoming@patchwork.ozlabs.org>;\n\tThu, 31 Aug 2017 03:57:05 +1000 (AEST)", "from localhost ([::1]:51958 helo=lists.gnu.org)\n\tby lists.gnu.org with esmtp (Exim 4.71) (envelope-from\n\t<qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org>)\n\tid 1dn7Ed-0001cV-DH\n\tfor incoming@patchwork.ozlabs.org; Wed, 30 Aug 2017 13:57:03 -0400", "from eggs.gnu.org ([2001:4830:134:3::10]:36396)\n\tby lists.gnu.org with esmtp (Exim 4.71)\n\t(envelope-from <chugh.ishani@research.iiit.ac.in>)\n\tid 1dn6aN-0005Vd-KJ\n\tfor qemu-devel@nongnu.org; Wed, 30 Aug 2017 13:15:29 -0400", "from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)\n\t(envelope-from <chugh.ishani@research.iiit.ac.in>)\n\tid 1dn6aG-0005C1-N9\n\tfor qemu-devel@nongnu.org; Wed, 30 Aug 2017 13:15:27 -0400", "from research.iiit.ac.in ([196.12.53.8]:59062)\n\tby eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32)\n\t(Exim 4.71) (envelope-from <chugh.ishani@research.iiit.ac.in>)\n\tid 1dn6aG-0005BW-0E\n\tfor qemu-devel@nongnu.org; Wed, 30 Aug 2017 13:15:20 -0400", "from localhost (localhost [127.0.0.1])\n\tby research.iiit.ac.in (Postfix) with ESMTP id B1D08741DDA;\n\tWed, 30 Aug 2017 22:45:17 +0530 (IST)", "from research.iiit.ac.in ([127.0.0.1])\n\tby localhost (research.iiit.ac.in [127.0.0.1]) (amavisd-new,\n\tport 10032)\n\twith ESMTP id kXawYSE4Q0YE; Wed, 30 Aug 2017 22:45:14 +0530 (IST)", "from localhost (localhost [127.0.0.1])\n\tby research.iiit.ac.in (Postfix) with ESMTP id 41CBD741F45;\n\tWed, 30 Aug 2017 22:45:14 +0530 (IST)", "from research.iiit.ac.in ([127.0.0.1])\n\tby localhost (research.iiit.ac.in [127.0.0.1]) (amavisd-new,\n\tport 10026)\n\twith ESMTP id lx4I0qC2G3EU; Wed, 30 Aug 2017 22:45:14 +0530 (IST)", "from ishani-Inspiron-5558.iiit.ac.in (unknown [10.2.20.52])\n\tby research.iiit.ac.in (Postfix) with ESMTPSA id 2452A741CBE;\n\tWed, 30 Aug 2017 22:45:14 +0530 (IST)" ], "DKIM-Filter": "OpenDKIM Filter v2.9.2 research.iiit.ac.in 41CBD741F45", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed; d=research.iiit.ac.in; \n\ts=4E8815E6-5B55-11E4-B758-8D4964374E96; t=1504113314;\n\tbh=MJZYYlioQ618bAWwHOHlRjBgF+8PnvtLGodPyG20Amw=;\n\th=From:To:Subject:Date:Message-Id;\n\tb=FhgRSGkoci52bEYdq9gnAEjt/bVlptNhFQaxYqFEADGwSNhouJSWHaBniVT49HiU3\n\thaV7e98BsFgT0tNzhRkICmFZJivSvhNQyHYyAKBgblTIvpXfOG2o0zMe4Av1CapOdH\n\ttGN/xQVygkQA/xTnEzL9V3ywp4YeJFiYUVhvd9S4=", "X-Virus-Scanned": "amavisd-new at research.iiit.ac.in", "From": "Ishani Chugh <chugh.ishani@research.iiit.ac.in>", "To": "qemu-devel@nongnu.org", "Date": "Wed, 30 Aug 2017 22:44:55 +0530", "Message-Id": "<1504113297-22052-2-git-send-email-chugh.ishani@research.iiit.ac.in>", "X-Mailer": "git-send-email 2.7.4", "In-Reply-To": "<1504113297-22052-1-git-send-email-chugh.ishani@research.iiit.ac.in>", "References": "<1504113297-22052-1-git-send-email-chugh.ishani@research.iiit.ac.in>", "X-detected-operating-system": "by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic]\n\t[fuzzy]", "X-Received-From": "196.12.53.8", "Subject": "[Qemu-devel] [PATCH v3 1/3] backup: QEMU Backup Tool", "X-BeenThere": "qemu-devel@nongnu.org", "X-Mailman-Version": "2.1.21", "Precedence": "list", "List-Id": "<qemu-devel.nongnu.org>", "List-Unsubscribe": "<https://lists.nongnu.org/mailman/options/qemu-devel>,\n\t<mailto:qemu-devel-request@nongnu.org?subject=unsubscribe>", "List-Archive": "<http://lists.nongnu.org/archive/html/qemu-devel/>", "List-Post": "<mailto:qemu-devel@nongnu.org>", "List-Help": "<mailto:qemu-devel-request@nongnu.org?subject=help>", "List-Subscribe": "<https://lists.nongnu.org/mailman/listinfo/qemu-devel>,\n\t<mailto:qemu-devel-request@nongnu.org?subject=subscribe>", "Cc": "famz@redhat.com, Ishani Chugh <chugh.ishani@research.iiit.ac.in>,\n\tjsnow@redhat.com, stefanha@redhat.com", "Errors-To": "qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org", "Sender": "\"Qemu-devel\"\n\t<qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org>" }, "content": "qemu-backup will be a command-line tool for performing full and\nincremental disk backups on running VMs. It is intended as a\nreference implementation for management stack and backup developers\nto see QEMU's backup features in action. The tool writes details of\nguest in a configuration file and the data is retrieved from the file\nwhile creating a backup. The location of config file can be set as an\nenvironment variable QEMU_BACKUP_CONFIG. The usage is as follows:\n\nAdd a guest\npython qemu-backup.py guest add --guest <guest_name> --qmp <socket_path>\n\nAdd a drive for backup in a specified guest\npython qemu-backup.py drive add --guest <guest_name> --id <drive_id> [--target <target_file_path>]\n\nCreate backup of the added drives:\npython qemu-backup.py backup --guest <guest_name>\n\nList all guest configs in configuration file:\npython qemu-backup.py guest list\n\nRestore operation\npython qemu-backup.py restore --guest <guest-name>\n\nRemove a guest\npython qemu-backup.py guest remove --guest <guest_name>\n\nSigned-off-by: Ishani Chugh <chugh.ishani@research.iiit.ac.in>\n---\n contrib/backup/qemu-backup.py | 343 ++++++++++++++++++++++++++++++++++++++++++\n 1 file changed, 343 insertions(+)\n create mode 100644 contrib/backup/qemu-backup.py", "diff": "diff --git a/contrib/backup/qemu-backup.py b/contrib/backup/qemu-backup.py\nnew file mode 100644\nindex 0000000..248ca9f\n--- /dev/null\n+++ b/contrib/backup/qemu-backup.py\n@@ -0,0 +1,343 @@\n+#!/usr/bin/python\n+# -*- coding: utf-8 -*-\n+#\n+# Copyright (C) 2017 Ishani Chugh <chugh.ishani@research.iiit.ac.in>\n+#\n+# This program is free software; you can redistribute it and/or modify\n+# it under the terms of the GNU General Public License as published by\n+# the Free Software Foundation; either version 2 of the License, or\n+# (at your option) any later version.\n+#\n+# This program is distributed in the hope that it will be useful,\n+# but WITHOUT ANY WARRANTY; without even the implied warranty of\n+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n+# GNU General Public License for more details.\n+#\n+# You should have received a copy of the GNU General Public License\n+# along with this program. If not, see <http://www.gnu.org/licenses/>.\n+#\n+\n+\"\"\"\n+This file is an implementation of backup tool\n+\"\"\"\n+from __future__ import print_function\n+from argparse import ArgumentParser\n+import os\n+import errno\n+from socket import error as socket_error\n+try:\n+ import configparser\n+except ImportError:\n+ import ConfigParser as configparser\n+import sys\n+sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..',\n+ 'scripts', 'qmp'))\n+from qmp import QEMUMonitorProtocol\n+\n+\n+class BackupTool(object):\n+ \"\"\"BackupTool Class\"\"\"\n+ def __init__(self, config_file=os.path.expanduser('~') +\n+ '/.config/qemu/qemu-backup-config'):\n+ if \"QEMU_BACKUP_CONFIG\" in os.environ:\n+ self.config_file = os.environ[\"QEMU_BACKUP_CONFIG\"]\n+\n+ else:\n+ self.config_file = config_file\n+ try:\n+ if not os.path.isdir(os.path.dirname(self.config_file)):\n+ os.makedirs(os.path.dirname(self.config_file))\n+ except:\n+ print(\"Cannot create config directory\", file=sys.stderr)\n+ sys.exit(1)\n+ self.config = configparser.ConfigParser()\n+ self.config.read(self.config_file)\n+ try:\n+ if self.config.get('general', 'version') != '1.0':\n+ print(\"Version Conflict in config file\", file=sys.stderr)\n+ sys.exit(1)\n+ except:\n+ self.config['general'] = {'version': '1.0'}\n+ self.write_config()\n+\n+ def write_config(self):\n+ \"\"\"\n+ Writes configuration to ini file.\n+ \"\"\"\n+ config_file = open(self.config_file + \".tmp\", 'w')\n+ self.config.write(config_file)\n+ config_file.flush()\n+ os.fsync(config_file.fileno())\n+ config_file.close()\n+ os.rename(self.config_file + \".tmp\", self.config_file)\n+\n+ def get_socket_address(self, socket_address):\n+ \"\"\"\n+ Return Socket address in form of string or tuple\n+ \"\"\"\n+ if socket_address.startswith('tcp'):\n+ return (socket_address.split(':')[1],\n+ int(socket_address.split(':')[2]))\n+ return socket_address.split(':', 2)[1]\n+\n+ def _full_backup(self, guest_name):\n+ \"\"\"\n+ Performs full backup of guest\n+ \"\"\"\n+ if guest_name not in self.config.sections():\n+ print(\"Cannot find specified guest\", file=sys.stderr)\n+ sys.exit(1)\n+\n+ self.verify_guest_running(guest_name)\n+ connection = QEMUMonitorProtocol(\n+ self.get_socket_address(\n+ self.config[guest_name]['qmp']))\n+ connection.connect()\n+ cmd = {\"execute\": \"transaction\", \"arguments\": {\"actions\": []}}\n+ drive_list = []\n+ for key in self.config[guest_name]:\n+ if key.startswith(\"drive_\"):\n+ drive = key[len('drive_'):]\n+ drive_list.append(drive)\n+ target = self.config[guest_name][key]\n+ sub_cmd = {\"type\": \"drive-backup\", \"data\": {\"device\": drive,\n+ \"target\": target,\n+ \"sync\": \"full\"}}\n+ cmd['arguments']['actions'].append(sub_cmd)\n+ qmp_return = connection.cmd_obj(cmd)\n+ if 'error' in qmp_return:\n+ print(qmp_return['error']['desc'], file=sys.stderr)\n+ sys.exit(1)\n+ print(\"Backup Started\")\n+ while drive_list:\n+ event = connection.pull_event(wait=True)\n+ if event['event'] == 'SHUTDOWN':\n+ print(\"The guest was SHUT DOWN\", file=sys.stderr)\n+ sys.exit(1)\n+\n+ if event['event'] == 'BLOCK_JOB_COMPLETED':\n+ if event['data']['device'] in drive_list and \\\n+ event['data']['type'] == 'backup':\n+ print(\"*\" + event['data']['device'])\n+ drive_list.remove(event['data']['device'])\n+\n+ if event['event'] == 'BLOCK_JOB_ERROR':\n+ if event['data']['device'] in drive_list and \\\n+ event['data']['type'] == 'backup':\n+ print(event['data']['device'] + \" Backup Failed\",\n+ file=sys.stderr)\n+ drive_list.remove(event['data']['device'])\n+ print(\"Backup Complete\")\n+\n+ def _drive_add(self, drive_id, guest_name, target=None):\n+ \"\"\"\n+ Adds drive for backup\n+ \"\"\"\n+ if target is None:\n+ target = os.path.abspath(drive_id)\n+\n+ if os.path.isdir(os.path.dirname(target)) is False:\n+ print(\"Cannot find target directory\", file=sys.stderr)\n+ sys.exit(1)\n+\n+ if guest_name not in self.config.sections():\n+ print(\"Cannot find specified guest\", file=sys.stderr)\n+ sys.exit(1)\n+\n+ if \"drive_\" + drive_id in self.config[guest_name]:\n+ print(\"Drive already marked for backup\", file=sys.stderr)\n+ sys.exit(1)\n+\n+ self.verify_guest_running(guest_name)\n+\n+ connection = QEMUMonitorProtocol(\n+ self.get_socket_address(\n+ self.config[guest_name]['qmp']))\n+ connection.connect()\n+ cmd = {'execute': 'query-block'}\n+ returned_json = connection.cmd_obj(cmd)\n+ device_present = False\n+ for device in returned_json['return']:\n+ if device['device'] == drive_id:\n+ device_present = True\n+ break\n+\n+ if not device_present:\n+ print(\"No such drive in guest\", file=sys.stderr)\n+ sys.exit(1)\n+\n+ drive_id = \"drive_\" + drive_id\n+ for d_id in self.config[guest_name]:\n+ if self.config[guest_name][d_id] == target:\n+ print(\"Please choose different target\", file=sys.stderr)\n+ sys.exit(1)\n+ self.config.set(guest_name, drive_id, target)\n+ self.write_config()\n+ print(\"Successfully Added Drive\")\n+\n+ def verify_guest_running(self, guest_name):\n+ \"\"\"\n+ Checks whether specified guest is running or not\n+ \"\"\"\n+ socket_address = self.config.get(guest_name, 'qmp')\n+ try:\n+ connection = QEMUMonitorProtocol(self.get_socket_address(\n+ socket_address))\n+ connection.connect()\n+ except socket_error:\n+ if socket_error.errno != errno.ECONNREFUSED:\n+ print(\"Connection to guest refused\", file=sys.stderr)\n+ sys.exit(1)\n+\n+ def _guest_add(self, guest_name, socket_address):\n+ \"\"\"\n+ Adds a guest to the config file\n+ \"\"\"\n+ if guest_name in self.config.sections():\n+ print(\"ID already exists. Please choose a different guest name\",\n+ file=sys.stderr)\n+ sys.exit(1)\n+ self.config[guest_name] = {'qmp': socket_address}\n+ self.verify_guest_running(guest_name)\n+ self.write_config()\n+ print(\"Successfully Added Guest\")\n+\n+ def _guest_remove(self, guest_name):\n+ \"\"\"\n+ Removes a guest from config file\n+ \"\"\"\n+ if guest_name not in self.config.sections():\n+ print(\"Guest Not present\", file=sys.stderr)\n+ sys.exit(1)\n+ self.config.remove_section(guest_name)\n+ print(\"Guest successfully deleted\")\n+\n+ def _restore(self, guest_name):\n+ \"\"\"\n+ Prints Steps to perform restore operation\n+ \"\"\"\n+ if guest_name not in self.config.sections():\n+ print(\"Cannot find specified guest\", file=sys.stderr)\n+ sys.exit(1)\n+\n+ self.verify_guest_running(guest_name)\n+ connection = QEMUMonitorProtocol(\n+ self.get_socket_address(\n+ self.config[guest_name]['qmp']))\n+ connection.connect()\n+ print(\"To perform restore:\")\n+ print(\"Shut down guest\")\n+ for key in self.config[guest_name]:\n+ if key.startswith(\"drive_\"):\n+ drive = key[len('drive_'):]\n+ target = self.config[guest_name][key]\n+ cmd = {'execute': 'query-block'}\n+ returned_json = connection.cmd_obj(cmd)\n+ device_present = False\n+ for device in returned_json['return']:\n+ if device['device'] == drive:\n+ device_present = True\n+ location = device['inserted']['image']['filename']\n+ print(\"qemu-img convert \" + target + \" \" + location)\n+\n+ if not device_present:\n+ print(\"No such drive in guest\", file=sys.stderr)\n+ sys.exit(1)\n+\n+ def guest_remove_wrapper(self, args):\n+ \"\"\"\n+ Wrapper for _guest_remove method.\n+ \"\"\"\n+ guest_name = args.guest\n+ self._guest_remove(guest_name)\n+ self.write_config()\n+\n+ def list(self, args):\n+ \"\"\"\n+ Prints guests present in Config file\n+ \"\"\"\n+ for guest_name in self.config.sections():\n+ print(guest_name)\n+\n+ def guest_add_wrapper(self, args):\n+ \"\"\"\n+ Wrapper for _quest_add method\n+ \"\"\"\n+ self._guest_add(args.guest, args.qmp)\n+\n+ def drive_add_wrapper(self, args):\n+ \"\"\"\n+ Wrapper for _drive_add method\n+ \"\"\"\n+ self._drive_add(args.id, args.guest, args.target)\n+\n+ def fullbackup_wrapper(self, args):\n+ \"\"\"\n+ Wrapper for _full_backup method\n+ \"\"\"\n+ self._full_backup(args.guest)\n+\n+ def restore_wrapper(self, args):\n+ \"\"\"\n+ Wrapper for restore\n+ \"\"\"\n+ self._restore(args.guest)\n+\n+\n+def main():\n+ backup_tool = BackupTool()\n+ parser = ArgumentParser()\n+ subparsers = parser.add_subparsers(title='Subcommands',\n+ description='Valid Subcommands',\n+ help='Subcommand help')\n+ guest_parser = subparsers.add_parser('guest', help='Adds or \\\n+ removes and lists guest(s)')\n+ guest_subparsers = guest_parser.add_subparsers(title='Guest Subparser')\n+ guest_list_parser = guest_subparsers.add_parser('list',\n+ help='Lists all guests')\n+ guest_list_parser.set_defaults(func=backup_tool.list)\n+\n+ guest_add_parser = guest_subparsers.add_parser('add', help='Adds a guest')\n+ guest_add_parser.add_argument('--guest', action='store', type=str,\n+ help='Name of the guest')\n+ guest_add_parser.add_argument('--qmp', action='store', type=str,\n+ help='Path of socket')\n+ guest_add_parser.set_defaults(func=backup_tool.guest_add_wrapper)\n+\n+ guest_remove_parser = guest_subparsers.add_parser('remove',\n+ help='removes a guest')\n+ guest_remove_parser.add_argument('--guest', action='store', type=str,\n+ help='Name of the guest')\n+ guest_remove_parser.set_defaults(func=backup_tool.guest_remove_wrapper)\n+\n+ drive_parser = subparsers.add_parser('drive',\n+ help='Adds drive(s) for backup')\n+ drive_subparsers = drive_parser.add_subparsers(title='Add subparser',\n+ description='Drive \\\n+ subparser')\n+ drive_add_parser = drive_subparsers.add_parser('add',\n+ help='Adds new \\\n+ drive for backup')\n+ drive_add_parser.add_argument('--guest', action='store',\n+ type=str, help='Name of the guest')\n+ drive_add_parser.add_argument('--id', action='store',\n+ type=str, help='Drive ID')\n+ drive_add_parser.add_argument('--target', nargs='?',\n+ default=None, help='Destination path')\n+ drive_add_parser.set_defaults(func=backup_tool.drive_add_wrapper)\n+\n+ backup_parser = subparsers.add_parser('backup', help='Creates backup')\n+ backup_parser.add_argument('--guest', action='store',\n+ type=str, help='Name of the guest')\n+ backup_parser.set_defaults(func=backup_tool.fullbackup_wrapper)\n+\n+ backup_parser = subparsers.add_parser('restore', help='Restores drives')\n+ backup_parser.add_argument('--guest', action='store',\n+ type=str, help='Name of the guest')\n+ backup_parser.set_defaults(func=backup_tool.restore_wrapper)\n+\n+ args = parser.parse_args()\n+ args.func(args)\n+\n+if __name__ == '__main__':\n+ main()\n", "prefixes": [ "v3", "1/3" ] }