Commit 84d90484 authored by Daniel Verkamp's avatar Daniel Verkamp
Browse files

util: move common helper functions to util.h 



These were repeated a few different places, so pull them into a common
header file.

Change-Id: Id807fa2cfec0de2e0363aeb081510fb801781985
Signed-off-by: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
parent 187ec2fd

app/nvmf_tgt/conf.c

+9 −8
Original line number Diff line number Diff line
@@ -51,6 +51,7 @@ 
#include "spdk/nvme.h"

#include "spdk/nvmf.h"

#include "spdk/string.h"

#include "spdk/util.h"



#define MAX_LISTEN_ADDRESSES 255

#define MAX_HOSTS 255
@@ -176,15 +177,15 @@ spdk_nvmf_parse_nvmf_tgt(void) 
	if (max_queue_depth < 0) {

		max_queue_depth = SPDK_NVMF_CONFIG_QUEUE_DEPTH_DEFAULT;

	}

	max_queue_depth = nvmf_max(max_queue_depth, SPDK_NVMF_CONFIG_QUEUE_DEPTH_MIN);

	max_queue_depth = nvmf_min(max_queue_depth, SPDK_NVMF_CONFIG_QUEUE_DEPTH_MAX);

	max_queue_depth = spdk_max(max_queue_depth, SPDK_NVMF_CONFIG_QUEUE_DEPTH_MIN);

	max_queue_depth = spdk_min(max_queue_depth, SPDK_NVMF_CONFIG_QUEUE_DEPTH_MAX);



	max_queues_per_sess = spdk_conf_section_get_intval(sp, "MaxQueuesPerSession");

	if (max_queues_per_sess < 0) {

		max_queues_per_sess = SPDK_NVMF_CONFIG_QUEUES_PER_SESSION_DEFAULT;

	}

	max_queues_per_sess = nvmf_max(max_queues_per_sess, SPDK_NVMF_CONFIG_QUEUES_PER_SESSION_MIN);

	max_queues_per_sess = nvmf_min(max_queues_per_sess, SPDK_NVMF_CONFIG_QUEUES_PER_SESSION_MAX);

	max_queues_per_sess = spdk_max(max_queues_per_sess, SPDK_NVMF_CONFIG_QUEUES_PER_SESSION_MIN);

	max_queues_per_sess = spdk_min(max_queues_per_sess, SPDK_NVMF_CONFIG_QUEUES_PER_SESSION_MAX);



	in_capsule_data_size = spdk_conf_section_get_intval(sp, "InCapsuleDataSize");

	if (in_capsule_data_size < 0) {
@@ -193,8 +194,8 @@ spdk_nvmf_parse_nvmf_tgt(void) 
		SPDK_ERRLOG("InCapsuleDataSize must be a multiple of 16\n");

		return -1;

	}

	in_capsule_data_size = nvmf_max(in_capsule_data_size, SPDK_NVMF_CONFIG_IN_CAPSULE_DATA_SIZE_MIN);

	in_capsule_data_size = nvmf_min(in_capsule_data_size, SPDK_NVMF_CONFIG_IN_CAPSULE_DATA_SIZE_MAX);

	in_capsule_data_size = spdk_max(in_capsule_data_size, SPDK_NVMF_CONFIG_IN_CAPSULE_DATA_SIZE_MIN);

	in_capsule_data_size = spdk_min(in_capsule_data_size, SPDK_NVMF_CONFIG_IN_CAPSULE_DATA_SIZE_MAX);



	max_io_size = spdk_conf_section_get_intval(sp, "MaxIOSize");

	if (max_io_size < 0) {
@@ -203,8 +204,8 @@ spdk_nvmf_parse_nvmf_tgt(void) 
		SPDK_ERRLOG("MaxIOSize must be a multiple of 4096\n");

		return -1;

	}

	max_io_size = nvmf_max(max_io_size, SPDK_NVMF_CONFIG_MAX_IO_SIZE_MIN);

	max_io_size = nvmf_min(max_io_size, SPDK_NVMF_CONFIG_MAX_IO_SIZE_MAX);

	max_io_size = spdk_max(max_io_size, SPDK_NVMF_CONFIG_MAX_IO_SIZE_MIN);

	max_io_size = spdk_min(max_io_size, SPDK_NVMF_CONFIG_MAX_IO_SIZE_MAX);



	acceptor_lcore = spdk_conf_section_get_intval(sp, "AcceptorCore");

	if (acceptor_lcore < 0) {

include/spdk/nvmf.h

+0 −3
Original line number Diff line number Diff line
@@ -47,9 +47,6 @@ 
#define MAX_VIRTUAL_NAMESPACE 16

#define MAX_SN_LEN 20



#define nvmf_min(a,b) (((a)<(b))?(a):(b))

#define nvmf_max(a,b) (((a)>(b))?(a):(b))



int spdk_nvmf_tgt_init(uint16_t max_queue_depth, uint16_t max_conn_per_sess,

		       uint32_t in_capsule_data_size, uint32_t max_io_size);

include/spdk/util.h

0 → 100644
+71 −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.

 */



/** \file

 * General utility functions

 */



#ifndef SPDK_UTIL_H

#define SPDK_UTIL_H



#ifdef __cplusplus

extern "C" {

#endif



#include <stddef.h>

#include <stdint.h>



#define spdk_min(a,b) (((a)<(b))?(a):(b))

#define spdk_max(a,b) (((a)>(b))?(a):(b))



static inline uint32_t

spdk_u32log2(uint32_t x)

{

	if (x == 0) {

		/* log(0) is undefined */

		return 0;

	}

	return 31u - __builtin_clz(x);

}



static inline uint32_t

spdk_align32pow2(uint32_t x)

{

	return 1u << (1 + spdk_u32log2(x - 1));

}



#ifdef __cplusplus

}

#endif



#endif

lib/ioat/ioat.c

+5 −6
Original line number Diff line number Diff line
@@ -34,6 +34,7 @@ 
#include "ioat_internal.h"



#include "spdk/env.h"

#include "spdk/util.h"



#include "spdk_internal/log.h"
@@ -569,8 +570,6 @@ spdk_ioat_detach(struct spdk_ioat_chan *ioat) 
	return 0;

}



