From patchwork Fri Apr 9 13:43:46 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tarun Gupta X-Patchwork-Id: 1464379 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=nongnu.org (client-ip=209.51.188.17; helo=lists.gnu.org; envelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org; receiver=) Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=Nvidia.com header.i=@Nvidia.com header.a=rsa-sha256 header.s=selector2 header.b=mPK3YX/G; dkim-atps=neutral Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 4FH0BH1ZBFz9sW1 for ; Fri, 9 Apr 2021 23:59:49 +1000 (AEST) Received: from localhost ([::1]:58856 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lUrfm-0003cZ-6Y for incoming@patchwork.ozlabs.org; Fri, 09 Apr 2021 09:59:46 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:42162) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lUrfI-0003cT-E1 for qemu-devel@nongnu.org; Fri, 09 Apr 2021 09:59:16 -0400 Received: from mail-dm6nam11on2062.outbound.protection.outlook.com ([40.107.223.62]:32960 helo=NAM11-DM6-obe.outbound.protection.outlook.com) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lUrfF-0007RV-Ol for qemu-devel@nongnu.org; Fri, 09 Apr 2021 09:59:16 -0400 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=aLUo4yFRRTAFsMbHw1JaLQAAIJnxvX27q3WwYRhPF+rdqS+K7nMOUbGc1gJUY8R8+BtfW+NeHa5Zqx0/XLHGTqee8VxWWKlpgeSkdveY4N8k9ab83pjyqesenQ1wwG8+xY43Xc7Tr45wjUFo4JLW+CnIDAtJQcxo1QyEO95/zyxVDzB0XbpytCnsG9YlZKMQGqrcQSFzyudM3gqpHeuvR19OeyVdT/b8sRvomo0x2OEdmRTGW0z/W40ApVw+2cgHqXdmsW69hqankLNhnqfFBzerwIlesaMwh/ojG0VOU2BHpdbFeqm8Q3gvij6XUFqVeHqIMKyukdjSpqH0jmyGIw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=yM1+eK/vMGewPuqa1ACFbL68jM7IvyO2aSMeuZ841LA=; b=WwksC/kI1/AzPpiMod52AjY+/LNP8OCiR4kuF1WSJwfLbfljdLC+lErJ9vTCE/Te4vN+g7lkMXb97IiuIBG6H+4lz3Xko9Rv68EsvSu9tGLnLoP+V1bC96SxsKRVrot+CMXeLINDf9o2BEXJC+q/JJQJ1Lw6Ryw1xzue0NcGt35fTEGFi2999s0rwLw1xPRyBPOg9df/4Fb/ztvSZvclOb/H/gRGczaHvg+K+cncHhgw1grAAA4fVIW28L1WcahuaON2R5nqzMeNJAKRUH4BhdKuWdj790mwX/rji2xroJ1Y46RKT9d7ahufdKXG4wCYBr6My5KY6I+SRTk9X2nrvg== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 216.228.112.35) smtp.rcpttodomain=redhat.com smtp.mailfrom=nvidia.com; dmarc=pass (p=none sp=none pct=100) action=none header.from=nvidia.com; dkim=none (message not signed); arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=Nvidia.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=yM1+eK/vMGewPuqa1ACFbL68jM7IvyO2aSMeuZ841LA=; b=mPK3YX/GGGKYUYj5EjHYAnSXZe+/NhfLCbkLDGV5kQJRgiKkWoiD2IZYp/vcIR8HjLOZHoGscQ1oaxMM+ck4ssP8phEL0jDWKftQGxFcSX0HCGdJBH8koOVpLuqqdtvNJGjf79Q7X59aX/IXw8FtWWoZdYB4LvE495LkzZaHm7/7M0ERdpBzkMx99un8THfvk2/lk/Ibb7YJkpF+D9CQOcnDkwLu/PWZJ3DhiMmJyIOts1w/4Ao93CyGa/arkXmgSOeWOxR4EflsYfqhtPAB4rrE5Wbqq52tvN5ApMftVM/d0w3nWRh7/xUdGj6XukAC9d9Ze6loPavcO4wiH/3TWQ== Received: from BN9PR03CA0011.namprd03.prod.outlook.com (2603:10b6:408:fa::16) by DM5PR1201MB2505.namprd12.prod.outlook.com (2603:10b6:3:ea::16) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4020.17; Fri, 9 Apr 2021 13:44:08 +0000 Received: from BN8NAM11FT032.eop-nam11.prod.protection.outlook.com (2603:10b6:408:fa:cafe::53) by BN9PR03CA0011.outlook.office365.com (2603:10b6:408:fa::16) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4020.21 via Frontend Transport; Fri, 9 Apr 2021 13:44:08 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 216.228.112.35) smtp.mailfrom=nvidia.com; redhat.com; dkim=none (message not signed) header.d=none;redhat.com; dmarc=pass action=none header.from=nvidia.com; Received-SPF: Pass (protection.outlook.com: domain of nvidia.com designates 216.228.112.35 as permitted sender) receiver=protection.outlook.com; client-ip=216.228.112.35; helo=mail.nvidia.com; Received: from mail.nvidia.com (216.228.112.35) by BN8NAM11FT032.mail.protection.outlook.com (10.13.177.88) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384) id 15.20.4020.17 via Frontend Transport; Fri, 9 Apr 2021 13:44:07 +0000 Received: from HQMAIL111.nvidia.com (172.20.187.18) by HQMAIL111.nvidia.com (172.20.187.18) with Microsoft SMTP Server (TLS) id 15.0.1497.2; Fri, 9 Apr 2021 13:44:07 +0000 Received: from dhcp-10-24-130-144.nvidia.com (172.20.145.6) by mail.nvidia.com (172.20.187.18) with Microsoft SMTP Server (TLS) id 15.0.1497.2 via Frontend Transport; Fri, 9 Apr 2021 13:44:03 +0000 From: Tarun Gupta To: , , , , Subject: [PATCH v4 1/1] docs/devel: Add VFIO device migration documentation Date: Fri, 9 Apr 2021 19:13:46 +0530 Message-ID: <20210409134346.16490-1-targupta@nvidia.com> X-Mailer: git-send-email 2.27.0 MIME-Version: 1.0 X-NVConfidentiality: public X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 1923f28a-54d3-4e3f-2cbe-08d8fb5d8c84 X-MS-TrafficTypeDiagnostic: DM5PR1201MB2505: X-Microsoft-Antispam-PRVS: X-MS-Exchange-Transport-Forked: True X-MS-Oob-TLC-OOBClassifiers: OLM:10000; X-MS-Exchange-SenderADCheck: 1 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: XO1ActaC6bCzfkEMJFTQz1vqrAyyp3vw+DRaWOWU5Sy0K3eykE27LHE+OReIJdQJJVbd8vUtxsRrCWTB28TZlaLR81Yz4cN2ZPmirrAS3sqI9ReTFbqJIwhIyyyJ2b44OCk1M55vSwW+alZraDPu6lyueA3m+uLGmE3ssN26DWgxgWcKO5r3Emkl+CoWC/bRXrMgJy8va5rQFwX0OzVimTWUqw1dwl/r+KuQYD0hJZu45YRMwsuw01xAPdR8Vz8AlKPdPs4yLgNk3OXVwccRX5Mhp3Ew2aIARVhCAncaFhKZ03N/PMuP6PeOgvaFu3Cm45tNar/4m2TNMC5di1s8ArndKBgW76m+mnO9zyPsHn3R1FtDVDKUbIlVOI45Fd01yNuksueSsICj3GUHtTOxSWFDhkurSwHvMAEzPoD4ZF7mAQMkOubziIklHV89usDJcBwLZenLCYP+8sphM86EO3T9hIBPd6I2aIq7vZAqQ2DP3Q3m09Jci4xCH9MbKiX2KzxzvRgbwHgHI8tfLESbn4XnFnVMeM/uWd9crY2j1TPFg5ngSh3dgKIkRRKEbnIMhfL/JiZ1YzuGja/UAOSGEDp3H7DaS1qpGzzU2XwrJACZiDyZ10IZqybEi7h2Gfwb+3fEQxIF9rQdOUbrBvlM88wlB7UEeQJYORSPQphw5mw= X-Forefront-Antispam-Report: CIP:216.228.112.35; CTRY:US; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:mail.nvidia.com; PTR:schybrid04.nvidia.com; CAT:NONE; SFS:(4636009)(39860400002)(346002)(136003)(396003)(376002)(46966006)(36840700001)(6666004)(7696005)(110136005)(86362001)(1076003)(7416002)(107886003)(83380400001)(54906003)(36756003)(47076005)(8676002)(4326008)(36860700001)(336012)(26005)(8936002)(478600001)(70586007)(70206006)(2616005)(7636003)(5660300002)(82310400003)(36906005)(356005)(426003)(82740400003)(316002)(2906002)(186003); DIR:OUT; SFP:1101; X-OriginatorOrg: Nvidia.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 09 Apr 2021 13:44:07.8009 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 1923f28a-54d3-4e3f-2cbe-08d8fb5d8c84 X-MS-Exchange-CrossTenant-Id: 43083d15-7273-40c1-b7db-39efd9ccc17a X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=43083d15-7273-40c1-b7db-39efd9ccc17a; Ip=[216.228.112.35]; Helo=[mail.nvidia.com] X-MS-Exchange-CrossTenant-AuthSource: BN8NAM11FT032.eop-nam11.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM5PR1201MB2505 Received-SPF: softfail client-ip=40.107.223.62; envelope-from=targupta@nvidia.com; helo=NAM11-DM6-obe.outbound.protection.outlook.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: cjia@nvidia.com, quintela@redhat.com, dgilbert@redhat.com, yan.y.zhao@intel.com, lushenming@huawei.com, dnigam@nvidia.com, berrange@redhat.com, philmd@redhat.com, Tarun Gupta Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Sender: "Qemu-devel" Document interfaces used for VFIO device migration. Added flow of state changes during live migration with VFIO device. Co-developed-by: Kirti Wankhede Signed-off-by: Tarun Gupta Reviewed-by: Cornelia Huck --- Tested by building docs with new vfio-migration.rst file v4: - Added info about vfio_listener_log_global_[start|stop] - Added info about `save_state` callback. - Incorporated comments from v3. v3: - Add introductory line about VM migration in general. - Remove occurcences of vfio_pin_pages() to describe pinning. - Incorporated comments from v2 v2: - Included the new vfio-migration.rst file in index.rst - Updated dirty page tracking section, also added details about 'pre-copy-dirty-page-tracking' opt-out option. - Incorporated comments around wording of doc. MAINTAINERS | 1 + docs/devel/index.rst | 1 + docs/devel/vfio-migration.rst | 150 ++++++++++++++++++++++++++++++++++ 3 files changed, 152 insertions(+) create mode 100644 docs/devel/vfio-migration.rst diff --git a/MAINTAINERS b/MAINTAINERS index 554be84b32..40e28ea84a 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1826,6 +1826,7 @@ S: Supported F: hw/vfio/* F: include/hw/vfio/ F: docs/igd-assign.txt +F: docs/devel/vfio-migration.rst vfio-ccw M: Cornelia Huck diff --git a/docs/devel/index.rst b/docs/devel/index.rst index 7c424ea6d7..5e8ae580b0 100644 --- a/docs/devel/index.rst +++ b/docs/devel/index.rst @@ -40,3 +40,4 @@ Contents: qom block-coroutine-wrapper multi-process + vfio-migration diff --git a/docs/devel/vfio-migration.rst b/docs/devel/vfio-migration.rst new file mode 100644 index 0000000000..9ff6163c88 --- /dev/null +++ b/docs/devel/vfio-migration.rst @@ -0,0 +1,150 @@ +===================== +VFIO device Migration +===================== + +Migration of virtual machine involves saving the state for each device that +the guest is running on source host and restoring this saved state on the +destination host. This document details how saving and restoring of VFIO +devices is done in QEMU. + +Migration of VFIO devices consists of two phases: the optional pre-copy phase, +and the stop-and-copy phase. The pre-copy phase is iterative and allows to +accommodate VFIO devices that have a large amount of data that needs to be +transferred. The iterative pre-copy phase of migration allows for the guest to +continue whilst the VFIO device state is transferred to the destination, this +helps to reduce the total downtime of the VM. VFIO devices can choose to skip +the pre-copy phase of migration by returning pending_bytes as zero during the +pre-copy phase. + +A detailed description of the UAPI for VFIO device migration can be found in +the comment for the ``vfio_device_migration_info`` structure in the header +file linux-headers/linux/vfio.h. + +VFIO implements the device hooks for the iterative approach as follows: + +* A ``save_setup`` function that sets up the migration region and sets _SAVING + flag in the VFIO device state. + +* A ``load_setup`` function that sets up the migration region on the + destination and sets _RESUMING flag in the VFIO device state. + +* A ``save_live_pending`` function that reads pending_bytes from the vendor + driver, which indicates the amount of data that the vendor driver has yet to + save for the VFIO device. + +* A ``save_live_iterate`` function that reads the VFIO device's data from the + vendor driver through the migration region during iterative phase. + +* A ``save_state`` function to save the device config space if it is present. + +* A ``save_live_complete_precopy`` function that resets _RUNNING flag from the + VFIO device state and iteratively copies the remaining data for the VFIO + device until the vendor driver indicates that no data remains (pending bytes + is zero). + +* A ``load_state`` function that loads the config section and the data + sections that are generated by the save functions above + +* ``cleanup`` functions for both save and load that perform any migration + related cleanup, including unmapping the migration region + + +The VFIO migration code uses a VM state change handler to change the VFIO +device state when the VM state changes from running to not-running, and +vice versa. + +Similarly, a migration state change handler is used to trigger a transition of +the VFIO device state when certain changes of the migration state occur. For +example, the VFIO device state is transitioned back to _RUNNING in case a +migration failed or was canceled. + +System memory dirty pages tracking +---------------------------------- + +A ``log_global_start`` and ``log_global_stop`` memory listener callback informs +the VFIO IOMMU module to start and stop dirty page tracking. A ``log_sync`` +memory listener callback marks those system memory pages as dirty which are +used for DMA by the VFIO device. The dirty pages bitmap is queried per +container. All pages pinned by the vendor driver through external APIs have to +be marked as dirty during migration. When there are CPU writes, CPU dirty page +tracking can identify dirtied pages, but any page pinned by the vendor driver +can also be written by the device. There is currently no device or IOMMU +support for dirty page tracking in hardware. + +By default, dirty pages are tracked when the device is in pre-copy as well as +stop-and-copy phase. So, a page pinned by the vendor driver will be copied to +the destination in both phases. Copying dirty pages in pre-copy phase helps +QEMU to predict if it can achieve its downtime tolerances. If QEMU during +pre-copy phase keeps finding dirty pages continuously, then it understands +that even in stop-and-copy phase, it is likely to find dirty pages and can +predict the downtime accordingly. + +QEMU also provides a per device opt-out option ``pre-copy-dirty-page-tracking`` +which disables querying the dirty bitmap during pre-copy phase. If it is set to +off, all dirty pages will be copied to the destination in stop-and-copy phase +only. + +System memory dirty pages tracking when vIOMMU is enabled +--------------------------------------------------------- + +With vIOMMU, an IO virtual address range can get unmapped while in pre-copy +phase of migration. In that case, the unmap ioctl returns any dirty pages in +that range and QEMU reports corresponding guest physical pages dirty. During +stop-and-copy phase, an IOMMU notifier is used to get a callback for mapped +pages and then dirty pages bitmap is fetched from VFIO IOMMU modules for those +mapped ranges. + +Flow of state changes during Live migration +=========================================== + +Below is the flow of state change during live migration. +The values in the brackets represent the VM state, the migration state, and +the VFIO device state, respectively. + +Live migration save path +------------------------ + +:: + + QEMU normal running state + (RUNNING, _NONE, _RUNNING) + | + migrate_init spawns migration_thread + Migration thread then calls each device's .save_setup() + (RUNNING, _SETUP, _RUNNING|_SAVING) + | + (RUNNING, _ACTIVE, _RUNNING|_SAVING) + If device is active, get pending_bytes by .save_live_pending() + If total pending_bytes >= threshold_size, call .save_live_iterate() + Data of VFIO device for pre-copy phase is copied + Iterate till total pending bytes converge and are less than threshold + | + On migration completion, vCPU stops and calls .save_live_complete_precopy for + each active device. The VFIO device is then transitioned into _SAVING state + (FINISH_MIGRATE, _DEVICE, _SAVING) + | + For the VFIO device, iterate in .save_live_complete_precopy until + pending data is 0 + (FINISH_MIGRATE, _DEVICE, _STOPPED) + | + (FINISH_MIGRATE, _COMPLETED, _STOPPED) + Migraton thread schedules cleanup bottom half and exits + +Live migration resume path +-------------------------- + +:: + + Incoming migration calls .load_setup for each device + (RESTORE_VM, _ACTIVE, _STOPPED) + | + For each device, .load_state is called for that device section data + (RESTORE_VM, _ACTIVE, _RESUMING) + | + At the end, .load_cleanup is called for each device and vCPUs are started + (RUNNING, _NONE, _RUNNING) + +Postcopy +======== + +Postcopy migration is currently not supported for VFIO devices.