Add list_bitmaps command

lib/vdsm/API.py

@@ -1757,6 +1757,9 @@ def remove_bitmap(self, job_id, vol_info, bitmap):
     def clear_bitmaps(self, job_id, vol_info):
         return self._irs.sdm_clear_bitmaps(job_id, vol_info)
 
+    def list_bitmaps(self, job_id, vol_info):
+        return self._irs.sdm_list_bitmaps(job_id, vol_info)
+
 
 class Lease(APIBase):
     ctorArgs = []

lib/vdsm/api/vdsm-api.yml

@@ -7478,6 +7478,13 @@ types:
             type: boolean
             added: '4.5'
 
+        -   defaultvalue: false
+            description: Indicates whether listing volume bitmaps
+              is implemented in VDSM
+            name: list_bitmaps
+            type: boolean
+            added: '4.5.5'
+
         type: object
 
     VdsmNetworkCapabilities: &VdsmNetworkCapabilities
@@ -12606,6 +12613,19 @@ SDM.clear_bitmaps:
         name: vol_info
         type: *CopyDataDIVEndpoint
 
+SDM.list_bitmaps:
+    added: '4.5.5'
+    description: List all the bitmaps from the volume.
+        Allowed only for a volume with qcow2 format.
+    params:
+    -   description: A UUID to be used for tracking the job progress
+        name: job_id
+        type: *UUID
+
+    -   description: The volume to list the bitmap from.
+        name: vol_info
+        type: *CopyDataDIVEndpoint
+
 NBD.start_server:
     added: '4.3'
     description: Start serving a volume using NBD protocol. Fail if the service

lib/vdsm/host/caps.py

@@ -175,6 +175,7 @@ def get():
     caps['measure_active'] = True
     caps['mailbox_events'] = config.getboolean("mailbox", "events_enable")
     caps['zerocopy_migrations'] = hasattr(libvirt, 'VIR_MIGRATE_ZEROCOPY')
+    caps['list_bitmaps'] = True
 
     return caps
 

lib/vdsm/storage/bitmaps.py

@@ -168,6 +168,17 @@ def clear_bitmaps(vol_path):
                 vol_path=vol_path)
 
 
+def list_bitmaps(vol_path):
+    """
+    List bitmaps to the given volume path
+
+    Arguments:
+        vol_path (str): Path to the volume
+    """
+    bitmaps = _query_bitmaps(vol_path)
+    return bitmaps
+
+
 def _add_bitmap(vol_path, bitmap, granularity=None, enable=True):
     log.info("Add bitmap %s to %r", bitmap, vol_path)
 

lib/vdsm/storage/hsm.py

@@ -78,6 +78,7 @@
     add_bitmap,
     copy_data,
     clear_bitmaps,
+    list_bitmaps,
     merge as api_merge,
     move_device,
     reduce_domain,
@@ -3492,6 +3493,20 @@ def sdm_clear_bitmaps(self, job_id, vol_info):
         job = clear_bitmaps.Job(job_id, self._pool.id, vol_info)
         self.sdm_schedule(job)
 
+    @public
+    def sdm_list_bitmaps(self, job_id, vol_info):
+        """
+        List all the bitmaps from the given volume.
+
+        Arguments:
+            job_id (str):  The UUID of the job.
+            vol_info (dict): Dictionary that contains all the needed info
+                on the volume.
+        """
+        job = list_bitmaps.Job(job_id, self._pool.id, vol_info)
+        self.sdm_schedule(job)
+        return dict(uuidlist=bitmaps)
+
     # Lease operations
 
     @public

lib/vdsm/storage/sdm/api/Makefile.am

@@ -12,6 +12,7 @@ dist_vdsmsdmapi_PYTHON = \
 	base.py \
 	copy_data.py \
 	clear_bitmaps.py \
+	list_bitmaps.py \
 	merge.py \
 	move_device.py \
 	reduce_domain.py \

lib/vdsm/storage/sdm/api/list_bitmaps.py

@@ -0,0 +1,35 @@
+# SPDX-FileCopyrightText: Red Hat, Inc.
+# SPDX-License-Identifier: GPL-2.0-or-later
+
+from vdsm.storage import bitmaps
+from vdsm.storage import constants as sc
+from vdsm.storage import exception as se
+from vdsm.storage import guarded
+from vdsm.storage.sdm.volume_info import VolumeInfo
+
+from . import base
+
+
+class Job(base.Job):
+
+    def __init__(self, job_id, host_id, vol_info):
+        super(Job, self).__init__(job_id, 'list_bitmaps', host_id)
+        self._vol_info = VolumeInfo(vol_info, host_id)
+        self._bitmaps = None
+
+    def _validate(self):
+        if self._vol_info.volume.getFormat() != sc.COW_FORMAT:
+            raise se.UnsupportedOperation(
+                "Volume is not in COW format",
+                vol_uuid=self._vol_info.vol_id)
+
+    def _run(self):
+        with guarded.context(self._vol_info.locks):
+            self._validate()
+            with self._vol_info.prepare():
+                with self._vol_info.volume_operation():
+                    self._bitmaps = bitmaps.list_bitmaps(self._vol_info.path)
+
+    @property
+    def bitmaps(self):
+        return self._bitmaps

tests/storage/bitmaps_test.py

@@ -333,3 +333,26 @@ def test_clear_bitmaps_failed(monkeypatch, tmp_mount, vol_chain):
     monkeypatch.setattr(qemuimg, "bitmap_remove", qemuimg_failure)
     with pytest.raises(exception.RemoveBitmapError):
         bitmaps.clear_bitmaps(vol_chain.top_vol)
+
+
+def test_list_bitmaps(tmp_mount, vol_chain):
+    # Add new bitmaps to top volume
+    for bitmap in ['bitmap_1', 'bitmap_2']:
+        op = qemuimg.bitmap_add(vol_chain.top_vol, bitmap)
+        op.run()
+
+    uuids = bitmaps.list_bitmaps(vol_chain.top_vol)
+    assert uuids == ['bitmap_1', 'bitmap_2']
+
+
+def test_list_bitmaps_empty(tmp_mount, vol_chain):
+    # Add new bitmaps to top volume
+    for bitmap in ['bitmap_1', 'bitmap_2']:
+        op = qemuimg.bitmap_add(vol_chain.top_vol, bitmap)
+        op.run()
+
+    # Clear top volume bitmaps
+    bitmaps.clear_bitmaps(vol_chain.top_vol)
+
+    uuids = bitmaps.list_bitmaps(vol_chain.top_vol)
+    assert uuids == []

tests/storage/sdm_clear_bitmaps_test.py

@@ -28,7 +28,7 @@
 from vdsm.storage import guarded
 from vdsm.storage import qemuimg
 from vdsm.storage.sdm import volume_info
-from vdsm.storage.sdm.api import clear_bitmaps
+from vdsm.storage.sdm.api import clear_bitmaps, list_bitmaps
 
 
 def failure(*args, **kwargs):