forked from emc-openstack/vnx-faulty-device-cleanup
-
Notifications
You must be signed in to change notification settings - Fork 0
/
faulty_device_cleanup.py
346 lines (299 loc) · 13.5 KB
/
faulty_device_cleanup.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
#!/usr/bin/env python
# Copyright (c) 2014 - 2015 EMC Corporation, Inc.
# Copyright (c) 2016 Federal University of Sao Carlos
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
"""
The script to clean up the iSCSI multipath faulty devices
Version history:
0.1.0 - Initial version
0.1.1 - More robust support of SQL connection info
0.1.2 - Use nova.db.sqlalchemy instead of MySQLdb for DB access
0.1.3 - Add more meaningful output
0.1.4 - Fix 'NoneType' and 'KeyError' issues
0.1.5 - Remove deprecated direct DB access in favor of RPC API
"""
import glob
import json
import os
import re
import string
import sys
import fcntl
from oslo_config import cfg
import nova.context
from nova import utils
from nova.conductor import rpcapi as conductor_rpcapi
from nova import objects
from nova.objects import base as objects_base
from nova import rpc
import logging
logging.basicConfig()
CONF = cfg.CONF
def usage():
print("""
Usage:
python %s --config-file /etc/nova/nova.conf [--detection-only]
Note: This script intends to clean up the iSCSI multipath faulty devices
hosted by VNX Block Storage.""" % sys.argv[0])
class FaultyDevicesCleaner(object):
def __init__(self, detection_only=False):
self.detection_only = detection_only
self.faulty_device_num = 0
self.faulty_path_num = 0
self.faulty_devices = []
# Get host name of Nova computer node.
self.host_name = self._get_host_name()
def _get_host_name(self):
(out, err) = utils.execute('hostname')
return out
def _get_ncpu_emc_target_info_list(self):
target_info_list = []
# Find the targets used by VM on the compute node
context = nova.context.get_admin_context()
host_name = string.strip(self.host_name)
instance_uuids = [inst.uuid for inst in
objects.InstanceList.get_by_host(context, host_name)]
for instance_uuid in instance_uuids:
bdms = objects.BlockDeviceMappingList\
.get_by_instance_uuid(context, instance_uuid)
for bdm in bdms:
if bdm.connection_info is None:
continue
conn_info = bdm.connection_info and json.loads(bdm.connection_info)
if conn_info is not None and 'data' in conn_info:
if 'target_iqns' in conn_info['data']:
target_iqns = conn_info['data']['target_iqns']
# Compatible check for VNX icehouse driver
if 'target_luns' in conn_info['data']:
target_luns = conn_info['data']['target_luns']
else:
target_luns = ([conn_info['data']['target_lun']]
* len(target_iqns))
elif 'target_iqn' in conn_info['data']:
target_iqns = [conn_info['data']['target_iqn']]
target_luns = [conn_info['data']['target_lun']]
else:
target_iqns = []
target_luns = []
for target_iqn, target_lun in zip(target_iqns, target_luns):
if 'com.emc' in target_iqn:
target_info = {
'target_iqn': target_iqn,
'target_lun': target_lun,
}
target_info_list.append(target_info)
return target_info_list
def _get_ncpu_emc_target_info_set(self):
target_info_set = set()
for target_info in self._get_ncpu_emc_target_info_list():
target_iqn = target_info['target_iqn']
target_lun = target_info['target_lun']
target_info_key = "%s-%s" % (target_iqn.rsplit('.', 1)[0],
target_lun)
# target_iqn=iqn.1992-04.com.emc:cx.fnm00130200235.a7
# target_lun=203
# target_info_key=iqn.1992-04.com.emc:cx.fnm00130200235-203
target_info_set.add(target_info_key)
return target_info_set
def _get_target_info_key(self, path):
temp_tuple = path.split('-lun-', 1)
target_lun = temp_tuple[1]
target_iqn = temp_tuple[0].split('-iscsi-')[1]
target_info_key = "%s-%s" % (target_iqn.rsplit('.', 1)[0], target_lun)
# path=/dev/disk/by-path/ip-192.168.3.52:3260-iscsi-iqn.1992-
# 04.com.emc:cx.fnm00130200235.a7-lun-203
# target_info_key=iqn.1992-04.com.emc:cx.fnm00130200235-203
return target_info_key
def _get_non_ncpu_target_info_map(self):
# Group the paths by target_info_key
ncpu_target_info_set = self._get_ncpu_emc_target_info_set()
device_paths = self._get_emc_device_paths()
target_info_map = {}
for path in device_paths:
target_info_key = self._get_target_info_key(path)
if target_info_key in ncpu_target_info_set:
if target_info_key not in target_info_map:
target_info_map[target_info_key] = []
target_info_map[target_info_key].append(path)
return target_info_map
def _all_related_paths_faulty(self, paths):
for path in paths:
real_path = os.path.realpath(path)
out, err = self._run_multipath(['-ll', real_path],
run_as_root=True,
check_exit_code=False)
if 'active ready' in out:
# At least one path is still working
return False
return True
def _delete_all_related_paths(self, paths):
for path in paths:
real_path = os.path.realpath(path)
device_name = os.path.basename(real_path)
device_delete = '/sys/block/%s/device/delete' % device_name
if os.path.exists(device_delete):
# Copy '1' from stdin to the device delete control file
#utils.execute('cp', '/dev/stdin', device_delete,
# process_input='1', run_as_root=True)
print("Info: Deleted faulty iSCSI path %s." % path)
else:
print("Warning: Unable to delete %s." % real_path)
def _cleanup_faulty_paths(self):
non_ncpu_target_info_map = self._get_non_ncpu_target_info_map()
for paths in non_ncpu_target_info_map.itervalues():
if self._all_related_paths_faulty(paths):
if self.detection_only:
self.faulty_path_num += len(paths)
for path in paths:
print("Info: Faulty iSCSI path %s." % path)
# Check next without deleting the paths
continue
self._delete_all_related_paths(paths)
if self.detection_only:
print("Info: Found %s faulty iSCSI paths to be deleted."
% self.faulty_path_num)
def _cleanup_faulty_dm_devices(self):
out_ll, err_ll = self._run_multipath(['-ll'],
run_as_root=True,
check_exit_code=False)
# Pattern to split the dm device contents as follows
# Each section starts with a WWN and ends with a line with
# " `-" as the prefix
#
# 3600601601bd032007c097518e96ae411 dm-2 ,
# size=1.0G features='1 queue_if_no_path' hwhandler='1 alua' wp=rw
# `-+- policy='round-robin 0' prio=0 status=active
# `- #:#:#:# - #:# active faulty running
# 36006016020d03200bb93e048f733e411 dm-0 DGC,VRAID
# size=1.0G features='1 queue_if_no_path' hwhandler='1 alua' wp=rw
# |-+- policy='round-robin 0' prio=130 status=active
# | |- 3:0:0:2 sdd 8:48 active ready running
# | `- 5:0:0:2 sdj 8:144 active ready running
# `-+- policy='round-robin 0' prio=10 status=enabled
# |- 4:0:0:2 sdg 8:96 active ready running
# `- 6:0:0:2 sdm 8:192 active ready running
dm_pat = r'([0-9a-fA-F]{30,})[^\n]+,[^\n]*\n[^,]* `-[^\n]*'
dm_m = re.compile(dm_pat)
path_pat = r'- \d+:\d+:\d+:\d+ '
path_m = re.compile(path_pat)
for m in dm_m.finditer(out_ll):
if self.detection_only:
if not ('active ready' in m.group(0)):
self.faulty_device_num += 1
self.faulty_devices.append(m.group(1))
continue
if not path_m.search(m.group(0)):
# Only #:#:#:# remain in the output, all the paths of the dm
# device should have been deleted. No need to keep the device
out_f, err_f = self._run_multipath(['-f', m.group(1)],
run_as_root=True,
check_exit_code=False)
if "map in use" in out_f + err_f:
print("Warning: Could not flush "
"faulty multipath device %s."
% m.group(1))
print("Info: Please retry later "
"or execute 'dmsetup message %s 0 fail_if_no_path' "
"before retrying."
% m.group(1))
else:
print("Info: Deleted faulty multipath device %s."
% m.group(1))
if self.detection_only:
print("Info: Found %s multipath faulty devices to be deleted."
% self.faulty_device_num)
for fdm in self.faulty_devices:
print("Info: %s is faulty." % fdm)
def cleanup(self):
self._cleanup_faulty_paths()
# Make sure the following configuration is in /etc/multipath.conf
# Otherwise, there may be "map in use" failure when deleting
# dm device
#
# defaults {
# flush_on_last_del yes
# }
#
self._cleanup_faulty_dm_devices()
def _get_emc_device_paths(self):
# Find all the EMC iSCSI devices under /dev/disk/by-path
# except LUNZ and partition reference
pattern = '/dev/disk/by-path/ip-*-iscsi-iqn*com.emc*-lun-*'
device_paths = [path for path in glob.glob(pattern)
if ('lun-0' not in path and '-part' not in path)]
return device_paths
def _run_multipath(self, multipath_command, **kwargs):
check_exit_code = kwargs.pop('check_exit_code', 0)
(out, err) = utils.execute('multipath',
*multipath_command,
run_as_root=True,
check_exit_code=check_exit_code)
if ('debug' in CONF and CONF.debug) or False:
print(("Debug: multipath %(command)s\n"
"stdout=\n%(out)s\n"
"stderr=\n%(err)s")
% {'command': multipath_command,
'out': out,
'err': err})
return out, err
def main():
lock_filename = '/tmp/locking.lock'
lock_file = open(lock_filename, 'w')
try:
fcntl.lockf(lock_file, fcntl.LOCK_EX | fcntl.LOCK_NB)
except IOError:
print('Cannot lock: ' + lock_filename)
sys.exit(1)
if len(sys.argv) < 3 or sys.argv[1] != '--config-file':
usage()
exit(1)
detection_only = False
if '--detection-only' in sys.argv:
detection_only = True
sys.argv.remove('--detection-only')
out, err = utils.execute('which', 'multipath', check_exit_code=False)
if 'multipath' not in out:
print('Info: Multipath tools not installed. No cleanup need be done.')
exit(0)
multipath_flush_on_last_del = False
multipath_conf_path = "/etc/multipath.conf"
if os.path.exists(multipath_conf_path):
flush_on_last_del_yes = re.compile(r'\s*flush_on_last_del.*yes')
for line in open(multipath_conf_path, "r"):
if flush_on_last_del_yes.match(line):
multipath_flush_on_last_del = True
break
if not multipath_flush_on_last_del:
print("Warning: 'flush_on_last_del yes' is not seen in"
" /etc/multipath.conf."
" 'map in use' failure may show up during cleanup.")
CONF(sys.argv[1:])
rpc.set_defaults(control_exchange='nova')
rpc.init(CONF)
utils.monkey_patch()
objects.register_all()
objects_base.NovaObject.indirection_api = \
conductor_rpcapi.ConductorAPI()
# connect_volume and disconnect_volume in nova/virt/libvirt/volume.py
# need be adjusted to take the same 'external=True' lock for
# synchronization
@utils.synchronized('connect_volume', external=True)
def do_cleanup(detection_only):
cleaner = FaultyDevicesCleaner(detection_only)
cleaner.cleanup()
do_cleanup(detection_only)
os.unlink('/tmp/locking.lock')
if __name__ == "__main__":
main()