forked from xapi-project/xen-api
/
static-vdis
executable file
·396 lines (347 loc) · 13.9 KB
/
static-vdis
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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
#!/usr/bin/env python
# Common functions for managing statically-attached (ie onboot, without xapi) VDIs
from __future__ import print_function
import sys, os, subprocess, json, urlparse, itertools
import os.path
import time
import XenAPI, inventory, xmlrpclib
main_dir = "/etc/xensource/static-vdis"
xapi_storage_script = "/usr/libexec/xapi-storage-script"
smapiv3_config = "device-config"
MULTIPATH_FLAG = "/var/run/nonpersistent/multipath_enabled"
def call_volume_plugin(name, command, args):
cmd_args = [(xapi_storage_script + "/volume/org.xen.xapi.storage." + name + "/"
+ command), "static-vdis"]
if args:
cmd_args.extend(args)
# on Python >= 3.3 a timout can be set, not on 2.7
# when porting please add a timeout
output = subprocess.check_output(cmd_args)
return json.loads(output)
def call_datapath_plugin(name, command, args):
args = [ xapi_storage_script + "/datapath/" + name + "/" + command, "static-vdis" ] + args
output = subprocess.check_output(args)
return json.loads(output)
def read_whole_file(filename):
f = open(filename)
try:
return reduce(lambda x, y: x + y.decode('utf8'), f.readlines(), "").strip()
finally:
f.close()
def write_whole_file(filename, contents):
f = open(filename, "w")
try:
f.write(contents.encode('utf8'))
finally:
f.close()
def load(name):
"""Return a dictionary describing a single static VDI"""
d = { "id": name }
for key in [ "vdi-uuid", "config", smapiv3_config, "volume-plugin", "volume-uri", "volume-key", "reason" ]:
path = "%s/%s/%s" % (main_dir, name, key)
if os.path.exists(path):
d[key] = read_whole_file(path)
try:
disk = "%s/%s/disk" % (main_dir, name)
os.stat(disk) # throws an error if missing
d["disk"] = os.readlink(disk)
except:
pass
dnb = "False"
try:
os.stat("%s/%s/delete-next-boot" % (main_dir, name))
dnb = "True"
except:
pass
d["delete-next-boot"] = dnb
return d
def wait_for_corosync_quorum():
cmd_args = ['xcli', 'diagnostics', '--json', 'static-vdis']
quorate = False
while not quorate:
output = subprocess.check_output(cmd_args)
output_map = json.loads(output)
quorate = output_map.get('is_quorate')
if not quorate:
time.sleep(1)
def check_clusterstack(ty):
config = call_volume_plugin(ty, "Plugin.Query", None)
if 'corosync' in config.get('required_cluster_stack', ''):
wait_for_corosync_quorum()
def sr_attach(ty, device_config):
check_clusterstack(ty)
args = [arg for (k,v) in device_config.iteritems()
for arg in ["--configuration", k, v]]
return call_volume_plugin(ty, "SR.attach", args)
def list():
all = []
try:
all = os.listdir(main_dir)
except:
pass
return map(load, all)
def fresh_name():
all = []
try:
all = os.listdir(main_dir)
for i in range(0, len(all) + 1): # guarantees to find a unique number
i = str(i)
if not(i in all):
return i
except:
# Directory doesn't exist
os.mkdir(main_dir)
return "0"
def to_string_list(d):
keys = [ "vdi-uuid", "reason", "currently-attached", "delete-next-boot" "path" ]
m = 0
for key in keys:
if len(key) > m:
m = m + len(key)
def left(key, value):
return key + (" " * (m - len(key))) + ": " + value
def right(key, value):
return (" " * (m - len(key))) + key + ": " + value
l = [ left("vdi-uuid", d["vdi-uuid"]), right("reason", d["reason"]) ]
l.append(right("delete-next-boot", d["delete-next-boot"]))
if "disk" in d:
l.append(right("currently-attached", "True"))
l.append(right("path", d['disk']))
else:
l.append(right("currently-attached", "False"))
return l
def add(session, vdi_uuid, reason):
for existing in list():
if existing['vdi-uuid'] == vdi_uuid:
if existing['delete-next-boot'] == "True":
# Undo the 'delete-next-boot' flag to reinstitute
path = main_dir + "/" + existing['id']
os.unlink(path + "/delete-next-boot")
os.unlink(path + "/reason")
write_whole_file(path + "/reason", reason)
# Assume config is still valid
return
raise Exception("Static configuration for VDI already exists")
vdi = session.xenapi.VDI.get_by_uuid(vdi_uuid)
host = session.xenapi.host.get_by_uuid(inventory.get_localhost_uuid ())
sr = session.xenapi.VDI.get_SR(vdi)
ty = session.xenapi.SR.get_type(sr)
sr_uuid = session.xenapi.SR.get_uuid(sr)
# This host's device-config will have info needed to attach SMAPIv3
# SRs.
device_config = None
for p in session.xenapi.host.get_PBDs(host):
p_rec = session.xenapi.PBD.get_record(p)
if p_rec['SR'] == sr:
device_config = p_rec['device_config']
sm = None
all_sm = session.xenapi.SM.get_all_records()
for sm_ref in all_sm.keys():
if all_sm[sm_ref]['type'] == ty:
sm = all_sm[sm_ref]
break
if sm is None:
raise Exception("Unable to discover SM plugin")
data = {
"vdi-uuid": vdi_uuid,
"reason": reason
}
# If the SM supports offline attach then we use it
if "VDI_ATTACH_OFFLINE" in sm["features"]:
data["volume-plugin"] = ty
data[smapiv3_config] = json.dumps(device_config)
sr = sr_attach(ty, device_config)
location = session.xenapi.VDI.get_location(vdi)
stat = call_volume_plugin(ty, "Volume.stat", [ sr, location ])
data["volume-uri"] = stat["uri"][0]
data["volume-key"] = stat["key"]
data["multipath"] = json.dumps(os.path.exists(MULTIPATH_FLAG))
else:
# SMAPIv1
try:
data["driver"] = session.xenapi.SM.get_driver_filename(sm_ref)
data["config"] = session.xenapi.VDI.generate_config(host, vdi)
except XenAPI.Failure as e:
raise Exception("Failed generating static config file: %s" % (str(e)))
# Make a fresh directory in main_dir to store the configuration. Note
# there is no locking so please run this script serially.
fresh = fresh_name()
path = main_dir + "/" + fresh
os.mkdir(path)
for key in data.keys():
write_whole_file(path + "/" + key, data[key])
def delete(vdi_uuid):
found = False
for existing in list():
if existing['vdi-uuid'] == vdi_uuid:
found = True
path = main_dir + "/" + existing['id']
f = open(path + "/delete-next-boot", "w")
f.close()
# If not currently attached then zap the whole tree
if not("disk" in existing):
os.system("/bin/rm -rf %s" % path)
if not found:
raise Exception("Disk configuration not found")
# Copied by util.py
def doexec(args, inputtext=None):
"""Execute a subprocess, then return its return code, stdout and stderr"""
proc = subprocess.Popen(args,stdin=subprocess.PIPE,stdout=subprocess.PIPE,stderr=subprocess.PIPE,close_fds=True)
(stdout,stderr) = proc.communicate(inputtext)
rc = proc.returncode
return (rc,stdout,stderr)
def connect_smapiv1_nbd(params_nbd):
path, export = parse_nbd_uri(params_nbd)
return connect_nbd(path, export)
def call_backend_attach(driver, config):
args = map(lambda arg: arg.encode('utf8'), [driver, config])
xml = doexec(args)
if xml[0] != 0:
raise Exception("SM_BACKEND_FAILURE(%d, %s, %s)" % xml)
xmlrpc = xmlrpclib.loads(xml[1])
if 'params_nbd' in xmlrpc[0][0]:
# Prefer NBD if available
return connect_smapiv1_nbd(xmlrpc[0][0]['params_nbd'])
try:
path = xmlrpc[0][0]['params']
except:
path = xmlrpc[0][0]
return path
def call_backend_detach(driver, config):
params = xmlrpclib.loads(config)[0][0]
params['command'] = 'vdi_detach_from_config'
config = xmlrpclib.dumps(tuple([params]), params['command'])
xml = doexec([ driver, config ])
if xml[0] != 0:
raise Exception("SM_BACKEND_FAILURE(%d, %s, %s)" % xml)
xmlrpc = xmlrpclib.loads(xml[1])
try:
res = xmlrpc[0][0]['params']
except:
res = xmlrpc[0][0]
return res
def connect_nbd(path, exportname):
return subprocess.check_output(
['/opt/xensource/libexec/nbd_client_manager.py', 'connect',
'--path', path,
'--exportname', exportname]).strip()
def disconnect_nbd_device(nbd_device):
subprocess.check_call(
['/opt/xensource/libexec/nbd_client_manager.py', 'disconnect',
'--device', nbd_device])
def parse_nbd_uri(uri):
parts = uri.split(':')
exportname_prefix = 'exportname='
if len(parts) != 4 or \
parts[0:2] != ['nbd', 'unix'] or \
not parts[3].startswith(exportname_prefix):
raise Exception('Got invalid NBD URI for SM backend: ' + uri)
socket_path = parts[2]
exportname = parts[3][len(exportname_prefix):]
return (socket_path, exportname)
def attach(vdi_uuid):
found = False
for existing in list():
if existing['vdi-uuid'] == vdi_uuid:
found = True
if not('path' in existing):
d = main_dir + "/" + existing['id']
# Delete any old symlink
try:
os.unlink(d + "/disk")
except:
pass
path = None
if not (os.path.exists(d + "/" + smapiv3_config)):
# SMAPIv1
config = read_whole_file(d + "/config")
driver = read_whole_file(d + "/driver")
path = call_backend_attach(driver, config)
else:
volume_plugin = read_whole_file(d + "/volume-plugin")
configuration = json.loads(read_whole_file(d + "/" + smapiv3_config))
vol_key = read_whole_file(d + "/volume-key")
vol_uri = read_whole_file(d + "/volume-uri")
multipath = json.loads(read_whole_file(d + "/multipath"))
scheme = urlparse.urlparse(vol_uri).scheme
# Set the multipath flag if required
if multipath:
with open(MULTIPATH_FLAG, 'a'):
os.utime(MULTIPATH_FLAG, None)
sr = sr_attach(volume_plugin, configuration)
attach = call_datapath_plugin(scheme, "Datapath.attach", [ vol_uri, "0" ])
(name, implementation) = \
next((name, impl)
for (name, impl)
in attach['implementations']
if name in ['BlockDevice', 'File', 'Nbd'])
call_datapath_plugin(scheme, "Datapath.activate", [ vol_uri, "0" ])
if name in ['BlockDevice', 'File']:
path = implementation['path']
elif name == 'Nbd':
uri = implementation['uri']
(path, exportname) = parse_nbd_uri(uri)
path = connect_nbd(path=path, exportname=exportname)
os.symlink(path, d + "/disk")
return d + "/disk"
if not found:
raise Exception("Disk configuration not found")
def detach(vdi_uuid):
found = False
for existing in list():
if existing['vdi-uuid'] == vdi_uuid:
if not ('disk' in existing):
return
found = True
d = main_dir + "/" + existing['id']
disk = existing['disk']
if disk.startswith('/dev/nbd'):
disconnect_nbd_device(disk)
if not (os.path.exists(d + "/" + smapiv3_config)):
# SMAPIv1
config = read_whole_file(d + "/config")
driver = read_whole_file(d + "/driver")
call_backend_detach(driver, config)
else:
volume_plugin = read_whole_file(d + "/volume-plugin")
vol_key = read_whole_file(d + "/volume-key")
vol_uri = read_whole_file(d + "/volume-uri")
scheme = urlparse.urlparse(vol_uri).scheme
call_datapath_plugin(scheme, "Datapath.deactivate", [ vol_uri, "0" ])
call_datapath_plugin(scheme, "Datapath.detach", [ vol_uri, "0" ])
os.unlink(d + "/disk")
return
if not found:
raise Exception("Disk configuration not found")
def usage():
print("Usage:")
print(" %s list -- print a list of VDIs which will be attached on host boot" % sys.argv[0])
print(" %s add <uuid> <reason> -- make the VDI <uuid> available on host boot" % sys.argv[0])
print(" %s del <uuid> -- cease making the VDI <uuid> available on host boot" % sys.argv[0])
print(" %s attach <uuid> -- attach the VDI immediately" % sys.argv[0])
print(" %s detach <uuid> -- detach the VDI immediately" % sys.argv[0])
sys.exit(1)
if __name__ == "__main__":
if len(sys.argv) < 2:
usage()
if sys.argv[1] == "list" and len(sys.argv) == 2:
for i in list ():
for line in to_string_list(i):
print(line)
print()
elif sys.argv[1] == "add" and len(sys.argv) == 4:
session = XenAPI.xapi_local()
session.xenapi.login_with_password("root", "", "1.0", "xen-api-scripts-static-vdis")
try:
add(session, sys.argv[2], sys.argv[3])
finally:
session.xenapi.logout()
elif sys.argv[1] == "del" and len(sys.argv) == 3:
delete(sys.argv[2])
elif sys.argv[1] == "attach" and len(sys.argv) == 3:
path = attach(sys.argv[2])
print(path)
elif sys.argv[1] == "detach" and len(sys.argv) == 3:
detach(sys.argv[2])
else:
usage()