Commit da50ac95 authored by Krzysztof Karas's avatar Krzysztof Karas Committed by Tomasz Zawadzki
Browse files

lib/rpc: deprecate server related functions 



Mark spdk_rpc_accept, spdk_rpc_listen and spdk_rpc_close as deprecated.

Skip adding deprecated log to spdk_rpc_accept to avoid cluttering SPDK
logs, because this function is called multiple times during
application lifetime.

Change-Id: Ida731112261b1304a98ae38e5cd58f860f8d6f00
Signed-off-by: default avatarKrzysztof Karas <krzysztof.karas@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/21319


Reviewed-by: default avatarJim Harris <jim.harris@samsung.com>
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
Community-CI: Mellanox Build Bot
parent 010f6f3f

CHANGELOG.md

+6 −0
Original line number Diff line number Diff line
@@ -128,6 +128,12 @@ the vhost-scsi controller until adding the scsi target is completed. 
Added `vhost_start_scsi_controller` RPC to start vhost-scsi controller, it could be used to support

live recovery feature of vhost-scsi target.



### rpc



Functions `spdk_rpc_listen`, `spdk_rpc_accept` and `spdk_rpc_close` are deprecated and will be

removed in 24.09 release. Please use `spdk_rpc_server_listen`, `spdk_rpc_server_accept` and

`spdk_rpc_server_close` instead.



## v23.09



### accel

deprecation.md

+7 −0
Original line number Diff line number Diff line
@@ -73,3 +73,10 @@ Param `size` in rpc commands `rpc_bdev_lvol_create` and `rpc_bdev_lvol_resize` i 
replace by `size_in_mib`.



See GitHub issue [2346](https://github.com/spdk/spdk/issues/2346) for additional details.



### rpc



#### `spdk_rpc_listen` `spdk_rpc_accept` `spdk_rpc_close`



These functions are deprecated and will be removed in 24.09 release. Please use

`spdk_rpc_server_listen`, `spdk_rpc_server_accept` and `spdk_rpc_server_close` instead.

include/spdk/rpc.h

+6 −0
Original line number Diff line number Diff line
@@ -32,6 +32,8 @@ bool spdk_rpc_verify_methods(void); 
/**

 * Start listening for RPC connections.

 *

 * Deprecated, will be removed in 24.09 release.

 *

 * \param listen_addr Listening address.

 *

 * \return 0 on success, -1 on failure.
@@ -40,11 +42,15 @@ int spdk_rpc_listen(const char *listen_addr); 


/**

 * Poll the RPC server.

 *

 * Deprecated, will be removed in 24.09 release.

 */

void spdk_rpc_accept(void);



/**

 * Stop listening for RPC connections.

 *

 * Deprecated, will be removed in 24.09 release.

 */

void spdk_rpc_close(void);

lib/rpc/rpc.c

+8 −0
Original line number Diff line number Diff line
@@ -202,12 +202,16 @@ _spdk_rpc_listen(const char *listen_addr, struct spdk_rpc_server *server) 
	return 0;

}



SPDK_LOG_DEPRECATION_REGISTER(spdk_rpc_listen, "spdk_rpc_listen is deprecated", "v24.09", 0);



int

spdk_rpc_listen(const char *listen_addr)

{

	struct spdk_rpc_server *server;

	int rc;



	SPDK_LOG_DEPRECATED(spdk_rpc_listen);



	memset(&g_rpc_server.listen_addr_unix, 0, sizeof(g_rpc_server.listen_addr_unix));

	server = &g_rpc_server;
@@ -397,9 +401,13 @@ _spdk_rpc_close(struct spdk_rpc_server *server) 
	}

}



SPDK_LOG_DEPRECATION_REGISTER(spdk_rpc_close, "spdk_rpc_close is deprecated", "v24.09", 0);



void

spdk_rpc_close(void)

{

	SPDK_LOG_DEPRECATED(spdk_rpc_close);



	if (g_rpc_server.jsonrpc_server) {

		_spdk_rpc_close(&g_rpc_server);

	}