Commit 320ab72f authored by Shuhei Matsumoto's avatar Shuhei Matsumoto Committed by Tomasz Zawadzki
Browse files

util: Add macro SPDK_SIZEOF_MEMBER to get size of a member of a struct 



We find a few files to get the size of a member of a struct. How to
do it is a little complex. So add a macro to do it will be helpful
to read the current code and develop new features.

lib/dif had used member_size() internally but Linux use sizeof_member()
as the macro. Besides, SPDK have used upper case letters for similar
macros, SPDK_CONTAINEROF() and SPDK_COUNTOF(). Hence spdk_member_size()
may be good but propose SPDK_SIZEOF_MEMBER() as the macro.

Signed-off-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Change-Id: I2179c845a3b75fb71aa039075cc4dfd30617b898
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/8738


Reviewed-by: default avatarKonrad Sztyber <konrad.sztyber@intel.com>
Reviewed-by: default avatarChangpeng Liu <changpeng.liu@intel.com>
Reviewed-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
parent e8cd34ae

CHANGELOG.md

+2 −0
Original line number Diff line number Diff line
@@ -124,6 +124,8 @@ and for io_devices to provide faster lookup. 
Red-black tree macros has been added by using the macros provided by the FreeBSD operating system

under the same BSD license.



Add an new macro `SPDK_SIZEOF_MEMBER` to get the size of a member of a struct.



## v21.04:



### accel

include/spdk/util.h

+5 −0
Original line number Diff line number Diff line
@@ -53,6 +53,11 @@ extern "C" { 


#define SPDK_CONTAINEROF(ptr, type, member) ((type *)((uintptr_t)ptr - offsetof(type, member)))



/**

 * Get the size of a member of a struct.

 */

#define SPDK_SIZEOF_MEMBER(type, member) (sizeof(((type *)0)->member))



#define SPDK_SEC_TO_USEC 1000000ULL

#define SPDK_SEC_TO_NSEC 1000000000ULL

lib/blob/blobstore.h

+1 −1
Original line number Diff line number Diff line
@@ -392,7 +392,7 @@ struct spdk_blob_md_page { 
#define SPDK_BS_PAGE_SIZE 0x1000

SPDK_STATIC_ASSERT(SPDK_BS_PAGE_SIZE == sizeof(struct spdk_blob_md_page), "Invalid md page size");



#define SPDK_BS_MAX_DESC_SIZE sizeof(((struct spdk_blob_md_page*)0)->descriptors)

#define SPDK_BS_MAX_DESC_SIZE SPDK_SIZEOF_MEMBER(struct spdk_blob_md_page, descriptors)



/* Maximum number of extents a single Extent Page can fit.

 * For an SPDK_BS_PAGE_SIZE of 4K SPDK_EXTENTS_PER_EP would be 512. */

lib/init/json_config.c

+1 −1
Original line number Diff line number Diff line
@@ -72,7 +72,7 @@ struct load_json_config_ctx; 
typedef void (*client_resp_handler)(struct load_json_config_ctx *,

				    struct spdk_jsonrpc_client_response *);



#define RPC_SOCKET_PATH_MAX sizeof(((struct sockaddr_un *)0)->sun_path)

#define RPC_SOCKET_PATH_MAX SPDK_SIZEOF_MEMBER(struct sockaddr_un, sun_path)



/* 1s connections timeout */

#define RPC_CLIENT_CONNECT_TIMEOUT_US (1U * 1000U * 1000U)

lib/nvme/nvme_ns.c

+2 −2
Original line number Diff line number Diff line
@@ -413,9 +413,9 @@ spdk_nvme_ns_get_nguid(const struct spdk_nvme_ns *ns) 
	size_t size;



	nguid = nvme_ns_find_id_desc(ns, SPDK_NVME_NIDT_NGUID, &size);

	if (nguid && size != sizeof(((struct spdk_nvme_ns_data *)0)->nguid)) {

	if (nguid && size != SPDK_SIZEOF_MEMBER(struct spdk_nvme_ns_data, nguid)) {

		SPDK_WARNLOG("Invalid NIDT_NGUID descriptor length reported: %zu (expected: %zu)\n",

			     size, sizeof(((struct spdk_nvme_ns_data *)0)->nguid));

			     size, SPDK_SIZEOF_MEMBER(struct spdk_nvme_ns_data, nguid));

		return NULL;

	}