Skip to content

block layer: split block APIs in global state and I/O

Emanuele Giuseppe Esposito qemu-devel 8 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v8 Latest31 patches 1 replyIn review
  2. v731 patches 3 repliesSuperseded
  3. v633 patches 51 repliesSuperseded
Earlier versions · 5
VersionPostedPatchesRepliesStatus
v531 patches34 repliesSuperseded
v425 patches60 repliesSuperseded
v325 patches13 repliesSuperseded
v2 RFC25 patches48 repliesSuperseded
v1 RFC4 patches13 repliesSuperseded

Changes in v8 from the cover letter

bdrv_get_full_backing_filename to GLOBAL_STATE_CODE blk_iostatus_is_enabled in IO_CODE blk_iostatus_set_err in IO_CODE bdrv_apply_auto_read_only in IO_CODE bdrv_can_set_read_only in IO_CODE
blk_drain to GLOBAL_STATE_CODE

Patches in v8 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/31main-loop.h: introduce qemu_in_main_thread()include/qemu/main-loop.h softmmu/cpus.c stubs/iothread-lock.c+34 -00 replies
2/31main loop: macros to mark GS and I/O functionsinclude/qemu/main-loop.h+18 -00 replies
3/31include/block/block: split header into I/O and global state APIblock.c block/meson.build include/block/block-common.h +3 more+1070 -8580 replies
4/31assertions for block global state APIblock.c block/commit.c block/io.c +1 more+136 -20 replies
5/31IO_CODE and IO_OR_GS_CODE for block I/O APIblock.c block/dirty-bitmap.c block/io.c +1 more+80 -30 replies
6/31block/export/fuse.c: allow writable exports to take RESIZE permissionblock/export/fuse.c+18 -70 replies
7/31include/sysemu/block-backend: split header into I/O and global state (GS) APIblock/block-backend.c include/sysemu/block-backend-common.h include/sysemu/block-backend-global-state.h +2 more+368 -2690 replies
8/31block/block-backend.c: assertions for block-backendblock/block-backend.c softmmu/qdev-monitor.c+80 -00 replies
9/31IO_CODE and IO_OR_GS_CODE for block-backend I/O APIblock/block-backend.c include/sysemu/block-backend-io.h+60 -00 replies
10/31block.c: assertions to the block layer permissions APIblock.c+12 -00 replies
11/31include/block/block_int: split header into I/O and global state APIblockdev.c include/block/block_int-common.h include/block/block_int-global-state.h +2 more+1679 -14860 replies
12/31assertions for block_int global state APIblock.c block/backup.c block/block-backend.c +7 more+42 -00 replies
13/31IO_CODE and IO_OR_GS_CODE for block_int I/O APIblock.c block/block-backend.c block/dirty-bitmap.c +2 more+37 -10 replies
14/31block: introduce assert_bdrv_graph_writableblock.c include/block/block_int-global-state.h+21 -00 replies
15/31include/block/blockjob_int.h: split header into I/O and GS APIinclude/block/blockjob_int.h+28 -00 replies
16/31GS and IO CODE macros for blockjob_int.hblockjob.c+5 -00 replies
17/31block.c: add assertions to static functionsblock.c block/block-backend.c+48 -10 replies
18/31include/block/blockjob.h: global state APIinclude/block/blockjob.h+22 -70 replies
19/31assertions for blockjob.h global state APIblockjob.c+11 -00 replies
20/31include/sysemu/blockdev.h: global state APIinclude/sysemu/blockdev.h+10 -30 replies
21/31assertions for blockdev.h global state APIblock/block-backend.c blockdev.c+19 -00 replies
22/31include/block/snapshot: global state API + assertionsblock/snapshot.c include/block/snapshot.h migration/savevm.c+41 -20 replies
23/31block/copy-before-write.h: global state API + assertionsblock/copy-before-write.c block/copy-before-write.h+9 -00 replies
24/31block/coroutines: I/O and "I/O or GS" APIblock.c block/block-backend.c block/coroutines.h +2 more+64 -290 replies
25/31block_int-common.h: split function pointers in BlockDriverinclude/block/block_int-common.h+237 -2080 replies
26/31block_int-common.h: assertions in the callers of BlockDriver function pointersblock.c block/create.c+19 -00 replies
27/31block_int-common.h: split function pointers in BdrvChildClassinclude/block/block_int-common.h+47 -340 replies
28/31block_int-common.h: assertions in the callers of BdrvChildClass function pointersblock.c+9 -10 replies
29/31block-backend-common.h: split function pointers in BlockDevOpsinclude/sysemu/block-backend-common.h+23 -50 replies
30/31job.h: split function pointers in JobDriverinclude/qemu/job.h+22 -00 replies
31/31job.h: assertions in the callers of JobDriver function pointersjob.c+10 -00 replies

