Commit 5c365eb0 authored by Boris Glimcher's avatar Boris Glimcher Committed by Tomasz Zawadzki
Browse files

python/cli: split large file into modules 



this is matching rpc and _rpc.c modules
easier to maintain

Change-Id: Ie994fbdf00fd4d6fa1c8e87ddba22d3dc9671acf
Signed-off-by: default avatarBoris Glimcher <Boris.Glimcher@emc.com>
Reviewed-on: https://review.spdk.io/c/spdk/spdk/+/26135


Community-CI: Mellanox Build Bot
Tested-by: default avatarSPDK Automated Test System <spdkbot@gmail.com>
Reviewed-by: default avatarJim Harris <jim.harris@nvidia.com>
Reviewed-by: default avatarKonrad Sztyber <ksztyber@nvidia.com>
parent 54472431

CHANGELOG.md

+2 −1
Original line number Diff line number Diff line
@@ -4,7 +4,8 @@ 


### python



Moved all cli code inside the python package for easier genration and packaging.

Moved all cli code inside the python package for easier generation and packaging.

Split large rpc python file into modules.



### sock

python/spdk/cli/__init__.py

+21 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: BSD-3-Clause

# Copyright (C) 2025 Dell Inc, or its subsidiaries.  All rights reserved.



from . import accel

from . import app

from . import bdev

from . import blobfs

from . import fsdev

from . import iscsi

from . import keyring

from . import log

from . import lvol

from . import nbd

from . import ublk

from . import notify

from . import nvmf

from . import trace

from . import vhost

from . import vmd

from . import sock

from . import vfio_user

from . import iobuf

from . import parser

python/spdk/cli/accel.py

0 → 100644
+92 −0
Original line number Diff line number Diff line 
#  SPDX-License-Identifier: BSD-3-Clause

#  Copyright (C) 2016 Intel Corporation

#  All rights reserved.

#  Copyright (c) 2022 Dell Inc, or its subsidiaries.

#  Copyright (c) 2022-2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.

#



import sys

import spdk.rpc as rpc  # noqa

from spdk.rpc.client import print_dict, print_json, print_array  # noqa





def add_parser(subparsers):



    def accel_get_opc_assignments(args):

        print_dict(rpc.accel.accel_get_opc_assignments(args.client))



    p = subparsers.add_parser('accel_get_opc_assignments', help='Get list of opcode name to module assignments.')

    p.set_defaults(func=accel_get_opc_assignments)



    def accel_get_module_info(args):

        print_dict(rpc.accel.accel_get_module_info(args.client))



    p = subparsers.add_parser('accel_get_module_info', aliases=['accel_get_engine_info'],

                              help='Get list of valid module names and their operations.')

    p.set_defaults(func=accel_get_module_info)



    def accel_assign_opc(args):

        rpc.accel.accel_assign_opc(args.client, opname=args.opname, module=args.module)



    p = subparsers.add_parser('accel_assign_opc', help='Manually assign an operation to a module.')

    p.add_argument('-o', '--opname', help='opname')

    p.add_argument('-m', '--module', help='name of module')

    p.set_defaults(func=accel_assign_opc)



    def accel_crypto_key_create(args):

        print_dict(rpc.accel.accel_crypto_key_create(args.client,

                                                     cipher=args.cipher,

                                                     key=args.key,

                                                     key2=args.key2,

                                                     tweak_mode=args.tweak_mode,

                                                     name=args.name))



    p = subparsers.add_parser('accel_crypto_key_create', help='Create encryption key')

    p.add_argument('-c', '--cipher', help='cipher', required=True)

    p.add_argument('-k', '--key', help='key', required=True)

    p.add_argument('-e', '--key2', help='key2', default=None)

    p.add_argument('-t', '--tweak-mode', help='tweak mode', default=None)

    p.add_argument('-n', '--name', help='key name', required=True)

    p.set_defaults(func=accel_crypto_key_create)



    def accel_crypto_key_destroy(args):

        print_dict(rpc.accel.accel_crypto_key_destroy(args.client,

                                                      key_name=args.name))



    p = subparsers.add_parser('accel_crypto_key_destroy', help='Destroy encryption key')

    p.add_argument('-n', '--name', help='key name', required=True, type=str)

    p.set_defaults(func=accel_crypto_key_destroy)



    def accel_crypto_keys_get(args):

        print_dict(rpc.accel.accel_crypto_keys_get(args.client,

                                                   key_name=args.key_name))



    p = subparsers.add_parser('accel_crypto_keys_get', help='Get a list of the crypto keys')

    p.add_argument('-k', '--key-name', help='Get information about a specific key', type=str)

    p.set_defaults(func=accel_crypto_keys_get)



    def accel_set_driver(args):

        rpc.accel.accel_set_driver(args.client, name=args.name)



    p = subparsers.add_parser('accel_set_driver', help='Select accel platform driver to execute ' +

                              'operation chains')

    p.add_argument('name', help='name of the platform driver')

    p.set_defaults(func=accel_set_driver)



    def accel_set_options(args):

        rpc.accel.accel_set_options(args.client, args.small_cache_size, args.large_cache_size,

                                    args.task_count, args.sequence_count, args.buf_count)



    p = subparsers.add_parser('accel_set_options', help='Set accel framework\'s options')

    p.add_argument('--small-cache-size', type=int, help='Size of the small iobuf cache')

    p.add_argument('--large-cache-size', type=int, help='Size of the large iobuf cache')

    p.add_argument('--task-count', type=int, help='Maximum number of tasks per IO channel')

    p.add_argument('--sequence-count', type=int, help='Maximum number of sequences per IO channel')

    p.add_argument('--buf-count', type=int, help='Maximum number of buffers per IO channel')

    p.set_defaults(func=accel_set_options)



    def accel_get_stats(args):

        print_dict(rpc.accel.accel_get_stats(args.client))



    p = subparsers.add_parser('accel_get_stats', help='Display accel framework\'s statistics')

    p.set_defaults(func=accel_get_stats)

