tests/qemu-iotests/040

   1 #!/usr/bin/env python
   2 #
   3 # Tests for image block commit.
   4 #
   5 # Copyright (C) 2012 IBM, Corp.
   6 # Copyright (C) 2012 Red Hat, Inc.
   7 #
   8 # This program is free software; you can redistribute it and/or modify
   9 # it under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation; either version 2 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # This program is distributed in the hope that it will be useful,
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 #
  21 # Test for live block commit
  22 # Derived from Image Streaming Test 030
  23
  24 import time
  25 import os
  26 import iotests
  27 from iotests import qemu_img, qemu_io
  28 import struct
  29 import errno
  30
  31 backing_img = os.path.join(iotests.test_dir, 'backing.img')
  32 mid_img = os.path.join(iotests.test_dir, 'mid.img')
  33 test_img = os.path.join(iotests.test_dir, 'test.img')
  34
  35 class ImageCommitTestCase(iotests.QMPTestCase):
  36     '''Abstract base class for image commit test cases'''
  37
  38     def wait_for_complete(self, need_ready=False):
  39         completed = False
  40         ready = False
  41         while not completed:
  42             for event in self.vm.get_qmp_events(wait=True):
  43                 if event['event'] == 'BLOCK_JOB_COMPLETED':
  44                     self.assert_qmp_absent(event, 'data/error')
  45                     self.assert_qmp(event, 'data/type', 'commit')
  46                     self.assert_qmp(event, 'data/device', 'drive0')
  47                     self.assert_qmp(event, 'data/offset', event['data']['len'])
  48                     if need_ready:
  49                         self.assertTrue(ready, "Expecting BLOCK_JOB_COMPLETED event")
  50                     completed = True
  51                 elif event['event'] == 'BLOCK_JOB_READY':
  52                     ready = True
  53                     self.assert_qmp(event, 'data/type', 'commit')
  54                     self.assert_qmp(event, 'data/device', 'drive0')
  55                     self.vm.qmp('block-job-complete', device='drive0')
  56
  57         self.assert_no_active_block_jobs()
  58         self.vm.shutdown()
  59
  60     def run_commit_test(self, top, base, need_ready=False):
  61         self.assert_no_active_block_jobs()
  62         result = self.vm.qmp('block-commit', device='drive0', top=top, base=base)
  63         self.assert_qmp(result, 'return', {})
  64         self.wait_for_complete(need_ready)
  65
  66     def run_default_commit_test(self):
  67         self.assert_no_active_block_jobs()
  68         result = self.vm.qmp('block-commit', device='drive0')
  69         self.assert_qmp(result, 'return', {})
  70         self.wait_for_complete()
  71
  72 class TestSingleDrive(ImageCommitTestCase):
  73     # Need some space after the copied data so that throttling is effective in
  74     # tests that use it rather than just completing the job immediately
  75     image_len = 2 * 1024 * 1024
  76     test_len = 1 * 1024 * 256
  77
  78     def setUp(self):
  79         iotests.create_image(backing_img, self.image_len)
  80         qemu_img('create', '-f', iotests.imgfmt, '-o', 'backing_file=%s' % backing_img, mid_img)
  81         qemu_img('create', '-f', iotests.imgfmt, '-o', 'backing_file=%s' % mid_img, test_img)
  82         qemu_io('-f', 'raw', '-c', 'write -P 0xab 0 524288', backing_img)
  83         qemu_io('-f', iotests.imgfmt, '-c', 'write -P 0xef 524288 524288', mid_img)
  84         self.vm = iotests.VM().add_drive(test_img, "node-name=top,backing.node-name=mid,backing.backing.node-name=base", interface="none")
  85         self.vm.add_device("virtio-scsi-pci")
  86         self.vm.add_device("scsi-hd,id=scsi0,drive=drive0")
  87         self.vm.launch()
  88
  89     def tearDown(self):
  90         self.vm.shutdown()
  91         os.remove(test_img)
  92         os.remove(mid_img)
  93         os.remove(backing_img)
  94
  95     def test_commit(self):
  96         self.run_commit_test(mid_img, backing_img)
  97         self.assertEqual(-1, qemu_io('-f', 'raw', '-c', 'read -P 0xab 0 524288', backing_img).find("verification failed"))
  98         self.assertEqual(-1, qemu_io('-f', 'raw', '-c', 'read -P 0xef 524288 524288', backing_img).find("verification failed"))
  99
 100     def test_device_not_found(self):
 101         result = self.vm.qmp('block-commit', device='nonexistent', top='%s' % mid_img)
 102         self.assert_qmp(result, 'error/class', 'DeviceNotFound')
 103
 104     def test_top_same_base(self):
 105         self.assert_no_active_block_jobs()
 106         result = self.vm.qmp('block-commit', device='drive0', top='%s' % backing_img, base='%s' % backing_img)
 107         self.assert_qmp(result, 'error/class', 'GenericError')
 108         self.assert_qmp(result, 'error/desc', 'Base \'%s\' not found' % backing_img)
 109
 110     def test_top_invalid(self):
 111         self.assert_no_active_block_jobs()
 112         result = self.vm.qmp('block-commit', device='drive0', top='badfile', base='%s' % backing_img)
 113         self.assert_qmp(result, 'error/class', 'GenericError')
 114         self.assert_qmp(result, 'error/desc', 'Top image file badfile not found')
 115
 116     def test_base_invalid(self):
 117         self.assert_no_active_block_jobs()
 118         result = self.vm.qmp('block-commit', device='drive0', top='%s' % mid_img, base='badfile')
 119         self.assert_qmp(result, 'error/class', 'GenericError')
 120         self.assert_qmp(result, 'error/desc', 'Base \'badfile\' not found')
 121
 122     def test_top_is_active(self):
 123         self.run_commit_test(test_img, backing_img, need_ready=True)
 124         self.assertEqual(-1, qemu_io('-f', 'raw', '-c', 'read -P 0xab 0 524288', backing_img).find("verification failed"))
 125         self.assertEqual(-1, qemu_io('-f', 'raw', '-c', 'read -P 0xef 524288 524288', backing_img).find("verification failed"))
 126
 127     def test_top_is_default_active(self):
 128         self.run_default_commit_test()
 129         self.assertEqual(-1, qemu_io('-f', 'raw', '-c', 'read -P 0xab 0 524288', backing_img).find("verification failed"))
 130         self.assertEqual(-1, qemu_io('-f', 'raw', '-c', 'read -P 0xef 524288 524288', backing_img).find("verification failed"))
 131
 132     def test_top_and_base_reversed(self):
 133         self.assert_no_active_block_jobs()
 134         result = self.vm.qmp('block-commit', device='drive0', top='%s' % backing_img, base='%s' % mid_img)
 135         self.assert_qmp(result, 'error/class', 'GenericError')
 136         self.assert_qmp(result, 'error/desc', 'Base \'%s\' not found' % mid_img)
 137
 138     # When the job is running on a BB that is automatically deleted on hot
 139     # unplug, the job is cancelled when the device disappears
 140     def test_hot_unplug(self):
 141         if self.image_len == 0:
 142             return
 143
 144         self.assert_no_active_block_jobs()
 145         result = self.vm.qmp('block-commit', device='drive0', top=mid_img,
 146                              base=backing_img, speed=(self.image_len / 4))
 147         self.assert_qmp(result, 'return', {})
 148         result = self.vm.qmp('device_del', id='scsi0')
 149         self.assert_qmp(result, 'return', {})
 150
 151         cancelled = False
 152         deleted = False
 153         while not cancelled or not deleted:
 154             for event in self.vm.get_qmp_events(wait=True):
 155                 if event['event'] == 'DEVICE_DELETED':
 156                     self.assert_qmp(event, 'data/device', 'scsi0')
 157                     deleted = True
 158                 elif event['event'] == 'BLOCK_JOB_CANCELLED':
 159                     self.assert_qmp(event, 'data/device', 'drive0')
 160                     cancelled = True
 161                 else:
 162                     self.fail("Unexpected event %s" % (event['event']))
 163
 164         self.assert_no_active_block_jobs()
 165
 166     # Tests that the insertion of the commit_top filter node doesn't make a
 167     # difference to query-blockstat
 168     def test_implicit_node(self):
 169         if self.image_len == 0:
 170             return
 171
 172         self.assert_no_active_block_jobs()
 173         result = self.vm.qmp('block-commit', device='drive0', top=mid_img,
 174                              base=backing_img, speed=(self.image_len / 4))
 175         self.assert_qmp(result, 'return', {})
 176
 177         result = self.vm.qmp('query-block')
 178         self.assert_qmp(result, 'return[0]/inserted/file', test_img)
 179         self.assert_qmp(result, 'return[0]/inserted/drv', iotests.imgfmt)
 180         self.assert_qmp(result, 'return[0]/inserted/backing_file', mid_img)
 181         self.assert_qmp(result, 'return[0]/inserted/backing_file_depth', 2)
 182         self.assert_qmp(result, 'return[0]/inserted/image/filename', test_img)
 183         self.assert_qmp(result, 'return[0]/inserted/image/backing-image/filename', mid_img)
 184         self.assert_qmp(result, 'return[0]/inserted/image/backing-image/backing-image/filename', backing_img)
 185
 186         result = self.vm.qmp('query-blockstats')
 187         self.assert_qmp(result, 'return[0]/node-name', 'top')
 188         self.assert_qmp(result, 'return[0]/backing/node-name', 'mid')
 189         self.assert_qmp(result, 'return[0]/backing/backing/node-name', 'base')
 190
 191         self.cancel_and_wait()
 192         self.assert_no_active_block_jobs()
 193
 194 class TestRelativePaths(ImageCommitTestCase):
 195     image_len = 1 * 1024 * 1024
 196     test_len = 1 * 1024 * 256
 197
 198     dir1 = "dir1"
 199     dir2 = "dir2/"
 200     dir3 = "dir2/dir3/"
 201
 202     test_img = os.path.join(iotests.test_dir, dir3, 'test.img')
 203     mid_img = "../mid.img"
 204     backing_img = "../dir1/backing.img"
 205
 206     backing_img_abs = os.path.join(iotests.test_dir, dir1, 'backing.img')
 207     mid_img_abs = os.path.join(iotests.test_dir, dir2, 'mid.img')
 208
 209     def setUp(self):
 210         try:
 211             os.mkdir(os.path.join(iotests.test_dir, self.dir1))
 212             os.mkdir(os.path.join(iotests.test_dir, self.dir2))
 213             os.mkdir(os.path.join(iotests.test_dir, self.dir3))
 214         except OSError as exception:
 215             if exception.errno != errno.EEXIST:
 216                 raise
 217         iotests.create_image(self.backing_img_abs, TestRelativePaths.image_len)
 218         qemu_img('create', '-f', iotests.imgfmt, '-o', 'backing_file=%s' % self.backing_img_abs, self.mid_img_abs)
 219         qemu_img('create', '-f', iotests.imgfmt, '-o', 'backing_file=%s' % self.mid_img_abs, self.test_img)
 220         qemu_img('rebase', '-u', '-b', self.backing_img, self.mid_img_abs)
 221         qemu_img('rebase', '-u', '-b', self.mid_img, self.test_img)
 222         qemu_io('-f', 'raw', '-c', 'write -P 0xab 0 524288', self.backing_img_abs)
 223         qemu_io('-f', iotests.imgfmt, '-c', 'write -P 0xef 524288 524288', self.mid_img_abs)
 224         self.vm = iotests.VM().add_drive(self.test_img)
 225         self.vm.launch()
 226
 227     def tearDown(self):
 228         self.vm.shutdown()
 229         os.remove(self.test_img)
 230         os.remove(self.mid_img_abs)
 231         os.remove(self.backing_img_abs)
 232         try:
 233             os.rmdir(os.path.join(iotests.test_dir, self.dir1))
 234             os.rmdir(os.path.join(iotests.test_dir, self.dir3))
 235             os.rmdir(os.path.join(iotests.test_dir, self.dir2))
 236         except OSError as exception:
 237             if exception.errno != errno.EEXIST and exception.errno != errno.ENOTEMPTY:
 238                 raise
 239
 240     def test_commit(self):
 241         self.run_commit_test(self.mid_img, self.backing_img)
 242         self.assertEqual(-1, qemu_io('-f', 'raw', '-c', 'read -P 0xab 0 524288', self.backing_img_abs).find("verification failed"))
 243         self.assertEqual(-1, qemu_io('-f', 'raw', '-c', 'read -P 0xef 524288 524288', self.backing_img_abs).find("verification failed"))
 244
 245     def test_device_not_found(self):
 246         result = self.vm.qmp('block-commit', device='nonexistent', top='%s' % self.mid_img)
 247         self.assert_qmp(result, 'error/class', 'DeviceNotFound')
 248
 249     def test_top_same_base(self):
 250         self.assert_no_active_block_jobs()
 251         result = self.vm.qmp('block-commit', device='drive0', top='%s' % self.mid_img, base='%s' % self.mid_img)
 252         self.assert_qmp(result, 'error/class', 'GenericError')
 253         self.assert_qmp(result, 'error/desc', 'Base \'%s\' not found' % self.mid_img)
 254
 255     def test_top_invalid(self):
 256         self.assert_no_active_block_jobs()
 257         result = self.vm.qmp('block-commit', device='drive0', top='badfile', base='%s' % self.backing_img)
 258         self.assert_qmp(result, 'error/class', 'GenericError')
 259         self.assert_qmp(result, 'error/desc', 'Top image file badfile not found')
 260
 261     def test_base_invalid(self):
 262         self.assert_no_active_block_jobs()
 263         result = self.vm.qmp('block-commit', device='drive0', top='%s' % self.mid_img, base='badfile')
 264         self.assert_qmp(result, 'error/class', 'GenericError')
 265         self.assert_qmp(result, 'error/desc', 'Base \'badfile\' not found')
 266
 267     def test_top_is_active(self):
 268         self.run_commit_test(self.test_img, self.backing_img)
 269         self.assertEqual(-1, qemu_io('-f', 'raw', '-c', 'read -P 0xab 0 524288', self.backing_img_abs).find("verification failed"))
 270         self.assertEqual(-1, qemu_io('-f', 'raw', '-c', 'read -P 0xef 524288 524288', self.backing_img_abs).find("verification failed"))
 271
 272     def test_top_and_base_reversed(self):
 273         self.assert_no_active_block_jobs()
 274         result = self.vm.qmp('block-commit', device='drive0', top='%s' % self.backing_img, base='%s' % self.mid_img)
 275         self.assert_qmp(result, 'error/class', 'GenericError')
 276         self.assert_qmp(result, 'error/desc', 'Base \'%s\' not found' % self.mid_img)
 277
 278
 279 class TestSetSpeed(ImageCommitTestCase):
 280     image_len = 80 * 1024 * 1024 # MB
 281
 282     def setUp(self):
 283         qemu_img('create', backing_img, str(TestSetSpeed.image_len))
 284         qemu_img('create', '-f', iotests.imgfmt, '-o', 'backing_file=%s' % backing_img, mid_img)
 285         qemu_img('create', '-f', iotests.imgfmt, '-o', 'backing_file=%s' % mid_img, test_img)
 286         qemu_io('-f', iotests.imgfmt, '-c', 'write -P 0x1 0 512', test_img)
 287         qemu_io('-f', iotests.imgfmt, '-c', 'write -P 0xef 524288 524288', mid_img)
 288         self.vm = iotests.VM().add_drive(test_img)
 289         self.vm.launch()
 290
 291     def tearDown(self):
 292         self.vm.shutdown()
 293         os.remove(test_img)
 294         os.remove(mid_img)
 295         os.remove(backing_img)
 296
 297     def test_set_speed(self):
 298         self.assert_no_active_block_jobs()
 299
 300         self.vm.pause_drive('drive0')
 301         result = self.vm.qmp('block-commit', device='drive0', top=mid_img, speed=1024 * 1024)
 302         self.assert_qmp(result, 'return', {})
 303
 304         # Ensure the speed we set was accepted
 305         result = self.vm.qmp('query-block-jobs')
 306         self.assert_qmp(result, 'return[0]/device', 'drive0')
 307         self.assert_qmp(result, 'return[0]/speed', 1024 * 1024)
 308
 309         self.cancel_and_wait(resume=True)
 310
 311 class TestActiveZeroLengthImage(TestSingleDrive):
 312     image_len = 0
 313
 314 class TestReopenOverlay(ImageCommitTestCase):
 315     image_len = 1024 * 1024
 316     img0 = os.path.join(iotests.test_dir, '0.img')
 317     img1 = os.path.join(iotests.test_dir, '1.img')
 318     img2 = os.path.join(iotests.test_dir, '2.img')
 319     img3 = os.path.join(iotests.test_dir, '3.img')
 320
 321     def setUp(self):
 322         iotests.create_image(self.img0, self.image_len)
 323         qemu_img('create', '-f', iotests.imgfmt, '-o', 'backing_file=%s' % self.img0, self.img1)
 324         qemu_img('create', '-f', iotests.imgfmt, '-o', 'backing_file=%s' % self.img1, self.img2)
 325         qemu_img('create', '-f', iotests.imgfmt, '-o', 'backing_file=%s' % self.img2, self.img3)
 326         qemu_io('-f', iotests.imgfmt, '-c', 'write -P 0xab 0 128K', self.img1)
 327         self.vm = iotests.VM().add_drive(self.img3)
 328         self.vm.launch()
 329
 330     def tearDown(self):
 331         self.vm.shutdown()
 332         os.remove(self.img0)
 333         os.remove(self.img1)
 334         os.remove(self.img2)
 335         os.remove(self.img3)
 336
 337     # This tests what happens when the overlay image of the 'top' node
 338     # needs to be reopened in read-write mode in order to update the
 339     # backing image string.
 340     def test_reopen_overlay(self):
 341         self.run_commit_test(self.img1, self.img0)
 342
 343 if __name__ == '__main__':
 344     iotests.main(supported_fmts=['qcow2', 'qed'])