Reviews trailers per patch

3 of 31 patches have a Reviewed-by or Acked-by.

PatchStefan HajnocziHanna ReitzPhilippe Mathieu-Daudé
1/31
2/31
3/31
4/31
5/31
6/31R-b
7/31
8/31
9/31
10/31
11/31
12/31
13/31
14/31
15/31R-b
16/31
17/31
18/31
19/31
20/31
21/31
22/31
23/31
24/31
25/31
26/31
27/31
28/31
29/31R-b R-b
30/31
31/31

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes. Scroll the table sideways for all 3 reviewers.

Read the v8 thread

Cover letter [PATCH v8 00/31] block layer: split block APIs in global state and I/O

Currently, block layer APIs like block.h contain a mix of functions that are either running in the main loop and under the BQL, or are thread-safe functions and run in iothreads performing I/O. The functions running under BQL also take care of modifying the block graph, by using drain and/or aio_context_acquire/release. This makes it very confusing to understand where each function runs, and what assumptions it provided with regards to thread safety.

We call the functions running under BQL "global state (GS) API", and distinguish them from the thread-safe "I/O API".

The aim of this series is to split the relevant block headers in global state and I/O sub-headers. The division will be done in this way:
header.h will be split in header-global-state.h, header-io.h and header-common.h. The latter will just contain the data structures needed by header-global-state and header-io, and common helpers that are neither in GS nor in I/O. header.h will remain for legacy and to avoid changing all includes in all QEMU c files, but will only include the two new headers. No function shall be added in header.c .
Once we split all relevant headers, it will be much easier to see what uses the AioContext lock and remove it, which is the overall main goal of this and other series that I posted/will post.

In addition to splitting the relevant headers shown in this series, it is also very helpful splitting the function pointers in some block structures, to understand what runs under AioContext lock and what doesn't. This is what patches 21-27 do.

Each function in the GS API will have an assertion, checking that it is always running under BQL.
I/O functions are instead thread safe (or so should be), meaning that they *can* run under BQL, but also in an iothread in another AioContext. Therefore they do not provide any assertion, and need to be audited manually to verify the correctness.

Adding assetions has helped finding 2 bugs already, as shown in my series "Migration: fix missing iothread locking".

Tested this series by running unit tests, qemu-iotests and qtests (x86_64).
Some functions in the GS API are used everywhere but not properly tested. Therefore their assertion is never actually run in the tests, so despite my very careful auditing, it is not impossible to exclude that some will trigger while actually using QEMU.

Patch 1 introduces qemu_in_main_thread(), the function used in all assertions. This had to be introduced otherwise all unit tests would fail, since they run in the main loop but use the code in stubs/iothread.c
Patches 2-27 (with the exception of patch 9-10, that are an additional assert) are all structured in the same way: first we split the header and in the next (or same, if small) patch we add assertions. Patch 28-31 take care instead of the block layer permission API, fixing some bugs where they are used in I/O functions.

This serie depends on my previous serie "block layer: permission API refactoring in preparation to the API split"

Based-on: <[email protected]>

---
v8:
bdrv_get_full_backing_filename to GLOBAL_STATE_CODE blk_iostatus_is_enabled in IO_CODE blk_iostatus_set_err in IO_CODE bdrv_apply_auto_read_only in IO_CODE bdrv_can_set_read_only in IO_CODE
blk_drain to GLOBAL_STATE_CODE

v7:
* crypto permissions and bdrv-activate patches sent in another serie
* (*bdrv_probe) and (*get_name) are I/O
* add missing license header in block-common.h
* in block-common.h:
bdrv_parse_cache_mode
bdrv_parse_discard_flags
bdrv_perm_names
bdrv_qapi_perm_to_blk_perm
bdrv_init_with_whitelist
bdrv_uses_whitelist
bdrv_is_whitelisted
* in block-io.h:
bdrv_get_full_backing_filename
bdrv_make_zero
bdrv_aio_cancel
* Introduce new "Global OR I/O" category for the functions using BDRV_POLL_WHILE
Functions in this category:
BDRV_POLL_WHILE
bdrv_drain
bdrv_co_drain
bdrv_truncate
bdrv_check
bdrv_invalidate_cache
bdrv_flush
bdrv_pdiscard
bdrv_readv_vmstate
bdrv_writev_vmstate
bdrv_parent_drained_begin_single bdrv_parent_drained_end_single
bdrv_drain_poll
bdrv_drained_begin
bdrv_do_drained_begin_quiesce
bdrv_subtree_drained_begin
bdrv_drained_end
bdrv_drained_end_no_poll
bdrv_subtree_drained_end
* better comment descriptions of common, GS, I/O and "I/O or GS" categories
* remove job_pre_run, we don't really need it.
* insert assertion GLOBAL_STATE_CODE, IO_CODE and IO_OR_GS_CODE macros
* replace all assert(qemu_in_main_thread()) with GLOBAL_STATE_CODE
* use IO_CODE and IO_OR_GS_CODE assertions, in additional patches