python/spdk/cli/app.py

0 → 100644
+100 −0
Original line number Diff line number Diff line 
#  SPDX-License-Identifier: BSD-3-Clause

#  Copyright (C) 2016 Intel Corporation

#  All rights reserved.

#  Copyright (c) 2022 Dell Inc, or its subsidiaries.

#  Copyright (c) 2022-2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.

#



import sys

import spdk.rpc as rpc  # noqa

from spdk.rpc.client import print_dict, print_json, print_array  # noqa





def add_parser(subparsers):



    def spdk_kill_instance(args):

        rpc.app.spdk_kill_instance(args.client,

                                   sig_name=args.sig_name)



    p = subparsers.add_parser('spdk_kill_instance', help='Send signal to instance')

    p.add_argument('sig_name', help='signal will be sent to server.')

    p.set_defaults(func=spdk_kill_instance)



    def framework_monitor_context_switch(args):

        enabled = None

        if args.enable:

            enabled = True

        if args.disable:

            enabled = False

        print_dict(rpc.app.framework_monitor_context_switch(args.client,

                                                            enabled=enabled))



    p = subparsers.add_parser('framework_monitor_context_switch',

                              help='Control whether the context switch monitor is enabled')

    p.add_argument('-e', '--enable', action='store_true', help='Enable context switch monitoring')

    p.add_argument('-d', '--disable', action='store_true', help='Disable context switch monitoring')

    p.set_defaults(func=framework_monitor_context_switch)



    def framework_get_reactors(args):

        print_dict(rpc.app.framework_get_reactors(args.client))



    p = subparsers.add_parser(

        'framework_get_reactors', help='Display list of all reactors')

    p.set_defaults(func=framework_get_reactors)



    def framework_set_scheduler(args):

        rpc.app.framework_set_scheduler(args.client,

                                        name=args.name,

                                        period=args.period,

                                        load_limit=args.load_limit,

                                        core_limit=args.core_limit,

                                        core_busy=args.core_busy,

                                        mappings=args.mappings)



    p = subparsers.add_parser(

        'framework_set_scheduler', help='Select thread scheduler that will be activated and its period (experimental)')

    p.add_argument('name', help="Name of a scheduler")

    p.add_argument('-p', '--period', help="Scheduler period in microseconds", type=int)

    p.add_argument('--load-limit', help="Scheduler load limit. Reserved for dynamic scheduler", type=int)

    p.add_argument('--core-limit', help="Scheduler core limit. Reserved for dynamic scheduler", type=int)

    p.add_argument('--core-busy', help="Scheduler core busy limit. Reserved for dynamic scheduler", type=int)

    p.add_argument('--mappings', help="Comma-separated list of thread:core mappings. Reserved for static scheduler")

    p.set_defaults(func=framework_set_scheduler)



    def framework_get_scheduler(args):

        print_dict(rpc.app.framework_get_scheduler(args.client))



    p = subparsers.add_parser(

        'framework_get_scheduler', help='Display currently set scheduler and its properties.')

    p.set_defaults(func=framework_get_scheduler)



    def framework_get_governor(args):

        print_dict(rpc.app.framework_get_governor(args.client))



    p = subparsers.add_parser(

        'framework_get_governor', help='Display currently set governor and the available, set CPU frequencies.')

    p.set_defaults(func=framework_get_governor)



    def scheduler_set_options(args):

        rpc.app.scheduler_set_options(args.client,

                                      isolated_core_mask=args.isolated_core_mask,

                                      scheduling_core=args.scheduling_core)

    p = subparsers.add_parser('scheduler_set_options', help='Set scheduler options')

    p.add_argument('-i', '--isolated-core-mask', help="Mask of CPU cores to isolate from scheduling change", type=str)

    p.add_argument('-s', '--scheduling-core', help="Scheduler scheduling core. Idle threads will move to scheduling core."

                   "Reserved for dynamic scheduler.", type=int)

    p.set_defaults(func=scheduler_set_options)



    def framework_disable_cpumask_locks(args):

        rpc.framework_disable_cpumask_locks(args.client)



    p = subparsers.add_parser('framework_disable_cpumask_locks',

                              help='Disable CPU core lock files.')

    p.set_defaults(func=framework_disable_cpumask_locks)



    def framework_enable_cpumask_locks(args):

        rpc.framework_enable_cpumask_locks(args.client)



    p = subparsers.add_parser('framework_enable_cpumask_locks',

                              help='Enable CPU core lock files.')

    p.set_defaults(func=framework_enable_cpumask_locks)

python/spdk/cli/bdev.py

0 → 100644
+1206 −0

File added.

Preview size limit exceeded, changes collapsed.