xref: /spdk/test/json_config/clear_config.py (revision 407e88fd2ab020d753e33014cf759353a9901b51) 
1#!/usr/bin/env python3
2
3import os
4import sys
5import argparse
6import logging
7sys.path.append(os.path.join(os.path.dirname(__file__), "../../scripts"))
8import rpc   # noqa
9from rpc.client import print_dict, JSONRPCException  # noqa
10
11
12def get_bdev_name_key(bdev):
13    bdev_name_key = 'name'
14    if 'method' in bdev and bdev['method'] == 'construct_split_vbdev':
15        bdev_name_key = "base_bdev"
16    return bdev_name_key
17
18
19def get_bdev_name(bdev):
20    bdev_name = None
21    if 'params' in bdev:
22        if 'name' in bdev['params']:
23            bdev_name = bdev['params']['name']
24        elif 'base_name' in bdev['params']:
25            bdev_name = bdev['params']['base_name']
26        elif 'base_bdev' in bdev['params']:
27            bdev_name = bdev['params']['base_bdev']
28    if 'method' in bdev and bdev['method'] == 'bdev_error_create':
29        bdev_name = "EE_%s" % bdev_name
30    return bdev_name
31
32
33def get_bdev_destroy_method(bdev):
34    destroy_method_map = {'bdev_malloc_create': "delete_malloc_bdev",
35                          'construct_null_bdev': "delete_null_bdev",
36                          'construct_rbd_bdev': "delete_rbd_bdev",
37                          'construct_pmem_bdev': "delete_pmem_bdev",
38                          'bdev_aio_create': "bdev_aio_delete",
39                          'bdev_error_create': "bdev_error_delete",
40                          'construct_split_vbdev': "destruct_split_vbdev",
41                          'construct_virtio_dev': "remove_virtio_bdev",
42                          'bdev_crypto_create': "bdev_crypto_delete",
43                          'bdev_delay_create': "bdev_delay_delete",
44                          'construct_passthru_bdev': "delete_passthru_bdev",
45                          'bdev_compress_create': 'bdev_compress_delete',
46                          }
47    destroy_method = None
48    if 'method' in bdev:
49        construct_method = bdev['method']
50        if construct_method in list(destroy_method_map.keys()):
51            destroy_method = destroy_method_map[construct_method]
52
53    return destroy_method
54
55
56def clear_bdev_subsystem(args, bdev_config):
57    rpc_bdevs = args.client.call("get_bdevs")
58    for bdev in bdev_config:
59        bdev_name_key = get_bdev_name_key(bdev)
60        bdev_name = get_bdev_name(bdev)
61        destroy_method = get_bdev_destroy_method(bdev)
62        if destroy_method:
63            args.client.call(destroy_method, {bdev_name_key: bdev_name})
64
65    nvme_controllers = args.client.call("get_nvme_controllers")
66    for ctrlr in nvme_controllers:
67        args.client.call('delete_nvme_controller', {'name': ctrlr['name']})
68
69    ''' Disable and reset hotplug '''
70    rpc.bdev.set_bdev_nvme_hotplug(args.client, False)
71
72
73def get_nvmf_destroy_method(nvmf):
74    destroy_method_map = {'nvmf_subsystem_create': "delete_nvmf_subsystem"}
75    try:
76        return destroy_method_map[nvmf['method']]
77    except KeyError:
78        return None
79
80
81def clear_nvmf_subsystem(args, nvmf_config):
82    for nvmf in nvmf_config:
83        destroy_method = get_nvmf_destroy_method(nvmf)
84        if destroy_method:
85            args.client.call(destroy_method, {'nqn': nvmf['params']['nqn']})
86
87
88def get_iscsi_destroy_method(iscsi):
89    destroy_method_map = {'add_portal_group': "delete_portal_group",
90                          'add_initiator_group': "delete_initiator_group",
91                          'construct_target_node': "delete_target_node",
92                          'set_iscsi_options': None
93                          }
94    return destroy_method_map[iscsi['method']]
95
96
97def get_iscsi_name(iscsi):
98    if 'name' in iscsi['params']:
99        return iscsi['params']['name']
100    else:
101        return iscsi['params']['tag']
102
103
104def get_iscsi_name_key(iscsi):
105    if iscsi['method'] == 'construct_target_node':
106        return "name"
107    else:
108        return 'tag'
109
110
111def clear_iscsi_subsystem(args, iscsi_config):
112    for iscsi in iscsi_config:
113        destroy_method = get_iscsi_destroy_method(iscsi)
114        if destroy_method:
115            args.client.call(destroy_method, {get_iscsi_name_key(iscsi): get_iscsi_name(iscsi)})
116
117
118def get_nbd_destroy_method(nbd):
119    destroy_method_map = {'start_nbd_disk': "stop_nbd_disk"
120                          }
121    return destroy_method_map[nbd['method']]
122
123
124def clear_nbd_subsystem(args, nbd_config):
125    for nbd in nbd_config:
126        destroy_method = get_nbd_destroy_method(nbd)
127        if destroy_method:
128            args.client.call(destroy_method, {'nbd_device': nbd['params']['nbd_device']})
129
130
131def clear_net_framework_subsystem(args, net_framework_config):
132    pass
133
134
135def clear_copy_subsystem(args, copy_config):
136    pass
137
138
139def clear_interface_subsystem(args, interface_config):
140    pass
141
142
143def clear_vhost_subsystem(args, vhost_config):
144    for vhost in reversed(vhost_config):
145        if 'method' in vhost:
146            method = vhost['method']
147            if method in ['add_vhost_scsi_lun']:
148                args.client.call("remove_vhost_scsi_target",
149                                 {"ctrlr": vhost['params']['ctrlr'],
150                                  "scsi_target_num": vhost['params']['scsi_target_num']})
151            elif method in ['construct_vhost_scsi_controller', 'construct_vhost_blk_controller',
152                            'construct_vhost_nvme_controller']:
153                args.client.call("remove_vhost_controller", {'ctrlr': vhost['params']['ctrlr']})
154
155
156def call_test_cmd(func):
157    def rpc_test_cmd(*args, **kwargs):
158        try:
159            func(*args, **kwargs)
160        except JSONRPCException as ex:
161            print((ex.message))
162            exit(1)
163    return rpc_test_cmd
164
165
166if __name__ == "__main__":
167    parser = argparse.ArgumentParser(description='Clear config command')
168    parser.add_argument('-s', dest='server_addr', default='/var/tmp/spdk.sock')
169    parser.add_argument('-p', dest='port', default=5260, type=int)
170    parser.add_argument('-t', dest='timeout', default=60.0, type=float)
171    parser.add_argument('-v', dest='verbose', action='store_const', const="INFO",
172                        help='Set verbose mode to INFO', default="ERROR")
173    parser.add_argument('--verbose', dest='verbose', choices=['DEBUG', 'INFO', 'ERROR'],
174                        help="""Set verbose level. """)
175    subparsers = parser.add_subparsers(help='RPC methods')
176
177    @call_test_cmd
178    def clear_config(args):
179        for subsystem_item in reversed(args.client.call('get_subsystems')):
180            args.subsystem = subsystem_item['subsystem']
181            clear_subsystem(args)
182
183    p = subparsers.add_parser('clear_config', help="""Clear configuration of all SPDK subsystems and targets using JSON RPC""")
184    p.set_defaults(func=clear_config)
185
186    @call_test_cmd
187    def clear_subsystem(args):
188        config = args.client.call('get_subsystem_config', {"name": args.subsystem})
189        if config is None:
190            return
191        if args.verbose:
192            print("Calling clear_%s_subsystem" % args.subsystem)
193        globals()["clear_%s_subsystem" % args.subsystem](args, config)
194
195    p = subparsers.add_parser('clear_subsystem', help="""Clear configuration of SPDK subsystem using JSON RPC""")
196    p.add_argument('--subsystem', help="""Subsystem name""")
197    p.set_defaults(func=clear_subsystem)
198
199    args = parser.parse_args()
200
201    with rpc.client.JSONRPCClient(args.server_addr, args.port, args.timeout, log_level=getattr(logging, args.verbose.upper())) as client:
202        try:
203            args.client = client
204            args.func(args)
205        except JSONRPCException as ex:
206            print((ex.message))
207            exit(1)
208