From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from gandalf.ozlabs.org (gandalf.ozlabs.org [150.107.74.76]) by passt.top (Postfix) with ESMTPS id C62DA5A027B for ; Thu, 15 Feb 2024 01:40:27 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gibson.dropbear.id.au; s=202312; t=1707957620; bh=YYguyc6znGZL6m4e8NB2t6o4i+NPMJIXJd6ME4XQbTk=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=n3RSDF1SgdQ0xJF44ycJXgR2L9PSnliyqztGBAVw/X3ChvLx5WwJkxWybva6QGVVg haM3Kyg5sfqisGuafi+rBfnXL6gb9KdKNfe7nbtCejGbFxXrNk+t6sKr8yQkUO5FZB JZdpwysX5L0+Xwmqmz3l9B6jCbp+kn7pPfj/JPjkywAgbX08+bTD5OIEP+D1lYAor+ oIFCzMAovgRStip9k//QX1rT0kMYNYMfOok32XM4QBZ2BNoI+yOlwX8HpRD1lTrH/9 EXWSc7E6o456auXmDhaJLM8H2HNPFTBaoPbQYZF+B3IRpJSQE+6UM2lyv/ruMnTHBy CQgGtByIxkb+w== Received: by gandalf.ozlabs.org (Postfix, from userid 1007) id 4TZx6r4flmz4wcN; Thu, 15 Feb 2024 11:40:20 +1100 (AEDT) Date: Thu, 15 Feb 2024 11:24:38 +1100 From: David Gibson To: Laurent Vivier Subject: Re: [PATCH v2 1/8] iov: add some functions to manage iovec Message-ID: References: <20240214085628.210783-1-lvivier@redhat.com> <20240214085628.210783-2-lvivier@redhat.com> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="nO2YyZ0nrHXB/U+P" Content-Disposition: inline In-Reply-To: <20240214085628.210783-2-lvivier@redhat.com> Message-ID-Hash: PEMQ4TL7QDBDFFER2CGEFJNRR4FRT7FE X-Message-ID-Hash: PEMQ4TL7QDBDFFER2CGEFJNRR4FRT7FE 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 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: --nO2YyZ0nrHXB/U+P Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Wed, Feb 14, 2024 at 09:56:21AM +0100, Laurent Vivier wrote: > Introduce functions to copy to/from a buffer from/to an iovec array, > to compute data length in in bytes of an iovec and to copy memory from > an iovec to another. >=20 > iov_from_buf(), iov_to_buf(), iov_size(), iov_copy(). >=20 > Signed-off-by: Laurent Vivier > --- >=20 > Notes: > v2: > - reorder added files in alphanetical order in Makefile > - update comments, cosmetic cleanup > - rename iov_from_buf_full/iov_to_buf_full to > iov_fill_from_buf/iov_fill_to_buf > - split loops that manage offset and bytes copy. > - move iov_from_buf()/iov_to_buf() to iov.c >=20 > Makefile | 8 +-- > iov.c | 212 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ > iov.h | 43 +++++++++++ > 3 files changed, 259 insertions(+), 4 deletions(-) > create mode 100644 iov.c > create mode 100644 iov.h >=20 > diff --git a/Makefile b/Makefile > index af4fa87e7e13..156398b3844e 100644 > --- a/Makefile > +++ b/Makefile > @@ -45,16 +45,16 @@ FLAGS +=3D -DVERSION=3D\"$(VERSION)\" > FLAGS +=3D -DDUAL_STACK_SOCKETS=3D$(DUAL_STACK_SOCKETS) > =20 > PASST_SRCS =3D arch.c arp.c checksum.c conf.c dhcp.c dhcpv6.c flow.c icm= p.c \ > - igmp.c isolation.c lineread.c log.c mld.c ndp.c netlink.c packet.c \ > - passt.c pasta.c pcap.c pif.c port_fwd.c tap.c tcp.c tcp_splice.c udp.c \ > - util.c > + igmp.c iov.c isolation.c lineread.c log.c mld.c ndp.c netlink.c \ > + packet.c passt.c pasta.c pcap.c pif.c port_fwd.c tap.c tcp.c \ > + tcp_splice.c udp.c util.c > QRAP_SRCS =3D qrap.c > SRCS =3D $(PASST_SRCS) $(QRAP_SRCS) > =20 > MANPAGES =3D passt.1 pasta.1 qrap.1 > =20 > PASST_HEADERS =3D arch.h arp.h checksum.h conf.h dhcp.h dhcpv6.h flow.h \ > - flow_table.h icmp.h inany.h isolation.h lineread.h log.h ndp.h \ > + flow_table.h icmp.h inany.h iov.h isolation.h lineread.h log.h ndp.h \ > netlink.h packet.h passt.h pasta.h pcap.h pif.h port_fwd.h siphash.h \ > tap.h tcp.h tcp_conn.h tcp_splice.h udp.h util.h > HEADERS =3D $(PASST_HEADERS) seccomp.h > diff --git a/iov.c b/iov.c > new file mode 100644 > index 000000000000..73dd5cf25d0d > --- /dev/null > +++ b/iov.c > @@ -0,0 +1,212 @@ > +// SPDX-License-Identifier: GPL-2.0-or-later > +/* > + * iov.h - helpers for using (partial) iovecs. > + * > + * Copyrigh (c) 2024 Red Hat Typo: s/Copyrigh/Copyright/ AIUI, the "(c) 2024" has no real purpose, see https://source.redhat.com/departments/legal/redhatintellectualproperty/inte= llectual_property_and_ip_litigation_wiki/copyright_notices_in_source_code > + * Author: Laurent Vivier > + * > + * This file also contains code originally from QEMU include/qemu/iov.h > + * and licensed under the following terms: > + * > + * Copyright (C) 2010 Red Hat, Inc. > + * > + * Author(s): > + * Amit Shah > + * Michael Tokarev > + * > + * This work is licensed under the terms of the GNU GPL, version 2. See > + * the COPYING file in the top-level directory. > + * > + * Contributions after 2012-01-13 are licensed under the terms of the > + * GNU GPL, version 2 or (at your option) any later version. The description of the provenance of the code and its authorship is useful. I don't think the second copyright notice is useful in this case, since it's also Red Hat, like the first. Likewise, I don't think the GPL invocation is useful, since we're not changing that license. > + */ > +#include > + > +#include "util.h" > +#include "iov.h" > + > +/** > + * iov_from_buf - Copy data from a buffer to a scatter/gather > + * I/O vector (struct iovec) efficiently. > + * > + * @iov: Pointer to the array of struct iovec describing the > + * scatter/gather I/O vector. I feel like an IO vector is a common enough concept that we could just say "IO vector" rather than this rather wordy description. > + * @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. > + * > + * Returns: The number of bytes successfully copied. > + */ > +size_t iov_from_buf(const struct iovec *iov, unsigned int iov_cnt, > + size_t offset, const void *buf, size_t bytes) > +{ > + 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; > + } > + > + return iov_fill_from_buf(iov, iov_cnt, offset, buf, bytes); > +} > + > +/** > + * iov_to_buf - Copy data from a scatter/gather I/O vector (struct iovec= ) 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. > + * > + * Returns: The number of bytes successfully copied. > + */ > +size_t iov_to_buf(const struct iovec *iov, unsigned int iov_cnt, > + size_t offset, void *buf, size_t bytes) > +{ > + 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; > + } > + > + return iov_fill_to_buf(iov, iov_cnt, offset, buf, bytes); > +} > + > +/** > + * iov_fill_from_buf - Copy data from a buffer to a scatter/gather > + * I/O vector (struct iovec) until either all bytes > + * are copied or all elements in the vector are fill= ed. > + * > + * @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: 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. > + * > + * Returns: The total number of bytes successfully copied > + * > + */ > +size_t iov_fill_from_buf(const struct iovec *iov, unsigned int iov_cnt, > + size_t offset, const void *buf, size_t bytes) We could just open code this in iov_from_buf(), since I don't think we ever have a reason to call it directly. > +{ > + unsigned int i; > + size_t copied; > + > + /* skipping offset bytes in the iovec */ > + for (i =3D 0; offset >=3D iov[i].iov_len && i < iov_cnt; i++) > + offset -=3D iov[i].iov_len; > + > + /* copying data */ > + for (copied =3D 0; copied < bytes && i < iov_cnt; i++) { > + size_t len =3D MIN(iov[i].iov_len - offset, bytes - copied); > + > + memcpy((char *)iov[i].iov_base + offset, (char *)buf + copied, > + len); > + copied +=3D len; > + offset =3D 0; > + } > + > + return copied; > +} > + > +/** > + * iov_fill_to_buf - Copy data from a scatter/gather I/O vector (struct = iovec) > + * to a buffer until either all bytes are copied or all > + * elements in the vector are read. > + * > + * @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 destination buffer where data will be copi= ed. > + * @bytes: Total number of bytes to copy from iov to buf. > + * > + * Returns: The total number of bytes successfully copied > + */ > +size_t iov_fill_to_buf(const struct iovec *iov, unsigned int iov_cnt, > + size_t offset, void *buf, size_t bytes) > +{ > + unsigned int i; > + size_t copied; > + > + /* skipping offset bytes in the iovec */ > + for (i =3D 0; offset >=3D iov[i].iov_len && i < iov_cnt; i++) > + offset -=3D iov[i].iov_len; > + > + /* copying data */ > + for (copied =3D 0; copied < bytes && i < iov_cnt; i++) { > + size_t len =3D MIN(iov[i].iov_len - offset, bytes - copied); > + memcpy((char *)buf + copied, (char *)iov[i].iov_base + offset, > + len); > + copied +=3D len; > + offset =3D 0; > + } > + > + return copied; > +} > + > +/** > + * iov_size - Calculate the total size of a scatter/gather I/O vector > + * (struct iovec). > + * > + * @iov: Pointer to the array of struct iovec describing the > + * scatter/gather I/O vector. > + * @iov_cnt: Number of elements in the iov array. > + * > + * Returns: The total size in bytes. > + */ > +size_t iov_size(const struct iovec *iov, const unsigned int iov_cnt) > +{ > + size_t len; > + unsigned int i; Other order for these locals please (longest to shortest). > + for (i =3D 0, len =3D 0; i < iov_cnt; i++) { > + len +=3D iov[i].iov_len; > + } No braces here (passt style, again). > + return len; > +} > + > +/** > + * iov_copy - Copy data from one scatter/gather I/O vector (struct iovec= ) to > + * another. > + * > + * @dst_iov: Pointer to the destination array of struct iovec descr= ibing > + * the scatter/gather I/O vector to copy to. > + * @dst_iov_cnt: Number of elements in the destination iov array. > + * @iov: Pointer to the source array of struct iovec describing > + * the scatter/gather I/O vector to copy from. > + * @iov_cnt: Number of elements in the source iov array. > + * @offset: Offset within the source iov from where copying should= start. > + * @bytes: Total number of bytes to copy from iov to dst_iov. > + * > + * Returns: The number of elements successfully copied to the dest= ination > + * iov array. > + */ > +unsigned iov_copy(struct iovec *dst_iov, unsigned int dst_iov_cnt, > + const struct iovec *iov, unsigned int iov_cnt, > + size_t offset, size_t bytes) > +{ > + unsigned int i, j; > + size_t len; > + > + /* skipping offset bytes in the iovec */ > + for (i =3D 0; offset >=3D iov[i].iov_len && i < iov_cnt; i++) > + offset -=3D iov[i].iov_len; > + > + /* copying data */ > + for (j =3D 0; i < iov_cnt && j < dst_iov_cnt && bytes; i++) { > + len =3D MIN(bytes, iov[i].iov_len - offset); > + > + dst_iov[j].iov_base =3D (char *)iov[i].iov_base + offset; > + dst_iov[j].iov_len =3D len; > + j++; > + bytes -=3D len; > + offset =3D 0; > + } > + > + return j; > +} > diff --git a/iov.h b/iov.h > new file mode 100644 > index 000000000000..0153acca9e62 > --- /dev/null > +++ b/iov.h > @@ -0,0 +1,43 @@ > +// SPDX-License-Identifier: GPL-2.0-or-later > +/* > + * iov.c - helpers for using (partial) iovecs. > + * > + * Copyrigh (c) 2024 Red Hat Same typo again. > + * Author: Laurent Vivier > + * > + * This file also contains code originally from QEMU include/qemu/iov.h > + * and licensed under the following terms: > + * > + * Copyright (C) 2010 Red Hat, Inc. > + * > + * Author(s): > + * Amit Shah > + * Michael Tokarev > + * > + * This work is licensed under the terms of the GNU GPL, version 2. See > + * the COPYING file in the top-level directory. > + * > + * Contributions after 2012-01-13 are licensed under the terms of the > + * GNU GPL, version 2 or (at your option) any later version. > + */ > + > +#ifndef IOVEC_H > +#define IOVEC_H > + > +#include > +#include > + > +size_t iov_fill_from_buf(const struct iovec *iov, unsigned int iov_cnt, > + size_t offset, const void *buf, size_t bytes); > +size_t iov_fill_to_buf(const struct iovec *iov, const unsigned int iov_c= nt, > + size_t offset, void *buf, size_t bytes); > +size_t iov_from_buf(const struct iovec *iov, unsigned int iov_cnt, > + size_t offset, const void *buf, size_t bytes); > +size_t iov_to_buf(const struct iovec *iov, unsigned int iov_cnt, > + size_t offset, void *buf, size_t bytes); > + > +size_t iov_size(const struct iovec *iov, const unsigned int iov_cnt); > +unsigned iov_copy(struct iovec *dst_iov, unsigned int dst_iov_cnt, > + const struct iovec *iov, unsigned int iov_cnt, > + size_t offset, size_t bytes); > +#endif /* IOVEC_H */ --=20 David Gibson | 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 --nO2YyZ0nrHXB/U+P Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQIzBAEBCAAdFiEEO+dNsU4E3yXUXRK2zQJF27ox2GcFAmXNWcUACgkQzQJF27ox 2GfJ8g/9HQxKmSMv4lcuAu4M5F53paEOn1mMptppJvafve/1HlEdn6s+DIR7mqcZ OsV75aJPdKJiYUw461BIlSDFn3QP6SkrDVCChPRBZh4sjW3/sFGoDNjmYQapnQcZ TiTd/MAHx194bEl7vwDGc0hlNburp1Llp+M8ZyI+26roHw5KoG46BaNCITzh/7PH CWEC9y6D01XQAkCMf7yLRkGCA3HEoUt4ORFgn4DHI+b0eWPKt1apMB/CjQZPad8A JNyI/7dGe6HiqIUXYkmpEQMAjY2apLhWb+7Dw9d4ofFPJ3O80AQVRF95tujVbZNF wuv94VKE5bnUw+lLhh3JceZAR28AnV8fDQsOTmlkiNepsTS+tS3+juRKBn+KSv5p B6+XO4lcNbrxjXlpE0EglecpqKDiZ8IsJD09YYy/VtYCPNCqxrxXWcXw36zM/LRd DIYt6M80D+BXm1OBxqS1z67scxBMi9rUNAGF4XRwdFTDxV1/+fbLhQpBK/MHH43e c0rzkvVtozzaEp3CLIU1kMGjS/qhYWUCH008DuWFVgUf+ML6lDWYzSCwi9hhoDH+ ozMvyQ3sgClAzaMN9cf6cahcaaWnVSH4fG3Cg6Wp+RoyKUj+pFXwtP6a3DLwvkyz +S3lhstc0OF44I0fr422g3tXAEQzuFtydrvNwMkrBorG/7KlUvE= =nN2F -----END PGP SIGNATURE----- --nO2YyZ0nrHXB/U+P--