xref: /spdk/test/json_config/clear_config.py (revision b30d57cdad6d2bc75cc1e4e2ebbcebcb0d98dcfa) 
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'] == 'bdev_split_create':
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_delete_method(bdev):
34    delete_method_map = {'bdev_malloc_create': "bdev_malloc_delete",
35                         'bdev_null_create': "bdev_null_delete",
36                         'bdev_rbd_create': "bdev_rbd_delete",
37                         'bdev_pmem_create': "bdev_pmem_delete",
38                         'bdev_aio_create': "bdev_aio_delete",
39                         'bdev_error_create': "bdev_error_delete",
40                         'construct_split_vbdev': "destruct_split_vbdev",
41                         'bdev_virtio_attach_controller': "remove_virtio_bdev",
42                         'bdev_crypto_create': "bdev_crypto_delete",
43                         'bdev_delay_create': "bdev_delay_delete",
44                         'bdev_passthru_create': "bdev_passthru_delete",
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(delete_method_map.keys()):
51            destroy_method = delete_method_map[construct_method]
52
53    return destroy_method
54
55
56def clear_bdev_subsystem(args, bdev_config):
57    rpc_bdevs = args.client.call("bdev_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_delete_method(bdev)
62        if destroy_method:
63            args.client.call(destroy_method, {bdev_name_key: bdev_name})
64
65    nvme_controllers = args.client.call("bdev_nvme_get_controllers")
66    for ctrlr in nvme_controllers:
67        args.client.call('bdev_nvme_detach_controller', {'name': ctrlr['name']})
68
69    ''' Disable and reset hotplug '''
70    rpc.bdev.bdev_nvme_set_hotplug(args.client, False)
71
72
73def get_nvmf_destroy_method(nvmf):
74    delete_method_map = {'nvmf_create_subsystem': "nvmf_delete_subsystem"}
75    try:
76        return delete_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    delete_method_map = {'iscsi_create_portal_group': "iscsi_delete_portal_group",
90                         'iscsi_create_initiator_group': "iscsi_delete_initiator_group",
91                         'iscsi_create_target_node': "iscsi_delete_target_node",
92                         'iscsi_set_options': None
93                         }
94    return delete_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'] == 'iscsi_create_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    delete_method_map = {'nbd_start_disk': "nbd_stop_disk"
120                         }
121    return delete_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_accel_subsystem(args, accel_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 ['vhost_scsi_controller_add_target']:
148                args.client.call("vhost_scsi_controller_remove_target",
149                                 {"ctrlr": vhost['params']['ctrlr'],
150                                  "scsi_target_num": vhost['params']['scsi_target_num']})
151            elif method in ['vhost_create_scsi_controller', 'vhost_create_blk_controller',
152                            'vhost_create_nvme_controller']:
153                args.client.call("vhost_delete_controller", {'ctrlr': vhost['params']['ctrlr']})
154
155
156def clear_vmd_subsystem(args, vmd_config):
157    pass
158
159
160def clear_sock_subsystem(args, sock_config):
161    pass
162
163
164def call_test_cmd(func):
165    def rpc_test_cmd(*args, **kwargs):
166        try:
167            func(*args, **kwargs)
168        except JSONRPCException as ex:
169            print((ex.message))
170            exit(1)
171    return rpc_test_cmd
172
173
174if __name__ == "__main__":
175    parser = argparse.ArgumentParser(description='Clear config command')
176    parser.add_argument('-s', dest='server_addr', default='/var/tmp/spdk.sock')
177    parser.add_argument('-p', dest='port', default=5260, type=int)
178    parser.add_argument('-t', dest='timeout', default=60.0, type=float)
179    parser.add_argument('-v', dest='verbose', action='store_const', const="INFO",
180                        help='Set verbose mode to INFO', default="ERROR")
181    parser.add_argument('--verbose', dest='verbose', choices=['DEBUG', 'INFO', 'ERROR'],
182                        help="""Set verbose level. """)
183    subparsers = parser.add_subparsers(help='RPC methods')
184
185    @call_test_cmd
186    def clear_config(args):
187        for subsystem_item in reversed(args.client.call('framework_get_subsystems')):
188            args.subsystem = subsystem_item['subsystem']
189            clear_subsystem(args)
190
191    p = subparsers.add_parser('clear_config', help="""Clear configuration of all SPDK subsystems and targets using JSON RPC""")
192    p.set_defaults(func=clear_config)
193
194    @call_test_cmd
195    def clear_subsystem(args):
196        config = args.client.call('framework_get_config', {"name": args.subsystem})
197        if config is None:
198            return
199        if args.verbose:
200            print("Calling clear_%s_subsystem" % args.subsystem)
201        globals()["clear_%s_subsystem" % args.subsystem](args, config)
202
203    p = subparsers.add_parser('clear_subsystem', help="""Clear configuration of SPDK subsystem using JSON RPC""")
204    p.add_argument('--subsystem', help="""Subsystem name""")
205    p.set_defaults(func=clear_subsystem)
206
207    args = parser.parse_args()
208
209    with rpc.client.JSONRPCClient(args.server_addr, args.port, args.timeout, log_level=getattr(logging, args.verbose.upper())) as client:
210        try:
211            args.client = client
212            args.func(args)
213        except JSONRPCException as ex:
214            print((ex.message))
215            exit(1)
216