#define min(a, b) (((a)<(b))?(a):(b))



#define _2MB_PAGE(ptr)		((ptr) & ~(0x200000 - 1))

#define _2MB_OFFSET(ptr)	((ptr) &  (0x200000 - 1))
@@ -608,9 +607,9 @@ spdk_ioat_submit_copy(struct spdk_ioat_chan *ioat, void *cb_arg, spdk_ioat_req_c 
			pdst_page = spdk_vtophys((void *)vdst_page);

		}

		op_size = remaining;

		op_size = min(op_size, (0x200000 - _2MB_OFFSET(vsrc)));

		op_size = min(op_size, (0x200000 - _2MB_OFFSET(vdst)));

		op_size = min(op_size, ioat->max_xfer_size);

		op_size = spdk_min(op_size, (0x200000 - _2MB_OFFSET(vsrc)));

		op_size = spdk_min(op_size, (0x200000 - _2MB_OFFSET(vdst)));

		op_size = spdk_min(op_size, ioat->max_xfer_size);

		remaining -= op_size;



		last_desc = ioat_prep_copy(ioat,
@@ -672,7 +671,7 @@ spdk_ioat_submit_fill(struct spdk_ioat_chan *ioat, void *cb_arg, spdk_ioat_req_c 


	while (remaining) {

		op_size = remaining;

		op_size = min(op_size, ioat->max_xfer_size);

		op_size = spdk_min(op_size, ioat->max_xfer_size);

		remaining -= op_size;



		last_desc = ioat_prep_fill(ioat,

lib/nvme/nvme_ctrlr.c

+7 −7
Original line number Diff line number Diff line
@@ -432,7 +432,7 @@ nvme_ctrlr_enable(struct spdk_nvme_ctrlr *ctrlr) 
	cc.bits.iocqes = 4; /* CQ entry size == 16 == 2^4 */



	/* Page size is 2 ^ (12 + mps). */

	cc.bits.mps = nvme_u32log2(PAGE_SIZE) - 12;

	cc.bits.mps = spdk_u32log2(PAGE_SIZE) - 12;



	switch (ctrlr->opts.arb_mechanism) {

	case SPDK_NVME_CC_AMS_RR:
@@ -582,7 +582,7 @@ nvme_ctrlr_identify(struct spdk_nvme_ctrlr *ctrlr) 
	ctrlr->max_xfer_size = nvme_transport_ctrlr_get_max_xfer_size(ctrlr);

	SPDK_TRACELOG(SPDK_TRACE_NVME, "transport max_xfer_size %u\n", ctrlr->max_xfer_size);

	if (ctrlr->cdata.mdts > 0) {

		ctrlr->max_xfer_size = nvme_min(ctrlr->max_xfer_size,

		ctrlr->max_xfer_size = spdk_min(ctrlr->max_xfer_size,

						ctrlr->min_page_size * (1 << (ctrlr->cdata.mdts)));

		SPDK_TRACELOG(SPDK_TRACE_NVME, "MDTS max_xfer_size %u\n", ctrlr->max_xfer_size);

	}
@@ -631,7 +631,7 @@ nvme_ctrlr_set_num_qpairs(struct spdk_nvme_ctrlr *ctrlr) 
	sq_allocated = (status.cpl.cdw0 & 0xFFFF) + 1;

	cq_allocated = (status.cpl.cdw0 >> 16) + 1;



	ctrlr->opts.num_io_queues = nvme_min(sq_allocated, cq_allocated);

	ctrlr->opts.num_io_queues = spdk_min(sq_allocated, cq_allocated);



	ctrlr->free_io_qids = spdk_bit_array_create(ctrlr->opts.num_io_queues + 1);

	if (ctrlr->free_io_qids == NULL) {
@@ -851,7 +851,7 @@ nvme_ctrlr_configure_aer(struct spdk_nvme_ctrlr *ctrlr) 
	}



	/* aerl is a zero-based value, so we need to add 1 here. */

	ctrlr->num_aers = nvme_min(NVME_MAX_ASYNC_EVENTS, (ctrlr->cdata.aerl + 1));

	ctrlr->num_aers = spdk_min(NVME_MAX_ASYNC_EVENTS, (ctrlr->cdata.aerl + 1));



	for (i = 0; i < ctrlr->num_aers; i++) {

		aer = &ctrlr->aer[i];
@@ -1312,8 +1312,8 @@ nvme_ctrlr_init_cap(struct spdk_nvme_ctrlr *ctrlr, const union spdk_nvme_cap_reg 


	ctrlr->min_page_size = 1u << (12 + ctrlr->cap.bits.mpsmin);



	ctrlr->opts.io_queue_size = nvme_min(ctrlr->opts.io_queue_size, ctrlr->cap.bits.mqes + 1u);

	ctrlr->opts.io_queue_size = nvme_min(ctrlr->opts.io_queue_size, max_io_queue_size);

	ctrlr->opts.io_queue_size = spdk_min(ctrlr->opts.io_queue_size, ctrlr->cap.bits.mqes + 1u);

	ctrlr->opts.io_queue_size = spdk_min(ctrlr->opts.io_queue_size, max_io_queue_size);

}



void
@@ -1628,7 +1628,7 @@ spdk_nvme_ctrlr_update_firmware(struct spdk_nvme_ctrlr *ctrlr, void *payload, ui 
	p = payload;



	while (size_remaining > 0) {

		transfer = nvme_min(size_remaining, ctrlr->min_page_size);

		transfer = spdk_min(size_remaining, ctrlr->min_page_size);

		status.done = false;



		res = nvme_ctrlr_cmd_fw_image_download(ctrlr, transfer, offset, p,