1#!/usr/bin/env python3 2# group: rw backing 3# 4# Tests for image streaming. 5# 6# Copyright (C) 2012 IBM Corp. 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 22import time 23import os 24import iotests 25import unittest 26from iotests import qemu_img, qemu_io 27 28backing_img = os.path.join(iotests.test_dir, 'backing.img') 29mid_img = os.path.join(iotests.test_dir, 'mid.img') 30test_img = os.path.join(iotests.test_dir, 'test.img') 31 32class TestSingleDrive(iotests.QMPTestCase): 33 image_len = 1 * 1024 * 1024 # MB 34 35 def setUp(self): 36 iotests.create_image(backing_img, TestSingleDrive.image_len) 37 qemu_img('create', '-f', iotests.imgfmt, 38 '-o', 'backing_file=%s' % backing_img, 39 '-F', 'raw', mid_img) 40 qemu_img('create', '-f', iotests.imgfmt, 41 '-o', 'backing_file=%s' % mid_img, 42 '-F', iotests.imgfmt, test_img) 43 qemu_io('-f', 'raw', '-c', 'write -P 0x1 0 512', backing_img) 44 qemu_io('-f', iotests.imgfmt, '-c', 'write -P 0x1 524288 512', mid_img) 45 self.vm = iotests.VM().add_drive("blkdebug::" + test_img, 46 "backing.node-name=mid," + 47 "backing.backing.node-name=base") 48 self.vm.launch() 49 50 def tearDown(self): 51 self.vm.shutdown() 52 os.remove(test_img) 53 os.remove(mid_img) 54 os.remove(backing_img) 55 56 def test_stream(self): 57 self.assert_no_active_block_jobs() 58 59 result = self.vm.qmp('block-stream', device='drive0') 60 self.assert_qmp(result, 'return', {}) 61 62 self.wait_until_completed() 63 64 self.assert_no_active_block_jobs() 65 self.vm.shutdown() 66 67 self.assertEqual(qemu_io('-f', 'raw', '-c', 'map', backing_img), 68 qemu_io('-f', iotests.imgfmt, '-c', 'map', test_img), 69 'image file map does not match backing file after streaming') 70 71 def test_stream_intermediate(self): 72 self.assert_no_active_block_jobs() 73 74 self.assertNotEqual(qemu_io('-f', 'raw', '-rU', '-c', 'map', backing_img), 75 qemu_io('-f', iotests.imgfmt, '-rU', '-c', 'map', mid_img), 76 'image file map matches backing file before streaming') 77 78 result = self.vm.qmp('block-stream', device='mid', job_id='stream-mid') 79 self.assert_qmp(result, 'return', {}) 80 81 self.wait_until_completed(drive='stream-mid') 82 83 self.assert_no_active_block_jobs() 84 self.vm.shutdown() 85 86 self.assertEqual(qemu_io('-f', 'raw', '-c', 'map', backing_img), 87 qemu_io('-f', iotests.imgfmt, '-c', 'map', mid_img), 88 'image file map does not match backing file after streaming') 89 90 def test_stream_pause(self): 91 self.assert_no_active_block_jobs() 92 93 self.vm.pause_drive('drive0') 94 result = self.vm.qmp('block-stream', device='drive0') 95 self.assert_qmp(result, 'return', {}) 96 97 self.pause_job('drive0', wait=False) 98 self.vm.resume_drive('drive0') 99 self.pause_wait('drive0') 100 101 result = self.vm.qmp('query-block-jobs') 102 offset = self.dictpath(result, 'return[0]/offset') 103 104 time.sleep(0.5) 105 result = self.vm.qmp('query-block-jobs') 106 self.assert_qmp(result, 'return[0]/offset', offset) 107 108 result = self.vm.qmp('block-job-resume', device='drive0') 109 self.assert_qmp(result, 'return', {}) 110 111 self.wait_until_completed() 112 113 self.assert_no_active_block_jobs() 114 self.vm.shutdown() 115 116 self.assertEqual(qemu_io('-f', 'raw', '-c', 'map', backing_img), 117 qemu_io('-f', iotests.imgfmt, '-c', 'map', test_img), 118 'image file map does not match backing file after streaming') 119 120 def test_stream_no_op(self): 121 self.assert_no_active_block_jobs() 122 123 # The image map is empty before the operation 124 empty_map = qemu_io('-f', iotests.imgfmt, '-rU', '-c', 'map', test_img) 125 126 # This is a no-op: no data should ever be copied from the base image 127 result = self.vm.qmp('block-stream', device='drive0', base=mid_img) 128 self.assert_qmp(result, 'return', {}) 129 130 self.wait_until_completed() 131 132 self.assert_no_active_block_jobs() 133 self.vm.shutdown() 134 135 self.assertEqual(qemu_io('-f', iotests.imgfmt, '-c', 'map', test_img), 136 empty_map, 'image file map changed after a no-op') 137 138 def test_stream_partial(self): 139 self.assert_no_active_block_jobs() 140 141 result = self.vm.qmp('block-stream', device='drive0', base=backing_img) 142 self.assert_qmp(result, 'return', {}) 143 144 self.wait_until_completed() 145 146 self.assert_no_active_block_jobs() 147 self.vm.shutdown() 148 149 self.assertEqual(qemu_io('-f', iotests.imgfmt, '-c', 'map', mid_img), 150 qemu_io('-f', iotests.imgfmt, '-c', 'map', test_img), 151 'image file map does not match backing file after streaming') 152 153 def test_device_not_found(self): 154 result = self.vm.qmp('block-stream', device='nonexistent') 155 self.assert_qmp(result, 'error/desc', 156 'Cannot find device=\'nonexistent\' nor node-name=\'nonexistent\'') 157 158 def test_job_id_missing(self): 159 result = self.vm.qmp('block-stream', device='mid') 160 self.assert_qmp(result, 'error/desc', "Invalid job ID ''") 161 162 def test_read_only(self): 163 # Create a new file that we can attach (we need a read-only top) 164 with iotests.FilePath('ro-top.img') as ro_top_path: 165 qemu_img('create', '-f', iotests.imgfmt, ro_top_path, 166 str(self.image_len)) 167 168 result = self.vm.qmp('blockdev-add', 169 node_name='ro-top', 170 driver=iotests.imgfmt, 171 read_only=True, 172 file={ 173 'driver': 'file', 174 'filename': ro_top_path, 175 'read-only': True 176 }, 177 backing='mid') 178 self.assert_qmp(result, 'return', {}) 179 180 result = self.vm.qmp('block-stream', job_id='stream', 181 device='ro-top', base_node='base') 182 self.assert_qmp(result, 'error/desc', 'Block node is read-only') 183 184 result = self.vm.qmp('blockdev-del', node_name='ro-top') 185 self.assert_qmp(result, 'return', {}) 186 187 188class TestParallelOps(iotests.QMPTestCase): 189 num_ops = 4 # Number of parallel block-stream operations 190 num_imgs = num_ops * 2 + 1 191 image_len = num_ops * 4 * 1024 * 1024 192 imgs = [] 193 194 def setUp(self): 195 opts = [] 196 self.imgs = [] 197 198 # Initialize file names and command-line options 199 for i in range(self.num_imgs): 200 img_depth = self.num_imgs - i - 1 201 opts.append("backing." * img_depth + "node-name=node%d" % i) 202 self.imgs.append(os.path.join(iotests.test_dir, 'img-%d.img' % i)) 203 204 # Create all images 205 iotests.create_image(self.imgs[0], self.image_len) 206 for i in range(1, self.num_imgs): 207 qemu_img('create', '-f', iotests.imgfmt, 208 '-o', 'backing_file=%s' % self.imgs[i-1], 209 '-F', 'raw' if i == 1 else iotests.imgfmt, self.imgs[i]) 210 211 # Put data into the images we are copying data from 212 odd_img_indexes = [x for x in reversed(range(self.num_imgs)) if x % 2 == 1] 213 for i in range(len(odd_img_indexes)): 214 # Alternate between 2MB and 4MB. 215 # This way jobs will not finish in the same order they were created 216 num_mb = 2 + 2 * (i % 2) 217 qemu_io('-f', iotests.imgfmt, 218 '-c', 'write -P 0xFF %dM %dM' % (i * 4, num_mb), 219 self.imgs[odd_img_indexes[i]]) 220 221 # Attach the drive to the VM 222 self.vm = iotests.VM() 223 self.vm.add_drive(self.imgs[-1], ','.join(opts)) 224 self.vm.launch() 225 226 def tearDown(self): 227 self.vm.shutdown() 228 for img in self.imgs: 229 os.remove(img) 230 231 # Test that it's possible to run several block-stream operations 232 # in parallel in the same snapshot chain 233 @unittest.skipIf(os.environ.get('QEMU_CHECK_BLOCK_AUTO'), 'disabled in CI') 234 def test_stream_parallel(self): 235 self.assert_no_active_block_jobs() 236 237 # Check that the maps don't match before the streaming operations 238 for i in range(2, self.num_imgs, 2): 239 self.assertNotEqual(qemu_io('-f', iotests.imgfmt, '-rU', '-c', 'map', self.imgs[i]), 240 qemu_io('-f', iotests.imgfmt, '-rU', '-c', 'map', self.imgs[i-1]), 241 'image file map matches backing file before streaming') 242 243 # Create all streaming jobs 244 pending_jobs = [] 245 for i in range(2, self.num_imgs, 2): 246 node_name = 'node%d' % i 247 job_id = 'stream-%s' % node_name 248 pending_jobs.append(job_id) 249 result = self.vm.qmp('block-stream', device=node_name, 250 job_id=job_id, bottom=f'node{i-1}', 251 speed=1024) 252 self.assert_qmp(result, 'return', {}) 253 254 # Do this in reverse: After unthrottling them, some jobs may finish 255 # before we have unthrottled all of them. This will drain their 256 # subgraph, and this will make jobs above them advance (despite those 257 # jobs on top being throttled). In the worst case, all jobs below the 258 # top one are finished before we can unthrottle it, and this makes it 259 # advance so far that it completes before we can unthrottle it - which 260 # results in an error. 261 # Starting from the top (i.e. in reverse) does not have this problem: 262 # When a job finishes, the ones below it are not advanced. 263 for job in reversed(pending_jobs): 264 result = self.vm.qmp('block-job-set-speed', device=job, speed=0) 265 self.assert_qmp(result, 'return', {}) 266 267 # Wait for all jobs to be finished. 268 while len(pending_jobs) > 0: 269 for event in self.vm.get_qmp_events(wait=True): 270 if event['event'] == 'BLOCK_JOB_COMPLETED': 271 job_id = self.dictpath(event, 'data/device') 272 self.assertTrue(job_id in pending_jobs) 273 self.assert_qmp_absent(event, 'data/error') 274 pending_jobs.remove(job_id) 275 276 self.assert_no_active_block_jobs() 277 self.vm.shutdown() 278 279 # Check that all maps match now 280 for i in range(2, self.num_imgs, 2): 281 self.assertEqual(qemu_io('-f', iotests.imgfmt, '-c', 'map', self.imgs[i]), 282 qemu_io('-f', iotests.imgfmt, '-c', 'map', self.imgs[i-1]), 283 'image file map does not match backing file after streaming') 284 285 # Test that it's not possible to perform two block-stream 286 # operations if there are nodes involved in both. 287 def test_overlapping_1(self): 288 self.assert_no_active_block_jobs() 289 290 # Set a speed limit to make sure that this job blocks the rest 291 result = self.vm.qmp('block-stream', device='node4', 292 job_id='stream-node4', base=self.imgs[1], 293 filter_node_name='stream-filter', speed=1024*1024) 294 self.assert_qmp(result, 'return', {}) 295 296 result = self.vm.qmp('block-stream', device='node5', job_id='stream-node5', base=self.imgs[2]) 297 self.assert_qmp(result, 'error/desc', 298 "Node 'stream-filter' is busy: block device is in use by block job: stream") 299 300 result = self.vm.qmp('block-stream', device='node3', job_id='stream-node3', base=self.imgs[2]) 301 self.assert_qmp(result, 'error/desc', 302 "Node 'node3' is busy: block device is in use by block job: stream") 303 304 result = self.vm.qmp('block-stream', device='node4', job_id='stream-node4-v2') 305 self.assert_qmp(result, 'error/desc', 306 "Node 'node4' is busy: block device is in use by block job: stream") 307 308 # block-commit should also fail if it touches nodes used by the stream job 309 result = self.vm.qmp('block-commit', device='drive0', base=self.imgs[4], job_id='commit-node4') 310 self.assert_qmp(result, 'error/desc', 311 "Node 'stream-filter' is busy: block device is in use by block job: stream") 312 313 result = self.vm.qmp('block-commit', device='drive0', base=self.imgs[1], top=self.imgs[3], job_id='commit-node1') 314 self.assert_qmp(result, 'error/desc', 315 "Node 'node3' is busy: block device is in use by block job: stream") 316 317 # This fails because it needs to modify the backing string in node2, which is blocked 318 result = self.vm.qmp('block-commit', device='drive0', base=self.imgs[0], top=self.imgs[1], job_id='commit-node0') 319 self.assert_qmp(result, 'error/desc', 320 "Node 'node2' is busy: block device is in use by block job: stream") 321 322 result = self.vm.qmp('block-job-set-speed', device='stream-node4', speed=0) 323 self.assert_qmp(result, 'return', {}) 324 325 self.wait_until_completed(drive='stream-node4') 326 self.assert_no_active_block_jobs() 327 328 # Similar to test_overlapping_1, but with block-commit 329 # blocking the other jobs 330 def test_overlapping_2(self): 331 self.assertLessEqual(9, self.num_imgs) 332 self.assert_no_active_block_jobs() 333 334 # Set a speed limit to make sure that this job blocks the rest 335 result = self.vm.qmp('block-commit', device='drive0', top=self.imgs[5], base=self.imgs[3], job_id='commit-node3', speed=1024*1024) 336 self.assert_qmp(result, 'return', {}) 337 338 result = self.vm.qmp('block-stream', device='node3', job_id='stream-node3') 339 self.assert_qmp(result, 'error/desc', 340 "Node 'node3' is busy: block device is in use by block job: commit") 341 342 result = self.vm.qmp('block-stream', device='node6', base=self.imgs[2], job_id='stream-node6') 343 self.assert_qmp(result, 'error/desc', 344 "Node 'node5' is busy: block device is in use by block job: commit") 345 346 result = self.vm.qmp('block-stream', device='node4', base=self.imgs[2], job_id='stream-node4') 347 self.assert_qmp(result, 'error/desc', 348 "Node 'node4' is busy: block device is in use by block job: commit") 349 350 result = self.vm.qmp('block-stream', device='node6', base=self.imgs[4], job_id='stream-node6-v2') 351 self.assert_qmp(result, 'error/desc', 352 "Node 'node5' is busy: block device is in use by block job: commit") 353 354 # This fails because block-commit currently blocks the active layer even if it's not used 355 result = self.vm.qmp('block-stream', device='drive0', base=self.imgs[5], job_id='stream-drive0') 356 self.assert_qmp(result, 'error/desc', 357 "Node 'drive0' is busy: block device is in use by block job: commit") 358 359 result = self.vm.qmp('block-job-set-speed', device='commit-node3', speed=0) 360 self.assert_qmp(result, 'return', {}) 361 362 self.wait_until_completed(drive='commit-node3') 363 364 # Similar to test_overlapping_2, but here block-commit doesn't use the 'top' parameter. 365 # Internally this uses a mirror block job, hence the separate test case. 366 def test_overlapping_3(self): 367 self.assertLessEqual(8, self.num_imgs) 368 self.assert_no_active_block_jobs() 369 370 # Set a speed limit to make sure that this job blocks the rest 371 result = self.vm.qmp('block-commit', device='drive0', base=self.imgs[3], job_id='commit-drive0', speed=1024*1024) 372 self.assert_qmp(result, 'return', {}) 373 374 result = self.vm.qmp('block-stream', device='node5', base=self.imgs[3], job_id='stream-node6') 375 self.assert_qmp(result, 'error/desc', 376 "Node 'node5' is busy: block device is in use by block job: commit") 377 378 result = self.vm.qmp('block-job-set-speed', device='commit-drive0', speed=0) 379 self.assert_qmp(result, 'return', {}) 380 381 event = self.vm.event_wait(name='BLOCK_JOB_READY') 382 self.assert_qmp(event, 'data/device', 'commit-drive0') 383 self.assert_qmp(event, 'data/type', 'commit') 384 self.assert_qmp_absent(event, 'data/error') 385 386 result = self.vm.qmp('block-job-complete', device='commit-drive0') 387 self.assert_qmp(result, 'return', {}) 388 389 self.wait_until_completed(drive='commit-drive0') 390 391 # In this case the base node of the stream job is the same as the 392 # top node of commit job. Since this results in the commit filter 393 # node being part of the stream chain, this is not allowed. 394 def test_overlapping_4(self): 395 self.assert_no_active_block_jobs() 396 397 # Commit from node2 into node0 398 result = self.vm.qmp('block-commit', device='drive0', 399 top=self.imgs[2], base=self.imgs[0], 400 filter_node_name='commit-filter', speed=1024*1024) 401 self.assert_qmp(result, 'return', {}) 402 403 # Stream from node2 into node4 404 result = self.vm.qmp('block-stream', device='node4', base_node='node2', job_id='node4') 405 self.assert_qmp(result, 'error/desc', 406 "Cannot freeze 'backing' link to 'commit-filter'") 407 408 result = self.vm.qmp('block-job-set-speed', device='drive0', speed=0) 409 self.assert_qmp(result, 'return', {}) 410 411 self.wait_until_completed() 412 self.assert_no_active_block_jobs() 413 414 # In this case the base node of the stream job is the commit job's 415 # filter node. stream does not have a real dependency on its base 416 # node, so even though commit removes it when it is done, there is 417 # no conflict. 418 def test_overlapping_5(self): 419 self.assert_no_active_block_jobs() 420 421 # Commit from node2 into node0 422 result = self.vm.qmp('block-commit', device='drive0', 423 top_node='node2', base_node='node0', 424 filter_node_name='commit-filter', speed=1024*1024) 425 self.assert_qmp(result, 'return', {}) 426 427 # Stream from node2 into node4 428 result = self.vm.qmp('block-stream', device='node4', 429 base_node='commit-filter', job_id='node4') 430 self.assert_qmp(result, 'return', {}) 431 432 result = self.vm.qmp('block-job-set-speed', device='drive0', speed=0) 433 self.assert_qmp(result, 'return', {}) 434 435 self.vm.run_job(job='drive0', auto_dismiss=True) 436 self.vm.run_job(job='node4', auto_dismiss=True) 437 self.assert_no_active_block_jobs() 438 439 # Test a block-stream and a block-commit job in parallel 440 # Here the stream job is supposed to finish quickly in order to reproduce 441 # the scenario that triggers the bug fixed in 3d5d319e1221 and 1a63a907507 442 def test_stream_commit_1(self): 443 self.assertLessEqual(8, self.num_imgs) 444 self.assert_no_active_block_jobs() 445 446 # Stream from node0 into node2 447 result = self.vm.qmp('block-stream', device='node2', base_node='node0', job_id='node2') 448 self.assert_qmp(result, 'return', {}) 449 450 # Commit from the active layer into node3 451 result = self.vm.qmp('block-commit', device='drive0', base=self.imgs[3]) 452 self.assert_qmp(result, 'return', {}) 453 454 # Wait for all jobs to be finished. 455 pending_jobs = ['node2', 'drive0'] 456 while len(pending_jobs) > 0: 457 for event in self.vm.get_qmp_events(wait=True): 458 if event['event'] == 'BLOCK_JOB_COMPLETED': 459 node_name = self.dictpath(event, 'data/device') 460 self.assertTrue(node_name in pending_jobs) 461 self.assert_qmp_absent(event, 'data/error') 462 pending_jobs.remove(node_name) 463 if event['event'] == 'BLOCK_JOB_READY': 464 self.assert_qmp(event, 'data/device', 'drive0') 465 self.assert_qmp(event, 'data/type', 'commit') 466 self.assert_qmp_absent(event, 'data/error') 467 self.assertTrue('drive0' in pending_jobs) 468 self.vm.qmp('block-job-complete', device='drive0') 469 470 self.assert_no_active_block_jobs() 471 472 # This is similar to test_stream_commit_1 but both jobs are slowed 473 # down so they can run in parallel for a little while. 474 def test_stream_commit_2(self): 475 self.assertLessEqual(8, self.num_imgs) 476 self.assert_no_active_block_jobs() 477 478 # Stream from node0 into node4 479 result = self.vm.qmp('block-stream', device='node4', base_node='node0', job_id='node4', speed=1024*1024) 480 self.assert_qmp(result, 'return', {}) 481 482 # Commit from the active layer into node5 483 result = self.vm.qmp('block-commit', device='drive0', base=self.imgs[5], speed=1024*1024) 484 self.assert_qmp(result, 'return', {}) 485 486 for job in ['drive0', 'node4']: 487 result = self.vm.qmp('block-job-set-speed', device=job, speed=0) 488 self.assert_qmp(result, 'return', {}) 489 490 # Wait for all jobs to be finished. 491 pending_jobs = ['node4', 'drive0'] 492 while len(pending_jobs) > 0: 493 for event in self.vm.get_qmp_events(wait=True): 494 if event['event'] == 'BLOCK_JOB_COMPLETED': 495 node_name = self.dictpath(event, 'data/device') 496 self.assertTrue(node_name in pending_jobs) 497 self.assert_qmp_absent(event, 'data/error') 498 pending_jobs.remove(node_name) 499 if event['event'] == 'BLOCK_JOB_READY': 500 self.assert_qmp(event, 'data/device', 'drive0') 501 self.assert_qmp(event, 'data/type', 'commit') 502 self.assert_qmp_absent(event, 'data/error') 503 self.assertTrue('drive0' in pending_jobs) 504 self.vm.qmp('block-job-complete', device='drive0') 505 506 self.assert_no_active_block_jobs() 507 508 # Test the base_node parameter 509 def test_stream_base_node_name(self): 510 self.assert_no_active_block_jobs() 511 512 self.assertNotEqual(qemu_io('-f', iotests.imgfmt, '-rU', '-c', 'map', self.imgs[4]), 513 qemu_io('-f', iotests.imgfmt, '-rU', '-c', 'map', self.imgs[3]), 514 'image file map matches backing file before streaming') 515 516 # Error: the base node does not exist 517 result = self.vm.qmp('block-stream', device='node4', base_node='none', job_id='stream') 518 self.assert_qmp(result, 'error/desc', 519 'Cannot find device=\'\' nor node-name=\'none\'') 520 521 # Error: the base node is not a backing file of the top node 522 result = self.vm.qmp('block-stream', device='node4', base_node='node6', job_id='stream') 523 self.assert_qmp(result, 'error/desc', 524 "Node 'node6' is not a backing image of 'node4'") 525 526 # Error: the base node is the same as the top node 527 result = self.vm.qmp('block-stream', device='node4', base_node='node4', job_id='stream') 528 self.assert_qmp(result, 'error/desc', 529 "Node 'node4' is not a backing image of 'node4'") 530 531 # Error: cannot specify 'base' and 'base-node' at the same time 532 result = self.vm.qmp('block-stream', device='node4', base=self.imgs[2], base_node='node2', job_id='stream') 533 self.assert_qmp(result, 'error/desc', 534 "'base' and 'base-node' cannot be specified at the same time") 535 536 # Success: the base node is a backing file of the top node 537 result = self.vm.qmp('block-stream', device='node4', base_node='node2', job_id='stream') 538 self.assert_qmp(result, 'return', {}) 539 540 self.wait_until_completed(drive='stream') 541 542 self.assert_no_active_block_jobs() 543 self.vm.shutdown() 544 545 self.assertEqual(qemu_io('-f', iotests.imgfmt, '-c', 'map', self.imgs[4]), 546 qemu_io('-f', iotests.imgfmt, '-c', 'map', self.imgs[3]), 547 'image file map matches backing file after streaming') 548 549class TestQuorum(iotests.QMPTestCase): 550 num_children = 3 551 children = [] 552 backing = [] 553 554 @iotests.skip_if_unsupported(['quorum']) 555 def setUp(self): 556 opts = ['driver=quorum', 'vote-threshold=2'] 557 558 # Initialize file names and command-line options 559 for i in range(self.num_children): 560 child_img = os.path.join(iotests.test_dir, 'img-%d.img' % i) 561 backing_img = os.path.join(iotests.test_dir, 'backing-%d.img' % i) 562 self.children.append(child_img) 563 self.backing.append(backing_img) 564 qemu_img('create', '-f', iotests.imgfmt, backing_img, '1M') 565 qemu_io('-f', iotests.imgfmt, 566 '-c', 'write -P 0x55 0 1024', backing_img) 567 qemu_img('create', '-f', iotests.imgfmt, 568 '-o', 'backing_file=%s' % backing_img, 569 '-F', iotests.imgfmt, child_img) 570 opts.append("children.%d.file.filename=%s" % (i, child_img)) 571 opts.append("children.%d.node-name=node%d" % (i, i)) 572 573 # Attach the drive to the VM 574 self.vm = iotests.VM() 575 self.vm.add_drive(path = None, opts = ','.join(opts)) 576 self.vm.launch() 577 578 def tearDown(self): 579 self.vm.shutdown() 580 for img in self.children: 581 os.remove(img) 582 for img in self.backing: 583 os.remove(img) 584 585 def test_stream_quorum(self): 586 self.assertNotEqual(qemu_io('-f', iotests.imgfmt, '-rU', '-c', 'map', self.children[0]), 587 qemu_io('-f', iotests.imgfmt, '-rU', '-c', 'map', self.backing[0]), 588 'image file map matches backing file before streaming') 589 590 self.assert_no_active_block_jobs() 591 592 result = self.vm.qmp('block-stream', device='node0', job_id='stream-node0') 593 self.assert_qmp(result, 'return', {}) 594 595 self.wait_until_completed(drive='stream-node0') 596 597 self.assert_no_active_block_jobs() 598 self.vm.shutdown() 599 600 self.assertEqual(qemu_io('-f', iotests.imgfmt, '-c', 'map', self.children[0]), 601 qemu_io('-f', iotests.imgfmt, '-c', 'map', self.backing[0]), 602 'image file map does not match backing file after streaming') 603 604class TestSmallerBackingFile(iotests.QMPTestCase): 605 backing_len = 1 * 1024 * 1024 # MB 606 image_len = 2 * backing_len 607 608 def setUp(self): 609 iotests.create_image(backing_img, self.backing_len) 610 qemu_img('create', '-f', iotests.imgfmt, 611 '-o', 'backing_file=%s' % backing_img, 612 '-F', 'raw', test_img, str(self.image_len)) 613 self.vm = iotests.VM().add_drive(test_img) 614 self.vm.launch() 615 616 # If this hangs, then you are missing a fix to complete streaming when the 617 # end of the backing file is reached. 618 def test_stream(self): 619 self.assert_no_active_block_jobs() 620 621 result = self.vm.qmp('block-stream', device='drive0') 622 self.assert_qmp(result, 'return', {}) 623 624 self.wait_until_completed() 625 626 self.assert_no_active_block_jobs() 627 self.vm.shutdown() 628 629class TestErrors(iotests.QMPTestCase): 630 image_len = 2 * 1024 * 1024 # MB 631 632 # this should match STREAM_BUFFER_SIZE/512 in block/stream.c 633 STREAM_BUFFER_SIZE = 512 * 1024 634 635 def create_blkdebug_file(self, name, event, errno): 636 file = open(name, 'w') 637 file.write(''' 638[inject-error] 639state = "1" 640event = "%s" 641errno = "%d" 642immediately = "off" 643once = "on" 644sector = "%d" 645 646[set-state] 647state = "1" 648event = "%s" 649new_state = "2" 650 651[set-state] 652state = "2" 653event = "%s" 654new_state = "1" 655''' % (event, errno, self.STREAM_BUFFER_SIZE // 512, event, event)) 656 file.close() 657 658class TestEIO(TestErrors): 659 def setUp(self): 660 self.blkdebug_file = backing_img + ".blkdebug" 661 iotests.create_image(backing_img, TestErrors.image_len) 662 self.create_blkdebug_file(self.blkdebug_file, "read_aio", 5) 663 qemu_img('create', '-f', iotests.imgfmt, 664 '-o', 'backing_file=blkdebug:%s:%s,backing_fmt=raw' 665 % (self.blkdebug_file, backing_img), 666 test_img) 667 self.vm = iotests.VM().add_drive(test_img) 668 self.vm.launch() 669 670 def tearDown(self): 671 self.vm.shutdown() 672 os.remove(test_img) 673 os.remove(backing_img) 674 os.remove(self.blkdebug_file) 675 676 def test_report(self): 677 self.assert_no_active_block_jobs() 678 679 result = self.vm.qmp('block-stream', device='drive0') 680 self.assert_qmp(result, 'return', {}) 681 682 completed = False 683 error = False 684 while not completed: 685 for event in self.vm.get_qmp_events(wait=True): 686 if event['event'] == 'BLOCK_JOB_ERROR': 687 self.assert_qmp(event, 'data/device', 'drive0') 688 self.assert_qmp(event, 'data/operation', 'read') 689 error = True 690 elif event['event'] == 'BLOCK_JOB_COMPLETED': 691 self.assertTrue(error, 'job completed unexpectedly') 692 self.assert_qmp(event, 'data/type', 'stream') 693 self.assert_qmp(event, 'data/device', 'drive0') 694 self.assert_qmp(event, 'data/error', 'Input/output error') 695 self.assert_qmp(event, 'data/offset', self.STREAM_BUFFER_SIZE) 696 self.assert_qmp(event, 'data/len', self.image_len) 697 completed = True 698 elif event['event'] == 'JOB_STATUS_CHANGE': 699 self.assert_qmp(event, 'data/id', 'drive0') 700 701 self.assert_no_active_block_jobs() 702 self.vm.shutdown() 703 704 def test_ignore(self): 705 self.assert_no_active_block_jobs() 706 707 result = self.vm.qmp('block-stream', device='drive0', on_error='ignore') 708 self.assert_qmp(result, 'return', {}) 709 710 error = False 711 completed = False 712 while not completed: 713 for event in self.vm.get_qmp_events(wait=True): 714 if event['event'] == 'BLOCK_JOB_ERROR': 715 error = True 716 self.assert_qmp(event, 'data/device', 'drive0') 717 self.assert_qmp(event, 'data/operation', 'read') 718 result = self.vm.qmp('query-block-jobs') 719 if result == {'return': []}: 720 # Job finished too quickly 721 continue 722 self.assert_qmp(result, 'return[0]/paused', False) 723 elif event['event'] == 'BLOCK_JOB_COMPLETED': 724 self.assertTrue(error, 'job completed unexpectedly') 725 self.assert_qmp(event, 'data/type', 'stream') 726 self.assert_qmp(event, 'data/device', 'drive0') 727 self.assert_qmp(event, 'data/error', 'Input/output error') 728 self.assert_qmp(event, 'data/offset', self.image_len) 729 self.assert_qmp(event, 'data/len', self.image_len) 730 completed = True 731 elif event['event'] == 'JOB_STATUS_CHANGE': 732 self.assert_qmp(event, 'data/id', 'drive0') 733 734 self.assert_no_active_block_jobs() 735 self.vm.shutdown() 736 737 def test_stop(self): 738 self.assert_no_active_block_jobs() 739 740 result = self.vm.qmp('block-stream', device='drive0', on_error='stop') 741 self.assert_qmp(result, 'return', {}) 742 743 error = False 744 completed = False 745 while not completed: 746 for event in self.vm.get_qmp_events(wait=True): 747 if event['event'] == 'BLOCK_JOB_ERROR': 748 error = True 749 self.assert_qmp(event, 'data/device', 'drive0') 750 self.assert_qmp(event, 'data/operation', 'read') 751 752 result = self.vm.qmp('query-block-jobs') 753 self.assert_qmp(result, 'return[0]/paused', True) 754 self.assert_qmp(result, 'return[0]/offset', self.STREAM_BUFFER_SIZE) 755 self.assert_qmp(result, 'return[0]/io-status', 'failed') 756 757 result = self.vm.qmp('block-job-resume', device='drive0') 758 self.assert_qmp(result, 'return', {}) 759 760 result = self.vm.qmp('query-block-jobs') 761 if result == {'return': []}: 762 # Race; likely already finished. Check. 763 continue 764 self.assert_qmp(result, 'return[0]/paused', False) 765 self.assert_qmp(result, 'return[0]/io-status', 'ok') 766 elif event['event'] == 'BLOCK_JOB_COMPLETED': 767 self.assertTrue(error, 'job completed unexpectedly') 768 self.assert_qmp(event, 'data/type', 'stream') 769 self.assert_qmp(event, 'data/device', 'drive0') 770 self.assert_qmp_absent(event, 'data/error') 771 self.assert_qmp(event, 'data/offset', self.image_len) 772 self.assert_qmp(event, 'data/len', self.image_len) 773 completed = True 774 elif event['event'] == 'JOB_STATUS_CHANGE': 775 self.assert_qmp(event, 'data/id', 'drive0') 776 777 self.assert_no_active_block_jobs() 778 self.vm.shutdown() 779 780 def test_enospc(self): 781 self.assert_no_active_block_jobs() 782 783 result = self.vm.qmp('block-stream', device='drive0', on_error='enospc') 784 self.assert_qmp(result, 'return', {}) 785 786 completed = False 787 error = False 788 while not completed: 789 for event in self.vm.get_qmp_events(wait=True): 790 if event['event'] == 'BLOCK_JOB_ERROR': 791 self.assert_qmp(event, 'data/device', 'drive0') 792 self.assert_qmp(event, 'data/operation', 'read') 793 error = True 794 elif event['event'] == 'BLOCK_JOB_COMPLETED': 795 self.assertTrue(error, 'job completed unexpectedly') 796 self.assert_qmp(event, 'data/type', 'stream') 797 self.assert_qmp(event, 'data/device', 'drive0') 798 self.assert_qmp(event, 'data/error', 'Input/output error') 799 self.assert_qmp(event, 'data/offset', self.STREAM_BUFFER_SIZE) 800 self.assert_qmp(event, 'data/len', self.image_len) 801 completed = True 802 elif event['event'] == 'JOB_STATUS_CHANGE': 803 self.assert_qmp(event, 'data/id', 'drive0') 804 805 self.assert_no_active_block_jobs() 806 self.vm.shutdown() 807 808class TestENOSPC(TestErrors): 809 def setUp(self): 810 self.blkdebug_file = backing_img + ".blkdebug" 811 iotests.create_image(backing_img, TestErrors.image_len) 812 self.create_blkdebug_file(self.blkdebug_file, "read_aio", 28) 813 qemu_img('create', '-f', iotests.imgfmt, 814 '-o', 'backing_file=blkdebug:%s:%s,backing_fmt=raw' 815 % (self.blkdebug_file, backing_img), 816 test_img) 817 self.vm = iotests.VM().add_drive(test_img) 818 self.vm.launch() 819 820 def tearDown(self): 821 self.vm.shutdown() 822 os.remove(test_img) 823 os.remove(backing_img) 824 os.remove(self.blkdebug_file) 825 826 def test_enospc(self): 827 self.assert_no_active_block_jobs() 828 829 result = self.vm.qmp('block-stream', device='drive0', on_error='enospc') 830 self.assert_qmp(result, 'return', {}) 831 832 error = False 833 completed = False 834 while not completed: 835 for event in self.vm.get_qmp_events(wait=True): 836 if event['event'] == 'BLOCK_JOB_ERROR': 837 self.assert_qmp(event, 'data/device', 'drive0') 838 self.assert_qmp(event, 'data/operation', 'read') 839 error = True 840 841 result = self.vm.qmp('query-block-jobs') 842 self.assert_qmp(result, 'return[0]/paused', True) 843 self.assert_qmp(result, 'return[0]/offset', self.STREAM_BUFFER_SIZE) 844 self.assert_qmp(result, 'return[0]/io-status', 'nospace') 845 846 result = self.vm.qmp('block-job-resume', device='drive0') 847 self.assert_qmp(result, 'return', {}) 848 849 result = self.vm.qmp('query-block-jobs') 850 if result == {'return': []}: 851 # Race; likely already finished. Check. 852 continue 853 self.assert_qmp(result, 'return[0]/paused', False) 854 self.assert_qmp(result, 'return[0]/io-status', 'ok') 855 elif event['event'] == 'BLOCK_JOB_COMPLETED': 856 self.assertTrue(error, 'job completed unexpectedly') 857 self.assert_qmp(event, 'data/type', 'stream') 858 self.assert_qmp(event, 'data/device', 'drive0') 859 self.assert_qmp_absent(event, 'data/error') 860 self.assert_qmp(event, 'data/offset', self.image_len) 861 self.assert_qmp(event, 'data/len', self.image_len) 862 completed = True 863 elif event['event'] == 'JOB_STATUS_CHANGE': 864 self.assert_qmp(event, 'data/id', 'drive0') 865 866 self.assert_no_active_block_jobs() 867 self.vm.shutdown() 868 869class TestStreamStop(iotests.QMPTestCase): 870 image_len = 8 * 1024 * 1024 * 1024 # GB 871 872 def setUp(self): 873 qemu_img('create', backing_img, str(TestStreamStop.image_len)) 874 qemu_io('-f', 'raw', '-c', 'write -P 0x1 0 32M', backing_img) 875 qemu_img('create', '-f', iotests.imgfmt, 876 '-o', 'backing_file=%s' % backing_img, 877 '-F', 'raw', test_img) 878 qemu_io('-f', iotests.imgfmt, '-c', 'write -P 0x1 32M 32M', test_img) 879 self.vm = iotests.VM().add_drive("blkdebug::" + test_img) 880 self.vm.launch() 881 882 def tearDown(self): 883 self.vm.shutdown() 884 os.remove(test_img) 885 os.remove(backing_img) 886 887 def test_stream_stop(self): 888 self.assert_no_active_block_jobs() 889 890 self.vm.pause_drive('drive0') 891 result = self.vm.qmp('block-stream', device='drive0') 892 self.assert_qmp(result, 'return', {}) 893 894 time.sleep(0.1) 895 events = self.vm.get_qmp_events(wait=False) 896 for e in events: 897 self.assert_qmp(e, 'event', 'JOB_STATUS_CHANGE') 898 self.assert_qmp(e, 'data/id', 'drive0') 899 900 self.cancel_and_wait(resume=True) 901 902class TestSetSpeed(iotests.QMPTestCase): 903 image_len = 80 * 1024 * 1024 # MB 904 905 def setUp(self): 906 qemu_img('create', backing_img, str(TestSetSpeed.image_len)) 907 qemu_io('-f', 'raw', '-c', 'write -P 0x1 0 32M', backing_img) 908 qemu_img('create', '-f', iotests.imgfmt, 909 '-o', 'backing_file=%s' % backing_img, 910 '-F', 'raw', test_img) 911 qemu_io('-f', iotests.imgfmt, '-c', 'write -P 0x1 32M 32M', test_img) 912 self.vm = iotests.VM().add_drive('blkdebug::' + test_img) 913 self.vm.launch() 914 915 def tearDown(self): 916 self.vm.shutdown() 917 os.remove(test_img) 918 os.remove(backing_img) 919 920 # This is a short performance test which is not run by default. 921 # Invoke "IMGFMT=qed ./030 TestSetSpeed.perf_test_throughput" 922 def perf_test_throughput(self): 923 self.assert_no_active_block_jobs() 924 925 result = self.vm.qmp('block-stream', device='drive0') 926 self.assert_qmp(result, 'return', {}) 927 928 result = self.vm.qmp('block-job-set-speed', device='drive0', speed=8 * 1024 * 1024) 929 self.assert_qmp(result, 'return', {}) 930 931 self.wait_until_completed() 932 933 self.assert_no_active_block_jobs() 934 935 def test_set_speed(self): 936 self.assert_no_active_block_jobs() 937 938 self.vm.pause_drive('drive0') 939 result = self.vm.qmp('block-stream', device='drive0') 940 self.assert_qmp(result, 'return', {}) 941 942 # Default speed is 0 943 result = self.vm.qmp('query-block-jobs') 944 self.assert_qmp(result, 'return[0]/device', 'drive0') 945 self.assert_qmp(result, 'return[0]/speed', 0) 946 947 result = self.vm.qmp('block-job-set-speed', device='drive0', speed=8 * 1024 * 1024) 948 self.assert_qmp(result, 'return', {}) 949 950 # Ensure the speed we set was accepted 951 result = self.vm.qmp('query-block-jobs') 952 self.assert_qmp(result, 'return[0]/device', 'drive0') 953 self.assert_qmp(result, 'return[0]/speed', 8 * 1024 * 1024) 954 955 self.cancel_and_wait(resume=True) 956 self.vm.pause_drive('drive0') 957 958 # Check setting speed in block-stream works 959 result = self.vm.qmp('block-stream', device='drive0', speed=4 * 1024 * 1024) 960 self.assert_qmp(result, 'return', {}) 961 962 result = self.vm.qmp('query-block-jobs') 963 self.assert_qmp(result, 'return[0]/device', 'drive0') 964 self.assert_qmp(result, 'return[0]/speed', 4 * 1024 * 1024) 965 966 self.cancel_and_wait(resume=True) 967 968 def test_set_speed_invalid(self): 969 self.assert_no_active_block_jobs() 970 971 result = self.vm.qmp('block-stream', device='drive0', speed=-1) 972 self.assert_qmp(result, 'error/desc', "Parameter 'speed' expects a non-negative value") 973 974 self.assert_no_active_block_jobs() 975 976 self.vm.pause_drive('drive0') 977 result = self.vm.qmp('block-stream', device='drive0') 978 self.assert_qmp(result, 'return', {}) 979 980 result = self.vm.qmp('block-job-set-speed', device='drive0', speed=-1) 981 self.assert_qmp(result, 'error/desc', "Parameter 'speed' expects a non-negative value") 982 983 self.cancel_and_wait(resume=True) 984 985if __name__ == '__main__': 986 iotests.main(supported_fmts=['qcow2', 'qed'], 987 supported_protocols=['file']) 988