v6:
* Additional assertions in "block.c: add assertions to static functions"
* bdrv_co_invalidate_cache: create a new GS function bdrv_activate, and move all GS logic of bdrv_co_invalidate_cache there, so that the coroutine only runs I/O code. Move the resulting 3 patches before "block/coroutines: I/O API"
* crypto (patch 30): introduce bdrv_amend_pre_run and bdrv_clean, along with job_pre_run and job_clean to be sure of setting the permissions in GS
* remove TODO in blk_{get/set}_perm, and handle the RESIZE permission in patch 6
* in I/O:

    blk_ioctl
    blk_get_attached_dev_id
    blk_enable_write_cache
    blk_set_guest_block_size
    blk_lock_medium
    bdrv_lock_medium
    (*bdrv_lock_medium)
    blk_eject
    bdrv_eject
    (*bdrv_eject)
    bdrv_probe_all

* patch 13 just move an assertion before the variable assignment, and not after.
* remove patch 10 (block.c: modify .attach and .detach callbacks of child_of_bds), as it is not necessary.

v5:
* In short, apply all Hanna's comments. More in details, the following functions in the following headers have been moved:
block-backend:
blk_replace_bs (to gs)
blk_nb_sectors (to io)
blk_name (to io)
blk_set_perm (to io)
blk_get_perm (to io)
blk_drain (to io)
blk_abort_aio_request (to io)
blk_make_empty (to gs)
blk_invalidate_cache (was in io, but had GS assertion) blk_aio_cancel (to gs)
block:
bdrv_replace_child_bs (to gs)
bdrv_get_device_name (to io) bdrv_get_device_or_node_name (to io) bdrv_drained_end_no_poll (to io)
bdrv_block_status (was in io, but had GS assertion) bdrv_drain (to io)
bdrv_co_drain (to io)
bdrv_make_zero (was in GS, but did not have the assertion) bdrv_save_vmstate (to io)
bdrv_load_vmstate (to io)
bdrv_aio_cancel_async (to io)
block_int:
bdrv_get_parent_name (to io) bdrv_apply_subtree_drain (to io) bdrv_unapply_subtree_drain (to io) bdrv_co_copy_range_from (was in io, but had GS assertion) bdrv_co_copy_range_to (was in io, but had GS assertion) ->bdrv_save_vmstate (to io)
->bdrv_load_vmstate (to io)

coding style (assertion after definitions):
bdrv_save_vmstate
bdrv_load_vmstate
block_job_next
block_job_get

new patches:
block.c: modify .attach and .detach callbacks of child_of_bds introduce pre_run as JobDriver callback to handle
bdrv_co_amend usage of permission function
leave blk_set/get_perm as a TODO in fuse.c
make sure bdrv_co_invalidate_cache does not use permissions
if BQL is not held

minor changes:
put back TODO for include block/block.h in block-backend-common.h rebase on kwolf/block branch
modify where are used assert_bdrv_graph_writable, due to rebase

v4:
* Moved the following functions from block-io to block-global-state (+ assertion):
- bdrv_apply_auto_read_only
- bdrv_can_set_read_only
* Moved the following functions from block-backend-io to block-backend-global-state (+ assertion):
- blk_ioctl
* added patch 4 to distinguish assertions added to static functions in block.c
* block/coroutines: it seems that blk_co_do_ioctl and blk_do_ioctl are global state too

v3:
* blockdev.h (patch 14): blockdev_mark_auto_del, blockdev_auto_del and blk_legacy_dinfo as GS API.
* add copyright header to block.h, block-io.h and block-global-state.h
* rebase on current master (c5b2f55981)

v2:
* rename "graph API" into "global state API"
* change order of patches, block.h comes before block-backend.h
* change GS and I/O comment headers to avoid redundancy, all other headers refer to block-global-state.h and block-io.h
* fix typo on GS and I/O headers
* use assert instead of g_assert
* move bdrv_pwrite_sync, bdrv_block_status and bdrv_co_copy_range_{from/to} to the I/O API
* change assert_bdrv_graph_writable implementation, since we need to introduce additional drains
* remove transactions API split
* add preparation patch for blockdev.h (patch 13)
* backup-top -> copy-on-write
* change I/O comment in job.h into a better meaningful explanation
* fix all warnings given by checkpatch, mostly due to /* */ to be split in separate lines
* rebase on current master (c09124dcb8), and split the following new functions:

	blk_replace_bs (I/O)
	bdrv_bsc_is_data (I/O)
	bdrv_bsc_invalidate_range (I/O)
	bdrv_bsc_fill (I/O)
	bdrv_new_open_driver_opts (GS)
	blk_get_max_hw_iov (I/O)

