From: "Philippe Mathieu-Daudé" <philmd@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Kevin Wolf" <kwolf@redhat.com>, "Fam Zheng" <fam@euphon.net>,
qemu-block@nongnu.org, "Maxim Levitsky" <mlevitsk@redhat.com>,
"Keith Busch" <keith.busch@intel.com>,
"Stefan Hajnoczi" <stefanha@redhat.com>,
"Max Reitz" <mreitz@redhat.com>,
"Philippe Mathieu-Daudé" <philmd@redhat.com>
Subject: [PATCH 3/6] sysemu/block-backend: Document blk_read()/blk_pwrite()
Date: Mon, 4 May 2020 11:46:38 +0200 [thread overview]
Message-ID: <20200504094641.4963-4-philmd@redhat.com> (raw)
In-Reply-To: <20200504094641.4963-1-philmd@redhat.com>
The blk_read()/blk_pwrite() return value is not obvious,
document it.
Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com>
---
include/sysemu/block-backend.h | 24 ++++++++++++++++++++++++
1 file changed, 24 insertions(+)
diff --git a/include/sysemu/block-backend.h b/include/sysemu/block-backend.h
index f2dcf63ae3..823b8e94a7 100644
--- a/include/sysemu/block-backend.h
+++ b/include/sysemu/block-backend.h
@@ -153,7 +153,31 @@ BlockAIOCB *blk_aio_pwrite_zeroes(BlockBackend *blk, int64_t offset,
int bytes, BdrvRequestFlags flags,
BlockCompletionFunc *cb, void *opaque);
int blk_make_zero(BlockBackend *blk, BdrvRequestFlags flags);
+
+/**
+ * blk_pread:
+ *
+ * @blk - the block backend where the buffer content is going to be read from
+ * @offset: position in bytes to read at
+ * @buf: the data buffer
+ * @bytes: number of bytes to read
+ *
+ * Returns: the number of bytes read on success, or a negative errno otherwise.
+ */
int blk_pread(BlockBackend *blk, int64_t offset, void *buf, int bytes);
+
+/**
+ * blk_pwrite:
+ *
+ * @blk - the block backend where the buffer content is going to be written to
+ * @offset: position in bytes to write at
+ * @buf: the data buffer
+ * @bytes: number of bytes of @buf to write
+ * @flags: request flags
+ *
+ * Returns: the number of bytes consumed on success,
+ * or a negative errno otherwise.
+ */
int blk_pwrite(BlockBackend *blk, int64_t offset, const void *buf, int bytes,
BdrvRequestFlags flags);
int64_t blk_getlength(BlockBackend *blk);
--
2.21.3
next prev parent reply other threads:[~2020-05-04 9:51 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-04 9:46 [PATCH 0/6] block/nvme: Align block pages queue to host page size Philippe Mathieu-Daudé
2020-05-04 9:46 ` [PATCH 1/6] qemu/osdep: Document qemu_memalign() and friends Philippe Mathieu-Daudé
2020-05-07 8:58 ` Stefan Hajnoczi
2020-05-04 9:46 ` [PATCH 2/6] qemu/bitmap: Document bitmap_new() returned pointer Philippe Mathieu-Daudé
2020-05-07 8:58 ` Stefan Hajnoczi
2020-05-04 9:46 ` Philippe Mathieu-Daudé [this message]
2020-05-07 8:56 ` [PATCH 3/6] sysemu/block-backend: Document blk_read()/blk_pwrite() Stefan Hajnoczi
2020-05-04 9:46 ` [PATCH 4/6] block/block: Document BlockSizes fields Philippe Mathieu-Daudé
2020-05-07 8:58 ` Stefan Hajnoczi
2020-05-04 9:46 ` [PATCH 5/6] block/nvme: Align block pages queue to host page size Philippe Mathieu-Daudé
2020-05-05 0:34 ` David Gibson
2020-05-05 8:00 ` Laurent Vivier
2020-05-05 8:23 ` Laurent Vivier
2020-05-05 9:48 ` Philippe Mathieu-Daudé
2020-05-05 15:51 ` Philippe Mathieu-Daudé
2020-05-04 9:46 ` [RFC PATCH 6/6] hw/block/nvme: Make device target agnostic Philippe Mathieu-Daudé
2020-05-04 15:36 ` Philippe Mathieu-Daudé
2020-05-07 10:04 ` Stefan Hajnoczi
2020-05-07 16:24 ` Paolo Bonzini
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200504094641.4963-4-philmd@redhat.com \
--to=philmd@redhat.com \
--cc=fam@euphon.net \
--cc=keith.busch@intel.com \
--cc=kwolf@redhat.com \
--cc=mlevitsk@redhat.com \
--cc=mreitz@redhat.com \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
--cc=stefanha@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).