From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: passt.top; dmarc=none (p=none dis=none) header.from=gibson.dropbear.id.au Authentication-Results: passt.top; dkim=pass (2048-bit key; secure) header.d=gibson.dropbear.id.au header.i=@gibson.dropbear.id.au header.a=rsa-sha256 header.s=202510 header.b=rnO27meM; dkim-atps=neutral Received: from mail.ozlabs.org (mail.ozlabs.org [IPv6:2404:9400:2221:ea00::3]) by passt.top (Postfix) with ESMTPS id 944345A061D for ; Fri, 05 Dec 2025 04:09:45 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gibson.dropbear.id.au; s=202510; t=1764904182; bh=nV1CwXgTySFw2V+gSkVc2v6OpzdO7qgGs/YXbEV48Zk=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=rnO27meMLekVGyvOXVZ8DnSRdZkfuFFinqumRe2lLjyQr+E2T95e/CSqn/jYOUNK0 Srpd8NIWZDTL6YuAErEcoxTyML4yuqhYrCgSQS0kwlfzRWmSwdki76YC1mKofVAWTX Qw7cO4jchPTK1HbxvJ4xfvmzTJswwHePH/h6S3tFk7cWEx37xK5jp9wMrhTNR5ywJD G+v3962Yl4eD/7R1hA7R6tBUC0VBw13GeF6QKqlpkNuTGO294sft8AqW6q++lxOVpf UFzjRabH5+soIgiuRkcmj/6vy5blbma4+0OlWRSsjoNBi3FtQ6l6o0XN/j28+eFQ5+ sK8vncstDB5+g== Received: by gandalf.ozlabs.org (Postfix, from userid 1007) id 4dMxF207Rbz4wHW; Fri, 05 Dec 2025 14:09:42 +1100 (AEDT) Date: Fri, 5 Dec 2025 13:58:53 +1100 From: David Gibson To: Stefano Brivio Subject: Re: [PATCH] iov: Fix coding style of basic (non-IOV_TAIL) parts Message-ID: References: <20251205005111.2577267-1-sbrivio@redhat.com> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha512; protocol="application/pgp-signature"; boundary="peUXdmyz+gNGPQvj" Content-Disposition: inline In-Reply-To: <20251205005111.2577267-1-sbrivio@redhat.com> Message-ID-Hash: HJAMK3ZQRABEVOE4K47QQQF2HTBK2M7S X-Message-ID-Hash: HJAMK3ZQRABEVOE4K47QQQF2HTBK2M7S X-MailFrom: dgibson@gandalf.ozlabs.org X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header CC: passt-dev@passt.top, Laurent Vivier X-Mailman-Version: 3.3.8 Precedence: list List-Id: Development discussion and patches for passt Archived-At: Archived-At: List-Archive: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: --peUXdmyz+gNGPQvj Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Fri, Dec 05, 2025 at 01:51:11AM +0100, Stefano Brivio wrote: > I happened to touch these functions for a change that turned out to be > unnecessary, but coding style and documentation could still benefit > from some rephrasing and fixes. >=20 > Signed-off-by: Stefano Brivio Reviewed-by: David Gibson One nit below.. > --- > iov.c | 68 +++++++++++++++++++++++++---------------------------------- > 1 file changed, 29 insertions(+), 39 deletions(-) >=20 > diff --git a/iov.c b/iov.c > index 8c74a59..d31464d 100644 > --- a/iov.c > +++ b/iov.c > @@ -20,24 +20,21 @@ > * Contributions after 2012-01-13 are licensed under the terms of the > * GNU GPL, version 2 or (at your option) any later version. > */ > + > #include > =20 > #include "util.h" > #include "iov.h" > =20 > - > /** > - * iov_skip_bytes() - Skip leading bytes of an IO vector > - * @iov: IO vector > + * iov_skip_bytes() - Find index and offset in iovec array given byte of= fset > + * @iov: iovec array > * @n: Number of entries in @iov > - * @skip: Number of leading bytes of @iov to skip > - * @offset: Offset of first unskipped byte in its @iov entry > + * @skip: Byte offset: leading bytes of @iov to skip > + * @offset: Offset within matching @iov entry, set on return, can be NULL > * > - * Return: index I of individual struct iovec which contains the byte at= @skip > - * bytes into the vector (as though all its buffers were contigu= ous). > - * If @offset is non-NULL, update it to the offset of that byte = within > - * @iov[I] (guaranteed to be less than @iov[I].iov_len) If the w= hole > - * vector has <=3D @skip bytes, return @n. > + * Return: index of iovec array containing the @skip byte counted as if = buffers > + * were contiguous. If iovec has less than @skip bytes, return @n. > */ > size_t iov_skip_bytes(const struct iovec *iov, size_t n, > size_t skip, size_t *offset) > @@ -57,17 +54,14 @@ size_t iov_skip_bytes(const struct iovec *iov, size_t= n, > } > =20 > /** > - * iov_from_buf() - Copy data from a buffer to an I/O vector (struct iov= ec) > - * efficiently. > - * > - * @iov: Pointer to the array of struct iovec describing the > - * scatter/gather I/O vector. > - * @iov_cnt: Number of elements in the iov array. > - * @offset: Byte offset in the iov array where copying should start. > - * @buf: Pointer to the source buffer containing the data to copy. > - * @bytes: Total number of bytes to copy from buf to iov. > + * iov_from_buf() - Copy from flat buffer to iovec array > + * @iov: Destination iovec array > + * @iov_cnt: Number of elements in the iovec array > + * @offset: Destination offset in iovec array Nit: Any reason not to mention the "counted as if .. contiguous" like you have for iov_to_buf()? > + * @buf: Source buffer > + * @bytes: Bytes to copy > * > - * Return: the number of bytes successfully copied. > + * Return: number of bytes copied > */ > size_t iov_from_buf(const struct iovec *iov, size_t iov_cnt, > size_t offset, const void *buf, size_t bytes) > @@ -78,12 +72,12 @@ size_t iov_from_buf(const struct iovec *iov, size_t i= ov_cnt, > if (__builtin_constant_p(bytes) && iov_cnt && > offset <=3D iov[0].iov_len && bytes <=3D iov[0].iov_len - offset) { > memcpy((char *)iov[0].iov_base + offset, buf, bytes); > + > return bytes; > } > =20 > i =3D iov_skip_bytes(iov, iov_cnt, offset, &offset); > =20 > - /* copying data */ > for (copied =3D 0; copied < bytes && i < iov_cnt; i++) { > size_t len =3D MIN(iov[i].iov_len - offset, bytes - copied); > =20 > @@ -97,17 +91,14 @@ size_t iov_from_buf(const struct iovec *iov, size_t i= ov_cnt, > } > =20 > /** > - * iov_to_buf() - Copy data from a scatter/gather I/O vector (struct iov= ec) to > - * a buffer efficiently. > - * > - * @iov: Pointer to the array of struct iovec describing the scatt= er/gather > - * I/O vector. > - * @iov_cnt: Number of elements in the iov array. > - * @offset: Offset within the first element of iov from where copying= should start. > - * @buf: Pointer to the destination buffer where data will be copi= ed. > - * @bytes: Total number of bytes to copy from iov to buf. > + * iov_to_buf() - Copy from iovec to flat buffer > + * @iov: Source iovec array > + * @iov_cnt: Number of elements in iovec array > + * @offset: Source offset in @iov, counted as if buffers were contiguous > + * @buf: Destination buffer > + * @bytes: Bytes to copy > * > - * Return: the number of bytes successfully copied. > + * Return: number of bytes copied > */ > size_t iov_to_buf(const struct iovec *iov, size_t iov_cnt, > size_t offset, void *buf, size_t bytes) > @@ -118,15 +109,17 @@ size_t iov_to_buf(const struct iovec *iov, size_t i= ov_cnt, > if (__builtin_constant_p(bytes) && iov_cnt && > offset <=3D iov[0].iov_len && bytes <=3D iov[0].iov_len - offset) { > memcpy(buf, (char *)iov[0].iov_base + offset, bytes); > + > return bytes; > } > =20 > i =3D iov_skip_bytes(iov, iov_cnt, offset, &offset); > =20 > - /* copying data */ > for (copied =3D 0; copied < bytes && i < iov_cnt; i++) { > size_t len =3D MIN(iov[i].iov_len - offset, bytes - copied); > + > ASSERT(iov[i].iov_base); > + > memcpy((char *)buf + copied, (char *)iov[i].iov_base + offset, > len); > copied +=3D len; > @@ -137,14 +130,11 @@ size_t iov_to_buf(const struct iovec *iov, size_t i= ov_cnt, > } > =20 > /** > - * iov_size() - Calculate the total size of a scatter/gather I/O vector > - * (struct iovec). > + * iov_size() - Calculate total data size of iovec > + * @iov: Source iovec array > + * @iov_cnt: Number of elements in iovec array > * > - * @iov: Pointer to the array of struct iovec describing the > - * scatter/gather I/O vector. > - * @iov_cnt: Number of elements in the iov array. > - * > - * Return: the total size in bytes. > + * Return: total size in bytes > */ > size_t iov_size(const struct iovec *iov, size_t iov_cnt) > { > --=20 > 2.43.0 >=20 --=20 David Gibson (he or they) | I'll have my music baroque, and my code david AT gibson.dropbear.id.au | minimalist, thank you, not the other way | around. http://www.ozlabs.org/~dgibson --peUXdmyz+gNGPQvj Content-Type: application/pgp-signature; name=signature.asc -----BEGIN PGP SIGNATURE----- iQIzBAEBCgAdFiEEO+dNsU4E3yXUXRK2zQJF27ox2GcFAmkySmwACgkQzQJF27ox 2GfP5w//T+SUsikSkpfgy+XxSPwvTvopD+9b18VCj1CDgkb1qitKBkQTYvY3WdPQ Tve2KC7AsByhh8WvP1R6XhFrqkxiCo4KQs39f26gTcM5hzLtihDRzNqdm3pXiCyp BpmZoLnnRji22AaNFduUSfMX5vtH0Re1H6XcvOk5A2ofudxWQ/1/1mj92vsjFQfw K2I3LtnQBkDun9bdRmiRg0vjHxYmkdjFhlk73SsxJ8yX1J4ZrgToctT8K3vAk8fu 97fg1E0BxwOjWEApO58MhZvbzV+X+b77prxn3lNPoYmc8ymIrazLbv7Ohv/3xGga mKw8weXhHRh5T2KolhJZgryL1cwO7iYn5plUBm4SiU0HecOhiO1VUmjkjr7DQGEC iVw5iv5hSYtUTJ/gh9PjPQMzhtegGT69cpckCSwQN9mxexff503lC4hj5KIuWG6O uZhI+tbySyGMSQfFIb/6WHtZG21bHLk9FeZ4unIS8ESD2TROUdtDnF6qtE1SQSd5 vYgYXfBejdR4lN0Lg28AWoZPSc6y8JJivxJLYazqTuNbq0dWPGtMuV+c4vZSR94Q YrAxBNk14tnx0QY/21kI3y7vko5iUsX/cxcWle+uZKgiKJHnntbLTSmjxeI7mGHm bq70nhCRc9cwxdmIWejMYf4omVdTXLpYq1WJsdkKXbPJD5IW5S0= =wTba -----END PGP SIGNATURE----- --peUXdmyz+gNGPQvj--