diff options
| author | Philippe Mathieu-Daudé <philmd@linaro.org> | 2024-11-11 18:03:32 +0100 |
|---|---|---|
| committer | Kevin Wolf <kwolf@redhat.com> | 2025-02-06 13:59:00 +0100 |
| commit | 84d388c22b8e34981539fd3c69f84099f1824f1f (patch) | |
| tree | 3c7f05e2d969d13b0f9d544108187d3d35157345 | |
| parent | 558d8eb7f32dda8634e0d3e82ac36e00bf61c9ee (diff) | |
| download | qemu-84d388c22b8e34981539fd3c69f84099f1824f1f.zip qemu-84d388c22b8e34981539fd3c69f84099f1824f1f.tar.gz qemu-84d388c22b8e34981539fd3c69f84099f1824f1f.tar.bz2 | |
block: Improve blk_get_attached_dev_id() docstring
Expose the method docstring in the header, and mention
returned value must be free'd by caller.
Reported-by: Fabiano Rosas <farosas@suse.de>
Signed-off-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Message-ID: <20241111170333.43833-2-philmd@linaro.org>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
| -rw-r--r-- | block/block-backend.c | 12 | ||||
| -rw-r--r-- | include/system/block-backend-io.h | 7 |
2 files changed, 15 insertions, 4 deletions
diff --git a/block/block-backend.c b/block/block-backend.c index c93a752..789fc6d 100644 --- a/block/block-backend.c +++ b/block/block-backend.c @@ -1019,6 +1019,10 @@ DeviceState *blk_get_attached_dev(BlockBackend *blk) return blk->dev; } +/* + * The caller is responsible for releasing the value returned + * with g_free() after use. + */ static char *blk_get_attached_dev_id_or_path(BlockBackend *blk, bool want_id) { DeviceState *dev = blk->dev; @@ -1033,15 +1037,15 @@ static char *blk_get_attached_dev_id_or_path(BlockBackend *blk, bool want_id) return object_get_canonical_path(OBJECT(dev)) ?: g_strdup(""); } -/* - * Return the qdev ID, or if no ID is assigned the QOM path, of the block - * device attached to the BlockBackend. - */ char *blk_get_attached_dev_id(BlockBackend *blk) { return blk_get_attached_dev_id_or_path(blk, true); } +/* + * The caller is responsible for releasing the value returned + * with g_free() after use. + */ static char *blk_get_attached_dev_path(BlockBackend *blk) { return blk_get_attached_dev_id_or_path(blk, false); diff --git a/include/system/block-backend-io.h b/include/system/block-backend-io.h index d174275..ba8dfcc 100644 --- a/include/system/block-backend-io.h +++ b/include/system/block-backend-io.h @@ -32,6 +32,13 @@ void blk_set_allow_aio_context_change(BlockBackend *blk, bool allow); void blk_set_disable_request_queuing(BlockBackend *blk, bool disable); bool blk_iostatus_is_enabled(const BlockBackend *blk); +/* + * Return the qdev ID, or if no ID is assigned the QOM path, + * of the block device attached to the BlockBackend. + * + * The caller is responsible for releasing the value returned + * with g_free() after use. + */ char *blk_get_attached_dev_id(BlockBackend *blk); BlockAIOCB *blk_aio_pwrite_zeroes(BlockBackend *blk, int64_t offset, |