Commit c3a58489 authored by Alexey Marchuk's avatar Alexey Marchuk Committed by Tomasz Zawadzki
Browse files

bdev: Add API to get SPDK memory domains used by bdev 



Change-Id: Ic9f42eff59bdc4c8c6e73deb76b3eecfc04f80a8
Signed-off-by: default avatarAlexey Marchuk <alexeymar@mellanox.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6268


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Community-CI: Mellanox Build Bot
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: default avatarZiye Yang <ziye.yang@intel.com>
parent 110335f1

CHANGELOG.md

+4 −0
Original line number Diff line number Diff line
@@ -2,6 +2,10 @@ 


## v21.10: (Upcoming Release)



### bdev



New API `spdk_bdev_get_memory_domains` has been added, it allows to get SPDK memory domains used by bdev.



### dma



A new library, lib/dma, has been added. This library provides the necessary infrastructure for

include/spdk/bdev.h

+23 −0
Original line number Diff line number Diff line
@@ -3,6 +3,7 @@ 
 *

 *   Copyright (c) Intel Corporation. All rights reserved.

 *   Copyright (c) 2019 Mellanox Technologies LTD. All rights reserved.

 *   Copyright (c) 2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.

 *

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

 *   modification, are permitted provided that the following conditions
@@ -80,6 +81,9 @@ struct spdk_bdev_media_event { 
 */

struct spdk_bdev;



/** Forward declaration of spdk memory domain */

struct spdk_memory_domain;



/**

 * Block device remove callback.

 *
@@ -1748,6 +1752,25 @@ void spdk_bdev_histogram_get(struct spdk_bdev *bdev, struct spdk_histogram_data 
size_t spdk_bdev_get_media_events(struct spdk_bdev_desc *bdev_desc,

				  struct spdk_bdev_media_event *events, size_t max_events);



/**

 * Get SPDK memory domains used by the given bdev. If bdev reports that it uses memory domains

 * that means that it can work with data buffers located in those memory domains.

 *

 * The user can call this function with \b domains set to NULL and \b array_size set to 0 to get the

 * number of memory domains used by bdev

 *

 * \param bdev Block device

 * \param domains Pointer to an array of memory domains to be filled by this function. The user should allocate big enough

 * array to keep all memory domains used by bdev and all underlying bdevs

 * \param array_size size of \b domains array

 * \return the number of entries in \b domains array or negated errno. If returned value is bigger than \b array_size passed by the user

 * then the user should increase the size of \b domains array and call this function again. There is no guarantees that

 * the content of \b domains array is valid in that case.

 *         -EINVAL if input parameters were invalid

 */

int spdk_bdev_get_memory_domains(struct spdk_bdev *bdev, struct spdk_memory_domain **domains,

				 int array_size);



#ifdef __cplusplus

}

#endif

include/spdk/bdev_module.h

+7 −0
Original line number Diff line number Diff line
@@ -3,6 +3,7 @@ 
 *

 *   Copyright (c) Intel Corporation.

 *   All rights reserved.

 *   Copyright (c) 2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.

 *

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

 *   modification, are permitted provided that the following conditions
@@ -246,6 +247,12 @@ struct spdk_bdev_fn_table { 


	/** Get bdev module context. */

	void *(*get_module_ctx)(void *ctx);



	/** Get memory domains used by bdev. Optional - may be NULL.

	 * Vbdev module implementation should call \ref spdk_bdev_get_memory_domains for underlying bdev.

	 * Vbdev module must inspect types of memory domains returned by base bdev and report only those

	 * memory domains that it can work with. */

	int (*get_memory_domains)(void *ctx, struct spdk_memory_domain **domains, int array_size);

};



/** bdev I/O completion status */

lib/bdev/Makefile

+1 −1
Original line number Diff line number Diff line
@@ -34,7 +34,7 @@ 
SPDK_ROOT_DIR := $(abspath $(CURDIR)/../..)

include $(SPDK_ROOT_DIR)/mk/spdk.common.mk



SO_VER := 7

SO_VER := 8

SO_MINOR := 0



ifeq ($(CONFIG_VTUNE),y)

lib/bdev/bdev.c

+16 −0
Original line number Diff line number Diff line
@@ -3,6 +3,7 @@ 
 *

 *   Copyright (c) Intel Corporation. All rights reserved.

 *   Copyright (c) 2019 Mellanox Technologies LTD. All rights reserved.

 *   Copyright (c) 2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.

 *

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

 *   modification, are permitted provided that the following conditions
@@ -7007,6 +7008,21 @@ bdev_unlock_lba_range(struct spdk_bdev_desc *desc, struct spdk_io_channel *_ch, 
	return 0;

}



int

spdk_bdev_get_memory_domains(struct spdk_bdev *bdev, struct spdk_memory_domain **domains,

			     int array_size)

{

	if (!bdev) {

		return -EINVAL;

	}



	if (bdev->fn_table->get_memory_domains) {

		return bdev->fn_table->get_memory_domains(bdev->ctxt, domains, array_size);

	}



	return 0;

}



SPDK_LOG_REGISTER_COMPONENT(bdev)



SPDK_TRACE_REGISTER_FN(bdev_trace, "bdev", TRACE_GROUP_BDEV)