xref: /openbmc/qemu/tests/qemu-iotests/030 (revision 52c95cae)
1#!/usr/bin/env python
2#
3# Tests for image streaming.
4#
5# Copyright (C) 2012 IBM Corp.
6#
7# This program is free software; you can redistribute it and/or modify
8# it under the terms of the GNU General Public License as published by
9# the Free Software Foundation; either version 2 of the License, or
10# (at your option) any later version.
11#
12# This program is distributed in the hope that it will be useful,
13# but WITHOUT ANY WARRANTY; without even the implied warranty of
14# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15# GNU General Public License for more details.
16#
17# You should have received a copy of the GNU General Public License
18# along with this program.  If not, see <http://www.gnu.org/licenses/>.
19#
20
21import time
22import os
23import iotests
24from iotests import qemu_img, qemu_io
25
26backing_img = os.path.join(iotests.test_dir, 'backing.img')
27mid_img = os.path.join(iotests.test_dir, 'mid.img')
28test_img = os.path.join(iotests.test_dir, 'test.img')
29
30class TestSingleDrive(iotests.QMPTestCase):
31    image_len = 1 * 1024 * 1024 # MB
32
33    def setUp(self):
34        iotests.create_image(backing_img, TestSingleDrive.image_len)
35        qemu_img('create', '-f', iotests.imgfmt, '-o', 'backing_file=%s' % backing_img, mid_img)
36        qemu_img('create', '-f', iotests.imgfmt, '-o', 'backing_file=%s' % mid_img, test_img)
37        qemu_io('-f', 'raw', '-c', 'write -P 0x1 0 512', backing_img)
38        qemu_io('-f', iotests.imgfmt, '-c', 'write -P 0x1 524288 512', mid_img)
39        self.vm = iotests.VM().add_drive("blkdebug::" + test_img, "backing.node-name=mid")
40        self.vm.launch()
41
42    def tearDown(self):
43        self.vm.shutdown()
44        os.remove(test_img)
45        os.remove(mid_img)
46        os.remove(backing_img)
47
48    def test_stream(self):
49        self.assert_no_active_block_jobs()
50
51        result = self.vm.qmp('block-stream', device='drive0')
52        self.assert_qmp(result, 'return', {})
53
54        self.wait_until_completed()
55
56        self.assert_no_active_block_jobs()
57        self.vm.shutdown()
58
59        self.assertEqual(qemu_io('-f', 'raw', '-c', 'map', backing_img),
60                         qemu_io('-f', iotests.imgfmt, '-c', 'map', test_img),
61                         'image file map does not match backing file after streaming')
62
63    def test_stream_intermediate(self):
64        self.assert_no_active_block_jobs()
65
66        self.assertNotEqual(qemu_io('-f', 'raw', '-rU', '-c', 'map', backing_img),
67                            qemu_io('-f', iotests.imgfmt, '-rU', '-c', 'map', mid_img),
68                            'image file map matches backing file before streaming')
69
70        result = self.vm.qmp('block-stream', device='mid', job_id='stream-mid')
71        self.assert_qmp(result, 'return', {})
72
73        self.wait_until_completed(drive='stream-mid')
74
75        self.assert_no_active_block_jobs()
76        self.vm.shutdown()
77
78        self.assertEqual(qemu_io('-f', 'raw', '-c', 'map', backing_img),
79                         qemu_io('-f', iotests.imgfmt, '-c', 'map', mid_img),
80                         'image file map does not match backing file after streaming')
81
82    def test_stream_pause(self):
83        self.assert_no_active_block_jobs()
84
85        self.vm.pause_drive('drive0')
86        result = self.vm.qmp('block-stream', device='drive0')
87        self.assert_qmp(result, 'return', {})
88
89        result = self.vm.qmp('block-job-pause', device='drive0')
90        self.assert_qmp(result, 'return', {})
91
92        self.vm.resume_drive('drive0')
93        self.pause_job('drive0')
94
95        result = self.vm.qmp('query-block-jobs')
96        offset = self.dictpath(result, 'return[0]/offset')
97
98        time.sleep(0.5)
99        result = self.vm.qmp('query-block-jobs')
100        self.assert_qmp(result, 'return[0]/offset', offset)
101
102        result = self.vm.qmp('block-job-resume', device='drive0')
103        self.assert_qmp(result, 'return', {})
104
105        self.wait_until_completed()
106
107        self.assert_no_active_block_jobs()
108        self.vm.shutdown()
109
110        self.assertEqual(qemu_io('-f', 'raw', '-c', 'map', backing_img),
111                         qemu_io('-f', iotests.imgfmt, '-c', 'map', test_img),
112                         'image file map does not match backing file after streaming')
113
114    def test_stream_no_op(self):
115        self.assert_no_active_block_jobs()
116
117        # The image map is empty before the operation
118        empty_map = qemu_io('-f', iotests.imgfmt, '-rU', '-c', 'map', test_img)
119
120        # This is a no-op: no data should ever be copied from the base image
121        result = self.vm.qmp('block-stream', device='drive0', base=mid_img)
122        self.assert_qmp(result, 'return', {})
123
124        self.wait_until_completed()
125
126        self.assert_no_active_block_jobs()
127        self.vm.shutdown()
128
129        self.assertEqual(qemu_io('-f', iotests.imgfmt, '-c', 'map', test_img),
130                         empty_map, 'image file map changed after a no-op')
131
132    def test_stream_partial(self):
133        self.assert_no_active_block_jobs()
134
135        result = self.vm.qmp('block-stream', device='drive0', base=backing_img)
136        self.assert_qmp(result, 'return', {})
137
138        self.wait_until_completed()
139
140        self.assert_no_active_block_jobs()
141        self.vm.shutdown()
142
143        self.assertEqual(qemu_io('-f', iotests.imgfmt, '-c', 'map', mid_img),
144                         qemu_io('-f', iotests.imgfmt, '-c', 'map', test_img),
145                         'image file map does not match backing file after streaming')
146
147    def test_device_not_found(self):
148        result = self.vm.qmp('block-stream', device='nonexistent')
149        self.assert_qmp(result, 'error/class', 'GenericError')
150
151    def test_job_id_missing(self):
152        result = self.vm.qmp('block-stream', device='mid')
153        self.assert_qmp(result, 'error/class', 'GenericError')
154
155
156class TestParallelOps(iotests.QMPTestCase):
157    num_ops = 4 # Number of parallel block-stream operations
158    num_imgs = num_ops * 2 + 1
159    image_len = num_ops * 512 * 1024
160    imgs = []
161
162    def setUp(self):
163        opts = []
164        self.imgs = []
165
166        # Initialize file names and command-line options
167        for i in range(self.num_imgs):
168            img_depth = self.num_imgs - i - 1
169            opts.append("backing." * img_depth + "node-name=node%d" % i)
170            self.imgs.append(os.path.join(iotests.test_dir, 'img-%d.img' % i))
171
172        # Create all images
173        iotests.create_image(self.imgs[0], self.image_len)
174        for i in range(1, self.num_imgs):
175            qemu_img('create', '-f', iotests.imgfmt,
176                     '-o', 'backing_file=%s' % self.imgs[i-1], self.imgs[i])
177
178        # Put data into the images we are copying data from
179        odd_img_indexes = [x for x in reversed(range(self.num_imgs)) if x % 2 == 1]
180        for i in range(len(odd_img_indexes)):
181            # Alternate between 256KB and 512KB.
182            # This way jobs will not finish in the same order they were created
183            num_kb = 256 + 256 * (i % 2)
184            qemu_io('-f', iotests.imgfmt,
185                    '-c', 'write -P 0xFF %dk %dk' % (i * 512, num_kb),
186                    self.imgs[odd_img_indexes[i]])
187
188        # Attach the drive to the VM
189        self.vm = iotests.VM()
190        self.vm.add_drive(self.imgs[-1], ','.join(opts))
191        self.vm.launch()
192
193    def tearDown(self):
194        self.vm.shutdown()
195        for img in self.imgs:
196            os.remove(img)
197
198    # Test that it's possible to run several block-stream operations
199    # in parallel in the same snapshot chain
200    def test_stream_parallel(self):
201        self.assert_no_active_block_jobs()
202
203        # Check that the maps don't match before the streaming operations
204        for i in range(2, self.num_imgs, 2):
205            self.assertNotEqual(qemu_io('-f', iotests.imgfmt, '-rU', '-c', 'map', self.imgs[i]),
206                                qemu_io('-f', iotests.imgfmt, '-rU', '-c', 'map', self.imgs[i-1]),
207                                'image file map matches backing file before streaming')
208
209        # Create all streaming jobs
210        pending_jobs = []
211        for i in range(2, self.num_imgs, 2):
212            node_name = 'node%d' % i
213            job_id = 'stream-%s' % node_name
214            pending_jobs.append(job_id)
215            result = self.vm.qmp('block-stream', device=node_name, job_id=job_id, base=self.imgs[i-2], speed=512*1024)
216            self.assert_qmp(result, 'return', {})
217
218        # Wait for all jobs to be finished.
219        while len(pending_jobs) > 0:
220            for event in self.vm.get_qmp_events(wait=True):
221                if event['event'] == 'BLOCK_JOB_COMPLETED':
222                    job_id = self.dictpath(event, 'data/device')
223                    self.assertTrue(job_id in pending_jobs)
224                    self.assert_qmp_absent(event, 'data/error')
225                    pending_jobs.remove(job_id)
226
227        self.assert_no_active_block_jobs()
228        self.vm.shutdown()
229
230        # Check that all maps match now
231        for i in range(2, self.num_imgs, 2):
232            self.assertEqual(qemu_io('-f', iotests.imgfmt, '-c', 'map', self.imgs[i]),
233                             qemu_io('-f', iotests.imgfmt, '-c', 'map', self.imgs[i-1]),
234                             'image file map does not match backing file after streaming')
235
236    # Test that it's not possible to perform two block-stream
237    # operations if there are nodes involved in both.
238    def test_overlapping_1(self):
239        self.assert_no_active_block_jobs()
240
241        # Set a speed limit to make sure that this job blocks the rest
242        result = self.vm.qmp('block-stream', device='node4', job_id='stream-node4', base=self.imgs[1], speed=1024*1024)
243        self.assert_qmp(result, 'return', {})
244
245        result = self.vm.qmp('block-stream', device='node5', job_id='stream-node5', base=self.imgs[2])
246        self.assert_qmp(result, 'error/class', 'GenericError')
247
248        result = self.vm.qmp('block-stream', device='node3', job_id='stream-node3', base=self.imgs[2])
249        self.assert_qmp(result, 'error/class', 'GenericError')
250
251        result = self.vm.qmp('block-stream', device='node4', job_id='stream-node4-v2')
252        self.assert_qmp(result, 'error/class', 'GenericError')
253
254        # block-commit should also fail if it touches nodes used by the stream job
255        result = self.vm.qmp('block-commit', device='drive0', base=self.imgs[4], job_id='commit-node4')
256        self.assert_qmp(result, 'error/class', 'GenericError')
257
258        result = self.vm.qmp('block-commit', device='drive0', base=self.imgs[1], top=self.imgs[3], job_id='commit-node1')
259        self.assert_qmp(result, 'error/class', 'GenericError')
260
261        # This fails because it needs to modify the backing string in node2, which is blocked
262        result = self.vm.qmp('block-commit', device='drive0', base=self.imgs[0], top=self.imgs[1], job_id='commit-node0')
263        self.assert_qmp(result, 'error/class', 'GenericError')
264
265        self.wait_until_completed(drive='stream-node4')
266        self.assert_no_active_block_jobs()
267
268    # Similar to test_overlapping_1, but with block-commit
269    # blocking the other jobs
270    def test_overlapping_2(self):
271        self.assertLessEqual(9, self.num_imgs)
272        self.assert_no_active_block_jobs()
273
274        # Set a speed limit to make sure that this job blocks the rest
275        result = self.vm.qmp('block-commit', device='drive0', top=self.imgs[5], base=self.imgs[3], job_id='commit-node3', speed=1024*1024)
276        self.assert_qmp(result, 'return', {})
277
278        result = self.vm.qmp('block-stream', device='node3', job_id='stream-node3')
279        self.assert_qmp(result, 'error/class', 'GenericError')
280
281        result = self.vm.qmp('block-stream', device='node6', base=self.imgs[2], job_id='stream-node6')
282        self.assert_qmp(result, 'error/class', 'GenericError')
283
284        result = self.vm.qmp('block-stream', device='node4', base=self.imgs[2], job_id='stream-node4')
285        self.assert_qmp(result, 'error/class', 'GenericError')
286
287        result = self.vm.qmp('block-stream', device='node6', base=self.imgs[4], job_id='stream-node6-v2')
288        self.assert_qmp(result, 'error/class', 'GenericError')
289
290        # This fails because block-commit currently blocks the active layer even if it's not used
291        result = self.vm.qmp('block-stream', device='drive0', base=self.imgs[5], job_id='stream-drive0')
292        self.assert_qmp(result, 'error/class', 'GenericError')
293
294        self.wait_until_completed(drive='commit-node3')
295
296    # Similar to test_overlapping_2, but here block-commit doesn't use the 'top' parameter.
297    # Internally this uses a mirror block job, hence the separate test case.
298    def test_overlapping_3(self):
299        self.assertLessEqual(8, self.num_imgs)
300        self.assert_no_active_block_jobs()
301
302        # Set a speed limit to make sure that this job blocks the rest
303        result = self.vm.qmp('block-commit', device='drive0', base=self.imgs[3], job_id='commit-drive0', speed=1024*1024)
304        self.assert_qmp(result, 'return', {})
305
306        result = self.vm.qmp('block-stream', device='node5', base=self.imgs[3], job_id='stream-node6')
307        self.assert_qmp(result, 'error/class', 'GenericError')
308
309        event = self.vm.get_qmp_event(wait=True)
310        self.assertEqual(event['event'], 'BLOCK_JOB_READY')
311        self.assert_qmp(event, 'data/device', 'commit-drive0')
312        self.assert_qmp(event, 'data/type', 'commit')
313        self.assert_qmp_absent(event, 'data/error')
314
315        result = self.vm.qmp('block-job-complete', device='commit-drive0')
316        self.assert_qmp(result, 'return', {})
317
318        self.wait_until_completed(drive='commit-drive0')
319
320    # Test a block-stream and a block-commit job in parallel
321    # Here the stream job is supposed to finish quickly in order to reproduce
322    # the scenario that triggers the bug fixed in 3d5d319e1221 and 1a63a907507
323    def test_stream_commit_1(self):
324        self.assertLessEqual(8, self.num_imgs)
325        self.assert_no_active_block_jobs()
326
327        # Stream from node0 into node2
328        result = self.vm.qmp('block-stream', device='node2', base_node='node0', job_id='node2')
329        self.assert_qmp(result, 'return', {})
330
331        # Commit from the active layer into node3
332        result = self.vm.qmp('block-commit', device='drive0', base=self.imgs[3])
333        self.assert_qmp(result, 'return', {})
334
335        # Wait for all jobs to be finished.
336        pending_jobs = ['node2', 'drive0']
337        while len(pending_jobs) > 0:
338            for event in self.vm.get_qmp_events(wait=True):
339                if event['event'] == 'BLOCK_JOB_COMPLETED':
340                    node_name = self.dictpath(event, 'data/device')
341                    self.assertTrue(node_name in pending_jobs)
342                    self.assert_qmp_absent(event, 'data/error')
343                    pending_jobs.remove(node_name)
344                if event['event'] == 'BLOCK_JOB_READY':
345                    self.assert_qmp(event, 'data/device', 'drive0')
346                    self.assert_qmp(event, 'data/type', 'commit')
347                    self.assert_qmp_absent(event, 'data/error')
348                    self.assertTrue('drive0' in pending_jobs)
349                    self.vm.qmp('block-job-complete', device='drive0')
350
351        self.assert_no_active_block_jobs()
352
353    # This is similar to test_stream_commit_1 but both jobs are slowed
354    # down so they can run in parallel for a little while.
355    def test_stream_commit_2(self):
356        self.assertLessEqual(8, self.num_imgs)
357        self.assert_no_active_block_jobs()
358
359        # Stream from node0 into node4
360        result = self.vm.qmp('block-stream', device='node4', base_node='node0', job_id='node4', speed=1024*1024)
361        self.assert_qmp(result, 'return', {})
362
363        # Commit from the active layer into node5
364        result = self.vm.qmp('block-commit', device='drive0', base=self.imgs[5], speed=1024*1024)
365        self.assert_qmp(result, 'return', {})
366
367        # Wait for all jobs to be finished.
368        pending_jobs = ['node4', 'drive0']
369        while len(pending_jobs) > 0:
370            for event in self.vm.get_qmp_events(wait=True):
371                if event['event'] == 'BLOCK_JOB_COMPLETED':
372                    node_name = self.dictpath(event, 'data/device')
373                    self.assertTrue(node_name in pending_jobs)
374                    self.assert_qmp_absent(event, 'data/error')
375                    pending_jobs.remove(node_name)
376                if event['event'] == 'BLOCK_JOB_READY':
377                    self.assert_qmp(event, 'data/device', 'drive0')
378                    self.assert_qmp(event, 'data/type', 'commit')
379                    self.assert_qmp_absent(event, 'data/error')
380                    self.assertTrue('drive0' in pending_jobs)
381                    self.vm.qmp('block-job-complete', device='drive0')
382
383        self.assert_no_active_block_jobs()
384
385    # Test the base_node parameter
386    def test_stream_base_node_name(self):
387        self.assert_no_active_block_jobs()
388
389        self.assertNotEqual(qemu_io('-f', iotests.imgfmt, '-rU', '-c', 'map', self.imgs[4]),
390                            qemu_io('-f', iotests.imgfmt, '-rU', '-c', 'map', self.imgs[3]),
391                            'image file map matches backing file before streaming')
392
393        # Error: the base node does not exist
394        result = self.vm.qmp('block-stream', device='node4', base_node='none', job_id='stream')
395        self.assert_qmp(result, 'error/class', 'GenericError')
396
397        # Error: the base node is not a backing file of the top node
398        result = self.vm.qmp('block-stream', device='node4', base_node='node6', job_id='stream')
399        self.assert_qmp(result, 'error/class', 'GenericError')
400
401        # Error: the base node is the same as the top node
402        result = self.vm.qmp('block-stream', device='node4', base_node='node4', job_id='stream')
403        self.assert_qmp(result, 'error/class', 'GenericError')
404
405        # Error: cannot specify 'base' and 'base-node' at the same time
406        result = self.vm.qmp('block-stream', device='node4', base=self.imgs[2], base_node='node2', job_id='stream')
407        self.assert_qmp(result, 'error/class', 'GenericError')
408
409        # Success: the base node is a backing file of the top node
410        result = self.vm.qmp('block-stream', device='node4', base_node='node2', job_id='stream')
411        self.assert_qmp(result, 'return', {})
412
413        self.wait_until_completed(drive='stream')
414
415        self.assert_no_active_block_jobs()
416        self.vm.shutdown()
417
418        self.assertEqual(qemu_io('-f', iotests.imgfmt, '-c', 'map', self.imgs[4]),
419                         qemu_io('-f', iotests.imgfmt, '-c', 'map', self.imgs[3]),
420                         'image file map matches backing file after streaming')
421
422class TestQuorum(iotests.QMPTestCase):
423    num_children = 3
424    children = []
425    backing = []
426
427    def setUp(self):
428        opts = ['driver=quorum', 'vote-threshold=2']
429
430        # Initialize file names and command-line options
431        for i in range(self.num_children):
432            child_img = os.path.join(iotests.test_dir, 'img-%d.img' % i)
433            backing_img = os.path.join(iotests.test_dir, 'backing-%d.img' % i)
434            self.children.append(child_img)
435            self.backing.append(backing_img)
436            qemu_img('create', '-f', iotests.imgfmt, backing_img, '1M')
437            qemu_io('-f', iotests.imgfmt,
438                    '-c', 'write -P 0x55 0 1024', backing_img)
439            qemu_img('create', '-f', iotests.imgfmt,
440                     '-o', 'backing_file=%s' % backing_img, child_img)
441            opts.append("children.%d.file.filename=%s" % (i, child_img))
442            opts.append("children.%d.node-name=node%d" % (i, i))
443
444        # Attach the drive to the VM
445        self.vm = iotests.VM()
446        self.vm.add_drive(path = None, opts = ','.join(opts))
447        self.vm.launch()
448
449    def tearDown(self):
450        self.vm.shutdown()
451        for img in self.children:
452            os.remove(img)
453        for img in self.backing:
454            os.remove(img)
455
456    def test_stream_quorum(self):
457        if not iotests.supports_quorum():
458            return
459
460        self.assertNotEqual(qemu_io('-f', iotests.imgfmt, '-rU', '-c', 'map', self.children[0]),
461                            qemu_io('-f', iotests.imgfmt, '-rU', '-c', 'map', self.backing[0]),
462                            'image file map matches backing file before streaming')
463
464        self.assert_no_active_block_jobs()
465
466        result = self.vm.qmp('block-stream', device='node0', job_id='stream-node0')
467        self.assert_qmp(result, 'return', {})
468
469        self.wait_until_completed(drive='stream-node0')
470
471        self.assert_no_active_block_jobs()
472        self.vm.shutdown()
473
474        self.assertEqual(qemu_io('-f', iotests.imgfmt, '-c', 'map', self.children[0]),
475                         qemu_io('-f', iotests.imgfmt, '-c', 'map', self.backing[0]),
476                         'image file map does not match backing file after streaming')
477
478class TestSmallerBackingFile(iotests.QMPTestCase):
479    backing_len = 1 * 1024 * 1024 # MB
480    image_len = 2 * backing_len
481
482    def setUp(self):
483        iotests.create_image(backing_img, self.backing_len)
484        qemu_img('create', '-f', iotests.imgfmt, '-o', 'backing_file=%s' % backing_img, test_img, str(self.image_len))
485        self.vm = iotests.VM().add_drive(test_img)
486        self.vm.launch()
487
488    # If this hangs, then you are missing a fix to complete streaming when the
489    # end of the backing file is reached.
490    def test_stream(self):
491        self.assert_no_active_block_jobs()
492
493        result = self.vm.qmp('block-stream', device='drive0')
494        self.assert_qmp(result, 'return', {})
495
496        self.wait_until_completed()
497
498        self.assert_no_active_block_jobs()
499        self.vm.shutdown()
500
501class TestErrors(iotests.QMPTestCase):
502    image_len = 2 * 1024 * 1024 # MB
503
504    # this should match STREAM_BUFFER_SIZE/512 in block/stream.c
505    STREAM_BUFFER_SIZE = 512 * 1024
506
507    def create_blkdebug_file(self, name, event, errno):
508        file = open(name, 'w')
509        file.write('''
510[inject-error]
511state = "1"
512event = "%s"
513errno = "%d"
514immediately = "off"
515once = "on"
516sector = "%d"
517
518[set-state]
519state = "1"
520event = "%s"
521new_state = "2"
522
523[set-state]
524state = "2"
525event = "%s"
526new_state = "1"
527''' % (event, errno, self.STREAM_BUFFER_SIZE / 512, event, event))
528        file.close()
529
530class TestEIO(TestErrors):
531    def setUp(self):
532        self.blkdebug_file = backing_img + ".blkdebug"
533        iotests.create_image(backing_img, TestErrors.image_len)
534        self.create_blkdebug_file(self.blkdebug_file, "read_aio", 5)
535        qemu_img('create', '-f', iotests.imgfmt,
536                 '-o', 'backing_file=blkdebug:%s:%s,backing_fmt=raw'
537                       % (self.blkdebug_file, backing_img),
538                 test_img)
539        self.vm = iotests.VM().add_drive(test_img)
540        self.vm.launch()
541
542    def tearDown(self):
543        self.vm.shutdown()
544        os.remove(test_img)
545        os.remove(backing_img)
546        os.remove(self.blkdebug_file)
547
548    def test_report(self):
549        self.assert_no_active_block_jobs()
550
551        result = self.vm.qmp('block-stream', device='drive0')
552        self.assert_qmp(result, 'return', {})
553
554        completed = False
555        error = False
556        while not completed:
557            for event in self.vm.get_qmp_events(wait=True):
558                if event['event'] == 'BLOCK_JOB_ERROR':
559                    self.assert_qmp(event, 'data/device', 'drive0')
560                    self.assert_qmp(event, 'data/operation', 'read')
561                    error = True
562                elif event['event'] == 'BLOCK_JOB_COMPLETED':
563                    self.assertTrue(error, 'job completed unexpectedly')
564                    self.assert_qmp(event, 'data/type', 'stream')
565                    self.assert_qmp(event, 'data/device', 'drive0')
566                    self.assert_qmp(event, 'data/error', 'Input/output error')
567                    self.assert_qmp(event, 'data/offset', self.STREAM_BUFFER_SIZE)
568                    self.assert_qmp(event, 'data/len', self.image_len)
569                    completed = True
570
571        self.assert_no_active_block_jobs()
572        self.vm.shutdown()
573
574    def test_ignore(self):
575        self.assert_no_active_block_jobs()
576
577        result = self.vm.qmp('block-stream', device='drive0', on_error='ignore')
578        self.assert_qmp(result, 'return', {})
579
580        error = False
581        completed = False
582        while not completed:
583            for event in self.vm.get_qmp_events(wait=True):
584                if event['event'] == 'BLOCK_JOB_ERROR':
585                    error = True
586                    self.assert_qmp(event, 'data/device', 'drive0')
587                    self.assert_qmp(event, 'data/operation', 'read')
588                    result = self.vm.qmp('query-block-jobs')
589                    if result == {'return': []}:
590                        # Job finished too quickly
591                        continue
592                    self.assert_qmp(result, 'return[0]/paused', False)
593                elif event['event'] == 'BLOCK_JOB_COMPLETED':
594                    self.assertTrue(error, 'job completed unexpectedly')
595                    self.assert_qmp(event, 'data/type', 'stream')
596                    self.assert_qmp(event, 'data/device', 'drive0')
597                    self.assert_qmp(event, 'data/error', 'Input/output error')
598                    self.assert_qmp(event, 'data/offset', self.image_len)
599                    self.assert_qmp(event, 'data/len', self.image_len)
600                    completed = True
601
602        self.assert_no_active_block_jobs()
603        self.vm.shutdown()
604
605    def test_stop(self):
606        self.assert_no_active_block_jobs()
607
608        result = self.vm.qmp('block-stream', device='drive0', on_error='stop')
609        self.assert_qmp(result, 'return', {})
610
611        error = False
612        completed = False
613        while not completed:
614            for event in self.vm.get_qmp_events(wait=True):
615                if event['event'] == 'BLOCK_JOB_ERROR':
616                    error = True
617                    self.assert_qmp(event, 'data/device', 'drive0')
618                    self.assert_qmp(event, 'data/operation', 'read')
619
620                    result = self.vm.qmp('query-block-jobs')
621                    self.assert_qmp(result, 'return[0]/paused', True)
622                    self.assert_qmp(result, 'return[0]/offset', self.STREAM_BUFFER_SIZE)
623                    self.assert_qmp(result, 'return[0]/io-status', 'failed')
624
625                    result = self.vm.qmp('block-job-resume', device='drive0')
626                    self.assert_qmp(result, 'return', {})
627
628                    result = self.vm.qmp('query-block-jobs')
629                    if result == {'return': []}:
630                        # Race; likely already finished. Check.
631                        continue
632                    self.assert_qmp(result, 'return[0]/paused', False)
633                    self.assert_qmp(result, 'return[0]/io-status', 'ok')
634                elif event['event'] == 'BLOCK_JOB_COMPLETED':
635                    self.assertTrue(error, 'job completed unexpectedly')
636                    self.assert_qmp(event, 'data/type', 'stream')
637                    self.assert_qmp(event, 'data/device', 'drive0')
638                    self.assert_qmp_absent(event, 'data/error')
639                    self.assert_qmp(event, 'data/offset', self.image_len)
640                    self.assert_qmp(event, 'data/len', self.image_len)
641                    completed = True
642
643        self.assert_no_active_block_jobs()
644        self.vm.shutdown()
645
646    def test_enospc(self):
647        self.assert_no_active_block_jobs()
648
649        result = self.vm.qmp('block-stream', device='drive0', on_error='enospc')
650        self.assert_qmp(result, 'return', {})
651
652        completed = False
653        error = False
654        while not completed:
655            for event in self.vm.get_qmp_events(wait=True):
656                if event['event'] == 'BLOCK_JOB_ERROR':
657                    self.assert_qmp(event, 'data/device', 'drive0')
658                    self.assert_qmp(event, 'data/operation', 'read')
659                    error = True
660                elif event['event'] == 'BLOCK_JOB_COMPLETED':
661                    self.assertTrue(error, 'job completed unexpectedly')
662                    self.assert_qmp(event, 'data/type', 'stream')
663                    self.assert_qmp(event, 'data/device', 'drive0')
664                    self.assert_qmp(event, 'data/error', 'Input/output error')
665                    self.assert_qmp(event, 'data/offset', self.STREAM_BUFFER_SIZE)
666                    self.assert_qmp(event, 'data/len', self.image_len)
667                    completed = True
668
669        self.assert_no_active_block_jobs()
670        self.vm.shutdown()
671
672class TestENOSPC(TestErrors):
673    def setUp(self):
674        self.blkdebug_file = backing_img + ".blkdebug"
675        iotests.create_image(backing_img, TestErrors.image_len)
676        self.create_blkdebug_file(self.blkdebug_file, "read_aio", 28)
677        qemu_img('create', '-f', iotests.imgfmt,
678                 '-o', 'backing_file=blkdebug:%s:%s,backing_fmt=raw'
679                       % (self.blkdebug_file, backing_img),
680                 test_img)
681        self.vm = iotests.VM().add_drive(test_img)
682        self.vm.launch()
683
684    def tearDown(self):
685        self.vm.shutdown()
686        os.remove(test_img)
687        os.remove(backing_img)
688        os.remove(self.blkdebug_file)
689
690    def test_enospc(self):
691        self.assert_no_active_block_jobs()
692
693        result = self.vm.qmp('block-stream', device='drive0', on_error='enospc')
694        self.assert_qmp(result, 'return', {})
695
696        error = False
697        completed = False
698        while not completed:
699            for event in self.vm.get_qmp_events(wait=True):
700                if event['event'] == 'BLOCK_JOB_ERROR':
701                    self.assert_qmp(event, 'data/device', 'drive0')
702                    self.assert_qmp(event, 'data/operation', 'read')
703                    error = True
704
705                    result = self.vm.qmp('query-block-jobs')
706                    self.assert_qmp(result, 'return[0]/paused', True)
707                    self.assert_qmp(result, 'return[0]/offset', self.STREAM_BUFFER_SIZE)
708                    self.assert_qmp(result, 'return[0]/io-status', 'nospace')
709
710                    result = self.vm.qmp('block-job-resume', device='drive0')
711                    self.assert_qmp(result, 'return', {})
712
713                    result = self.vm.qmp('query-block-jobs')
714                    if result == {'return': []}:
715                        # Race; likely already finished. Check.
716                        continue
717                    self.assert_qmp(result, 'return[0]/paused', False)
718                    self.assert_qmp(result, 'return[0]/io-status', 'ok')
719                elif event['event'] == 'BLOCK_JOB_COMPLETED':
720                    self.assertTrue(error, 'job completed unexpectedly')
721                    self.assert_qmp(event, 'data/type', 'stream')
722                    self.assert_qmp(event, 'data/device', 'drive0')
723                    self.assert_qmp_absent(event, 'data/error')
724                    self.assert_qmp(event, 'data/offset', self.image_len)
725                    self.assert_qmp(event, 'data/len', self.image_len)
726                    completed = True
727
728        self.assert_no_active_block_jobs()
729        self.vm.shutdown()
730
731class TestStreamStop(iotests.QMPTestCase):
732    image_len = 8 * 1024 * 1024 * 1024 # GB
733
734    def setUp(self):
735        qemu_img('create', backing_img, str(TestStreamStop.image_len))
736        qemu_io('-f', 'raw', '-c', 'write -P 0x1 0 32M', backing_img)
737        qemu_img('create', '-f', iotests.imgfmt, '-o', 'backing_file=%s' % backing_img, test_img)
738        qemu_io('-f', iotests.imgfmt, '-c', 'write -P 0x1 32M 32M', test_img)
739        self.vm = iotests.VM().add_drive("blkdebug::" + test_img)
740        self.vm.launch()
741
742    def tearDown(self):
743        self.vm.shutdown()
744        os.remove(test_img)
745        os.remove(backing_img)
746
747    def test_stream_stop(self):
748        self.assert_no_active_block_jobs()
749
750        self.vm.pause_drive('drive0')
751        result = self.vm.qmp('block-stream', device='drive0')
752        self.assert_qmp(result, 'return', {})
753
754        time.sleep(0.1)
755        events = self.vm.get_qmp_events(wait=False)
756        self.assertEqual(events, [], 'unexpected QMP event: %s' % events)
757
758        self.cancel_and_wait(resume=True)
759
760class TestSetSpeed(iotests.QMPTestCase):
761    image_len = 80 * 1024 * 1024 # MB
762
763    def setUp(self):
764        qemu_img('create', backing_img, str(TestSetSpeed.image_len))
765        qemu_io('-f', 'raw', '-c', 'write -P 0x1 0 32M', backing_img)
766        qemu_img('create', '-f', iotests.imgfmt, '-o', 'backing_file=%s' % backing_img, test_img)
767        qemu_io('-f', iotests.imgfmt, '-c', 'write -P 0x1 32M 32M', test_img)
768        self.vm = iotests.VM().add_drive('blkdebug::' + test_img)
769        self.vm.launch()
770
771    def tearDown(self):
772        self.vm.shutdown()
773        os.remove(test_img)
774        os.remove(backing_img)
775
776    # This is a short performance test which is not run by default.
777    # Invoke "IMGFMT=qed ./030 TestSetSpeed.perf_test_throughput"
778    def perf_test_throughput(self):
779        self.assert_no_active_block_jobs()
780
781        result = self.vm.qmp('block-stream', device='drive0')
782        self.assert_qmp(result, 'return', {})
783
784        result = self.vm.qmp('block-job-set-speed', device='drive0', speed=8 * 1024 * 1024)
785        self.assert_qmp(result, 'return', {})
786
787        self.wait_until_completed()
788
789        self.assert_no_active_block_jobs()
790
791    def test_set_speed(self):
792        self.assert_no_active_block_jobs()
793
794        self.vm.pause_drive('drive0')
795        result = self.vm.qmp('block-stream', device='drive0')
796        self.assert_qmp(result, 'return', {})
797
798        # Default speed is 0
799        result = self.vm.qmp('query-block-jobs')
800        self.assert_qmp(result, 'return[0]/device', 'drive0')
801        self.assert_qmp(result, 'return[0]/speed', 0)
802
803        result = self.vm.qmp('block-job-set-speed', device='drive0', speed=8 * 1024 * 1024)
804        self.assert_qmp(result, 'return', {})
805
806        # Ensure the speed we set was accepted
807        result = self.vm.qmp('query-block-jobs')
808        self.assert_qmp(result, 'return[0]/device', 'drive0')
809        self.assert_qmp(result, 'return[0]/speed', 8 * 1024 * 1024)
810
811        self.cancel_and_wait(resume=True)
812        self.vm.pause_drive('drive0')
813
814        # Check setting speed in block-stream works
815        result = self.vm.qmp('block-stream', device='drive0', speed=4 * 1024 * 1024)
816        self.assert_qmp(result, 'return', {})
817
818        result = self.vm.qmp('query-block-jobs')
819        self.assert_qmp(result, 'return[0]/device', 'drive0')
820        self.assert_qmp(result, 'return[0]/speed', 4 * 1024 * 1024)
821
822        self.cancel_and_wait(resume=True)
823
824    def test_set_speed_invalid(self):
825        self.assert_no_active_block_jobs()
826
827        result = self.vm.qmp('block-stream', device='drive0', speed=-1)
828        self.assert_qmp(result, 'error/class', 'GenericError')
829
830        self.assert_no_active_block_jobs()
831
832        self.vm.pause_drive('drive0')
833        result = self.vm.qmp('block-stream', device='drive0')
834        self.assert_qmp(result, 'return', {})
835
836        result = self.vm.qmp('block-job-set-speed', device='drive0', speed=-1)
837        self.assert_qmp(result, 'error/class', 'GenericError')
838
839        self.cancel_and_wait(resume=True)
840
841if __name__ == '__main__':
842    iotests.main(supported_fmts=['qcow2', 'qed'])
843