they are all added in patches 4 and 6.

v1:
* remove the iothread locking bug fix, and send it as separate patch
* rename graph API -> global state API
* better documented patch 1 (qemu_in_main_thread)
* add and split all other block layer headers
* fix warnings given by checkpatch on multiline comments

Emanuele Giuseppe Esposito (31):
main-loop.h: introduce qemu_in_main_thread()
main loop: macros to mark GS and I/O functions include/block/block: split header into I/O and global state API assertions for block global state API
IO_CODE and IO_OR_GS_CODE for block I/O API block/export/fuse.c: allow writable exports to take RESIZE permission include/sysemu/block-backend: split header into I/O and global state
(GS) API
block/block-backend.c: assertions for block-backend IO_CODE and IO_OR_GS_CODE for block-backend I/O API block.c: assertions to the block layer permissions API include/block/block_int: split header into I/O and global state API assertions for block_int global state API
IO_CODE and IO_OR_GS_CODE for block_int I/O API
block: introduce assert_bdrv_graph_writable include/block/blockjob_int.h: split header into I/O and GS API GS and IO CODE macros for blockjob_int.h
block.c: add assertions to static functions include/block/blockjob.h: global state API
assertions for blockjob.h global state API include/sysemu/blockdev.h: global state API
assertions for blockdev.h global state API include/block/snapshot: global state API + assertions block/copy-before-write.h: global state API + assertions block/coroutines: I/O and "I/O or GS" API block_int-common.h: split function pointers in BlockDriver block_int-common.h: assertions in the callers of BlockDriver function
pointers
block_int-common.h: split function pointers in BdrvChildClass block_int-common.h: assertions in the callers of BdrvChildClass
function pointers
block-backend-common.h: split function pointers in BlockDevOps job.h: split function pointers in JobDriver
job.h: assertions in the callers of JobDriver function pointers

 block.c                                     |  283 +++-
 block/backup.c                              |    1 +
 block/block-backend.c                       |  162 +-
 block/commit.c                              |    4 +
 block/copy-before-write.c                   |    2 +
 block/copy-before-write.h                   |    7 +
 block/coroutines.h                          |   81 +-
 block/create.c                              |    2 +
 block/dirty-bitmap.c                        |    5 +
 block/export/fuse.c                         |   25 +-
 block/io.c                                  |   71 +-
 block/meson.build                           |    7 +-
 block/mirror.c                              |    4 +
 block/monitor/bitmap-qmp-cmds.c             |    6 +
 block/nbd.c                                 |    1 +
 block/snapshot.c                            |   28 +
 block/stream.c                              |    2 +
 blockdev.c                                  |   29 +
 blockjob.c                                  |   16 +
 include/block/block-common.h                |  418 ++++++
 include/block/block-global-state.h          |  252 ++++
 include/block/block-io.h                    |  370 +++++
 include/block/block.h                       |  879 +----------
 include/block/block_int-common.h            | 1222 +++++++++++++++
 include/block/block_int-global-state.h      |  329 ++++
 include/block/block_int-io.h                |  185 +++
 include/block/block_int.h                   | 1489 +------------------
 include/block/blockjob.h                    |   29 +-
 include/block/blockjob_int.h                |   28 +
 include/block/snapshot.h                    |   13 +-
 include/qemu/job.h                          |   22 +
 include/qemu/main-loop.h                    |   42 +
 include/sysemu/block-backend-common.h       |  102 ++
 include/sysemu/block-backend-global-state.h |  116 ++
 include/sysemu/block-backend-io.h           |  161 ++
 include/sysemu/block-backend.h              |  269 +---
 include/sysemu/blockdev.h                   |   13 +-
 job.c                                       |   10 +
 migration/savevm.c                          |    2 +
 softmmu/cpus.c                              |    5 +
 softmmu/qdev-monitor.c                      |    2 +
 stubs/iothread-lock.c                       |    5 +
 42 files changed, 4031 insertions(+), 2668 deletions(-)
 create mode 100644 include/block/block-common.h
 create mode 100644 include/block/block-global-state.h
 create mode 100644 include/block/block-io.h
 create mode 100644 include/block/block_int-common.h
 create mode 100644 include/block/block_int-global-state.h
 create mode 100644 include/block/block_int-io.h
 create mode 100644 include/sysemu/block-backend-common.h
 create mode 100644 include/sysemu/block-backend-global-state.h
 create mode 100644 include/sysemu/block-backend-io.h
Signature · 1 line
2.31.1