Commit e475586b authored by Ben Walker's avatar Ben Walker Committed by Tomasz Zawadzki
Browse files

util: Add spdk_iovcpy, an iovec to iovec copy function. 



Like memcpy, but works on two iovecs.

Change-Id: Ia1cf462a95690286f0c19325fc10937b9ba6baf3
Signed-off-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/473976


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
parent 063252fa

include/spdk/util.h

+7 −0
Original line number Diff line number Diff line
@@ -92,6 +92,13 @@ spdk_divide_round_up(uint64_t num, uint64_t divisor) 
	return (num + divisor - 1) / divisor;

}



/**

 * Copy the data described by the source iovec to the destination iovec.

 *

 * \return The number of bytes copied.

 */

size_t spdk_iovcpy(struct iovec *siov, size_t siovcnt, struct iovec *diov, size_t diovcnt);





/**

 * Scan build is really pessimistic and assumes that mempool functions can

lib/util/Makefile

+1 −1
Original line number Diff line number Diff line
@@ -35,7 +35,7 @@ SPDK_ROOT_DIR := $(abspath $(CURDIR)/../..) 
include $(SPDK_ROOT_DIR)/mk/spdk.common.mk



C_SRCS = base64.c bit_array.c cpuset.c crc16.c crc32.c crc32c.c crc32_ieee.c \

	 dif.c fd.c file.c math.c pipe.c strerror_tls.c string.c uuid.c

	 dif.c fd.c file.c iov.c math.c pipe.c strerror_tls.c string.c uuid.c

LIBNAME = util

LOCAL_SYS_LIBS = -luuid

lib/util/iov.c

0 → 100644
+111 −0
Original line number Diff line number Diff line 
/*-

 *   BSD LICENSE

 *

 *   Copyright (c) Intel Corporation.

 *   All rights reserved.

 *

 *   Redistribution and use in source and binary forms, with or without

 *   modification, are permitted provided that the following conditions

 *   are met:

 *

 *     * Redistributions of source code must retain the above copyright

 *       notice, this list of conditions and the following disclaimer.

 *     * Redistributions in binary form must reproduce the above copyright

 *       notice, this list of conditions and the following disclaimer in

 *       the documentation and/or other materials provided with the

 *       distribution.

 *     * Neither the name of Intel Corporation nor the names of its

 *       contributors may be used to endorse or promote products derived

 *       from this software without specific prior written permission.

 *

 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 */



#include "spdk/util.h"



size_t

spdk_iovcpy(struct iovec *siov, size_t siovcnt, struct iovec *diov, size_t diovcnt)

{

	size_t total_sz;

	size_t sidx;

	size_t didx;

	int siov_len;

	uint8_t *siov_base;

	int diov_len;

	uint8_t *diov_base;



	/* d prefix = destination. s prefix = source. */



	assert(diovcnt > 0);

	assert(siovcnt > 0);



	total_sz = 0;

	sidx = 0;

	didx = 0;

	siov_len = siov[0].iov_len;

	siov_base = siov[0].iov_base;

	diov_len = diov[0].iov_len;

	diov_base = diov[0].iov_base;

	while (siov_len > 0 && diov_len > 0) {

		if (siov_len == diov_len) {

			memcpy(diov_base, siov_base, siov_len);

			total_sz += siov_len;



			/* Advance both iovs to the next element */

			sidx++;

			if (sidx == siovcnt) {

				break;

			}



			didx++;

			if (didx == diovcnt) {

				break;

			}



			siov_len = siov[sidx].iov_len;

			siov_base = siov[sidx].iov_base;

			diov_len = diov[didx].iov_len;

			diov_base = diov[didx].iov_base;

		} else if (siov_len < diov_len) {

			memcpy(diov_base, siov_base, siov_len);

			total_sz += siov_len;



			/* Advance only the source to the next element */

			sidx++;

			if (sidx == siovcnt) {

				break;

			}



			diov_base += siov_len;

			diov_len -= siov_len;

			siov_len = siov[sidx].iov_len;

			siov_base = siov[sidx].iov_base;

		} else {

			memcpy(diov_base, siov_base, diov_len);

			total_sz += diov_len;



			/* Advance only the destination to the next element */

			didx++;

			if (didx == diovcnt) {

				break;

			}



			siov_base += diov_len;

			siov_len -= diov_len;

			diov_len = diov[didx].iov_len;

			diov_base = diov[didx].iov_base;

		}

	}



	return total_sz;

}

test/unit/lib/util/Makefile

+1 −1
Original line number Diff line number Diff line
@@ -35,7 +35,7 @@ SPDK_ROOT_DIR := $(abspath $(CURDIR)/../../../..) 
include $(SPDK_ROOT_DIR)/mk/spdk.common.mk



DIRS-y = base64.c bit_array.c cpuset.c crc16.c crc32_ieee.c crc32c.c dif.c \

	 pipe.c string.c

	 iov.c pipe.c string.c



.PHONY: all clean $(DIRS-y)

test/unit/lib/util/iov.c/.gitignore

0 → 100644
+1 −0
Original line number Diff line number Diff line 
iov_ut