Commit aa24f024 authored by Jim Harris's avatar Jim Harris Committed by Tomasz Zawadzki
Browse files

bdev/compress: deprecate this module 



The compress bdev module leverages the reduce library for its
compression functionality. Since the reduce library is deprecated,
the bdev compress module is too.

See commit messages for the reduce library deprecation for further
information.

Signed-off-by: default avatarJim Harris <jim.harris@nvidia.com>
Change-Id: Ibc383d595e0fe29cdf868fe766532986cffb06bb
Reviewed-on: https://review.spdk.io/c/spdk/spdk/+/25943


Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Community-CI: Mellanox Build Bot
Tested-by: default avatarSPDK Automated Test System <spdkbot@gmail.com>
Reviewed-by: default avatarYankun Li <845245370@qq.com>
Reviewed-by: default avatarKonrad Sztyber <ksztyber@nvidia.com>
Reviewed-by: default avatarTomasz Zawadzki <tomasz@tzawadzki.com>
parent 0d5c0b5a

deprecation.md

+8 −0
Original line number Diff line number Diff line
@@ -48,3 +48,11 @@ These functions are deprecated and will be removed in 25.09 release. Please use 
The entire reduce library is deprecated and will be removed in 25.09 release.

All functions in this library are effectively deprecated, but only these two

are officially marked as such to ensure the library's deprecation is noticed.



### bdev_compress



#### 'bdev_compress_create', 'bdev_compress_delete', 'bdev_compress_get_orphans' RPCs



The entire bdev compress module is deprecated and will be removed in 25.09

release. The C module exports no public APIs, so none are listed here, but

the module will emit deprecation warnings when usage is detected.

module/bdev/compress/vbdev_compress.c

+3 −0
Original line number Diff line number Diff line
@@ -1279,6 +1279,8 @@ static int _set_compbdev_name(struct vbdev_compress *comp_bdev) 
	return 0;

}



SPDK_LOG_DEPRECATION_REGISTER(bdev_compress_module, "bdev compress module", "v25.09", 0)



static int

vbdev_compress_claim(struct vbdev_compress *comp_bdev)

{
@@ -1338,6 +1340,7 @@ vbdev_compress_claim(struct vbdev_compress *comp_bdev) 
		goto error_claim;

	}



	SPDK_LOG_DEPRECATED(bdev_compress_module);

	rc = spdk_bdev_register(&comp_bdev->comp_bdev);

	if (rc < 0) {

		SPDK_ERRLOG("trying to register bdev, error %s\n", spdk_strerror(-rc));

scripts/rpc.py

+3 −0
Original line number Diff line number Diff line
@@ -260,6 +260,7 @@ def main(): 
    p.set_defaults(func=bdev_wait_for_examine)



    def bdev_compress_create(args):

        print("bdev_compress_create RPC is deprecated", file=sys.stderr)

        print_json(rpc.bdev.bdev_compress_create(args.client,

                                                 base_bdev_name=args.base_bdev_name,

                                                 pm_path=args.pm_path,
@@ -280,6 +281,7 @@ def main(): 
    p.set_defaults(func=bdev_compress_create)



    def bdev_compress_delete(args):

        print("bdev_compress_delete RPC is deprecated", file=sys.stderr)

        rpc.bdev.bdev_compress_delete(args.client,

                                      name=args.name)
@@ -288,6 +290,7 @@ def main(): 
    p.set_defaults(func=bdev_compress_delete)



    def bdev_compress_get_orphans(args):

        print("bdev_compress_get_orphans RPC is deprecated", file=sys.stderr)

        print_dict(rpc.bdev.bdev_compress_get_orphans(args.client,

                                                      name=args.name))

    p = subparsers.add_parser(