Commit 3702517b authored May 22, 2025 by Jacek Kalwas Committed by Tomasz Zawadzki May 29, 2025

util/net: add deprecation for spdk_net_getaddr return behavior



This change aims to align return behavior of net functions to majority
of SPDK public functions. Moreover, it aligns behavior within util/net.

Change-Id: Ie385b30aaddbecce917bfcdefbbdabccd4f90a23
Signed-off-by: Jacek Kalwas <jacek.kalwas@nutanix.com>
Reviewed-on: https://review.spdk.io/c/spdk/spdk/+/26052


Reviewed-by: Tomasz Zawadzki <tomasz@tzawadzki.com>
Tested-by: SPDK Automated Test System <spdkbot@gmail.com>
Reviewed-by: Jim Harris <jim.harris@nvidia.com>

parent 173be047

deprecation.md

+7 −0

Original line number	Diff line number	Diff line
		@@ -19,6 +19,13 @@ The tags can be matched with the level 4 headers below.

		## Deprecation Notices

		### util/net

		#### `spdk_net_getaddr`

		Returning -1 and setting errno on this function is deprecated and will be changed in the 26.01
		release. This function will return negative errno values instead.

		### sock

		#### `spdk_sock_\*`

include/spdk/net.h

+3 −0

Original line number	Diff line number	Diff line
		@@ -52,6 +52,9 @@ bool spdk_net_is_loopback(int fd);
		/*
		* Get local and peer addresses of the given fd.
		*
		* Returning -1 and setting errno is deprecated and will be changed in the 26.01 release.
		* This function will return negative errno values instead.
		*
		* \param fd file descriptor to get address.
		* \param laddr A pointer (may be NULL) to the buffer to hold the local address.
		* \param llen Length of the buffer 'laddr'.