Commit 00bbcea0 authored by Jim Harris's avatar Jim Harris Committed by Konrad Sztyber
Browse files

env: add spdk_pci_device_get_numa_id() 



This effectively replaces spdk_pci_device_get_socket_id(), which is
marked obsolete in this patch.

Signed-off-by: default avatarJim Harris <jim.harris@samsung.com>
Change-Id: I1b32adf4f357221e6ae4b98c234ac70a2192b9bc
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/24609


Reviewed-by: default avatarBen Walker <ben@nvidia.com>
Community-CI: Mellanox Build Bot
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarAleksey Marchuk <alexeymar@nvidia.com>
Reviewed-by: default avatarShuhei Matsumoto <smatsumoto@nvidia.com>
Reviewed-by: default avatarKonrad Sztyber <konrad.sztyber@intel.com>
parent 38b1eaa4

deprecation.md

+3 −3
Original line number Diff line number Diff line
@@ -77,7 +77,7 @@ These functions are deprecated and will be removed in 24.09 release. Please use 


### env



#### `spdk_env_get_socket_id`

#### `spdk_env_get_socket_id`, `spdk_pci_device_get_socket_id`



This function is deprecated and will be removed in 25.05 release. Please use

`spdk_env_get_numa_id` instead.
 
These functions are deprecated and will be removed in 25.05 release. Please use

`spdk_env_get_numa_id` and `spdk_pci_device_get_numa_id` instead.

include/spdk/env.h

+15 −1
Original line number Diff line number Diff line
@@ -724,7 +724,10 @@ struct spdk_pci_device { 
	void				*dev_handle;

	struct spdk_pci_addr		addr;

	struct spdk_pci_id		id;

	int				socket_id; /* NUMA socket node ID */

	union {

		int			numa_id;

		int			socket_id; /* Legacy name for this field */

	};

	const char			*type;



	int (*map_bar)(struct spdk_pci_device *dev, uint32_t bar,
@@ -1003,6 +1006,17 @@ struct spdk_pci_id spdk_pci_device_get_id(struct spdk_pci_device *dev); 
 *

 * \return NUMA node index (>= 0).

 */

int spdk_pci_device_get_numa_id(struct spdk_pci_device *dev);



/**

 * Get the NUMA node the PCI device is on.

 *

 * Deprecated. Use `ref spdk_pci_device_get_numa_id()` instead.

 *

 * \param dev PCI device.

 *

 * \return NUMA node index (>= 0).

 */

int spdk_pci_device_get_socket_id(struct spdk_pci_device *dev);



/**

lib/env_dpdk/pci.c

+11 −2
Original line number Diff line number Diff line
@@ -386,7 +386,7 @@ pci_device_init(struct rte_pci_driver *_drv, 
	dev->id.subvendor_id = id->subsystem_vendor_id;

	dev->id.subdevice_id = id->subsystem_device_id;



	dev->socket_id = dpdk_pci_device_get_numa_node(_dev);

	dev->numa_id = dpdk_pci_device_get_numa_node(_dev);

	dev->type = "pci";



	dev->map_bar = map_bar_rte;
@@ -862,10 +862,19 @@ spdk_pci_device_get_id(struct spdk_pci_device *dev) 
	return dev->id;

}



int

spdk_pci_device_get_numa_id(struct spdk_pci_device *dev)

{

	return dev->numa_id;

}



SPDK_LOG_DEPRECATION_REGISTER(pci_device_socket_id, "spdk_pci_device_get_socket_id", "v25.05", 0);



int

spdk_pci_device_get_socket_id(struct spdk_pci_device *dev)

{

	return dev->socket_id;

	SPDK_LOG_DEPRECATED(pci_device_socket_id);

	return spdk_pci_device_get_numa_id(dev);

}



int

lib/env_dpdk/spdk_env_dpdk.map

+1 −0
Original line number Diff line number Diff line
@@ -81,6 +81,7 @@ 
	spdk_pci_device_get_subdevice_id;

	spdk_pci_device_get_id;

	spdk_pci_device_get_socket_id;

	spdk_pci_device_get_numa_id;

	spdk_pci_device_get_serial_number;

	spdk_pci_device_claim;

	spdk_pci_device_unclaim;

lib/vmd/vmd.c

+1 −1
Original line number Diff line number Diff line
@@ -866,7 +866,7 @@ vmd_dev_init(struct vmd_pci_device *dev) 
	dev->pci.addr.bus = dev->bus->bus_number;

	dev->pci.addr.dev = dev->devfn;

	dev->pci.addr.func = 0;

	dev->pci.socket_id = spdk_pci_device_get_socket_id(dev->bus->vmd->pci);

	dev->pci.numa_id = spdk_pci_device_get_numa_id(dev->bus->vmd->pci);

	dev->pci.id.vendor_id = dev->header->common.vendor_id;

	dev->pci.id.device_id = dev->header->common.device_id;

	dev->pci.type = "vmd";