forked from kimchi-project/kimchi
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vmtemplate.py
525 lines (440 loc) · 18.8 KB
/
vmtemplate.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
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
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
#
# Project Kimchi
#
# Copyright IBM, Corp. 2013-2015
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
import os
import platform
import psutil
import stat
import time
import urlparse
import uuid
from lxml import etree
from lxml.builder import E
from wok.exception import InvalidParameter, ImageFormatError, IsoFormatError
from wok.exception import MissingParameter, OperationFailed
from wok.plugins.kimchi import imageinfo
from wok.plugins.kimchi import osinfo
from wok.plugins.kimchi.isoinfo import IsoImage
from wok.plugins.kimchi.utils import check_url_path, pool_name_from_uri
from wok.plugins.kimchi.xmlutils.cpu import get_cpu_xml
from wok.plugins.kimchi.xmlutils.disk import get_disk_xml
from wok.plugins.kimchi.xmlutils.graphics import get_graphics_xml
from wok.plugins.kimchi.xmlutils.interface import get_iface_xml
from wok.plugins.kimchi.xmlutils.qemucmdline import get_qemucmdline_xml
from wok.plugins.kimchi.xmlutils.serial import get_serial_xml
# In PowerPC, memories must be aligned to 256 MiB
PPC_MEM_ALIGN = 256
# Max memory 1TB, in KiB
MAX_MEM_LIM = 1073741824
class VMTemplate(object):
def __init__(self, args, scan=False):
"""
Construct a VM Template from a widely variable amount of information.
The only required parameter is a name for the VMTemplate. If present,
the os_distro and os_version fields are used to lookup recommended
settings. Any parameters provided by the caller will override the
defaults. If scan is True and a cdrom or a base img is present, the
operating system will be detected by probing the installation media.
"""
self.info = {}
self.fc_host_support = args.get('fc_host_support')
# Fetch defaults based on the os distro and version
try:
distro, version = self._get_os_info(args, scan)
except ImageFormatError as e:
raise OperationFailed('KCHTMPL0020E', {'err': e.message})
os_distro = args.get('os_distro', distro)
os_version = args.get('os_version', version)
entry = osinfo.lookup(os_distro, os_version)
self.info.update(entry)
# Auto-generate a template name if no one is passed
if 'name' not in args or args['name'] == '':
args['name'] = self._gen_name(distro, version)
self.name = args['name']
# Merge graphics settings
graph_args = args.get('graphics')
if graph_args:
graphics = dict(self.info['graphics'])
graphics.update(graph_args)
args['graphics'] = graphics
default_disk = self.info['disks'][0]
# Override template values according to 'args'
self.info.update(args)
disks = self.info.get('disks')
basic_disk = ['index', 'format', 'pool', 'size']
ro_disk = ['index', 'format', 'pool', 'volume']
base_disk = ['index', 'base', 'pool', 'size', 'format']
for index, disk in enumerate(disks):
disk_info = dict(default_disk)
pool_type = self._get_storage_type(disk['pool']['name'])
if pool_type in ['iscsi', 'scsi']:
disk_info = {'index': 0, 'format': 'raw', 'volume': None}
disk_info.update(disk)
pool_name = disk_info.get('pool', {}).get('name')
if pool_name is None:
raise MissingParameter('KCHTMPL0028E')
keys = sorted(disk_info.keys())
if ((keys != sorted(basic_disk)) and (keys != sorted(ro_disk)) and
(keys != sorted(base_disk))):
raise MissingParameter('KCHTMPL0028E')
if pool_type in ['logical', 'iscsi', 'scsi']:
if disk_info['format'] != 'raw':
raise InvalidParameter('KCHTMPL0029E')
disk_info['pool']['type'] = pool_type
disk_info['index'] = disk_info.get('index', index)
self.info['disks'][index] = disk_info
def _get_os_info(self, args, scan):
distro = version = 'unknown'
# Identify the cdrom if present
iso = args.get('cdrom', '')
if len(iso) > 0:
if not iso.startswith('/'):
self.info.update({'iso_stream': True})
if scan:
distro, version = self.get_iso_info(iso)
return distro, version
# CDROM is not presented: check for base image
base_imgs = []
for d in args.get('disks', []):
if 'base' in d.keys():
base_imgs.append(d)
if scan:
distro, version = imageinfo.probe_image(d['base'])
if 'size' not in d.keys():
d_info = imageinfo.probe_img_info(d['base'])
d['size'] = d_info['virtual-size']
if len(base_imgs) == 0:
raise MissingParameter("KCHTMPL0016E")
return distro, version
def _gen_name(self, distro, version):
if distro == 'unknown':
name = str(uuid.uuid4())
else:
name = distro + version + '.' + str(int(time.time() * 1000))
return name
def get_iso_info(self, iso):
iso_prefixes = ['/', 'http', 'https', 'ftp', 'ftps', 'tftp']
if len(filter(iso.startswith, iso_prefixes)) == 0:
raise InvalidParameter("KCHTMPL0006E", {'param': iso})
try:
iso_img = IsoImage(iso)
return iso_img.probe()
except IsoFormatError:
raise InvalidParameter("KCHISO0001E", {'filename': iso})
def _get_cdrom_xml(self, libvirt_stream_protocols):
if 'cdrom' not in self.info:
return ''
params = {}
params['type'] = 'cdrom'
params['format'] = 'raw'
params['bus'] = self.info['cdrom_bus']
params['index'] = self.info['cdrom_index']
params['path'] = self.info['cdrom']
if self.info.get('iso_stream', False):
protocol = urlparse.urlparse(params['path']).scheme
if protocol not in libvirt_stream_protocols:
driveOpt = 'file=%(path)s,if=none,id=drive-%(bus)s0-1-0,'
driveOpt += 'readonly=on,format=%(format)s'
deviceOpt = '%(bus)s-cd,bus=%(bus)s.1,unit=0,'
deviceOpt += 'drive=drive-%(bus)s0-1-0,id=%(bus)s0-1-0'
args = {}
args['-drive'] = driveOpt % params
args['-device'] = deviceOpt % params
# return qemucmdline XML
return get_qemucmdline_xml(args)
dev, xml = get_disk_xml(params)
return xml
def _get_disks_xml(self, vm_uuid):
base_disk_params = {'type': 'disk', 'disk': 'file',
'bus': self.info['disk_bus']}
logical_disk_params = {'format': 'raw'}
iscsi_disk_params = {'disk': 'block', 'format': 'raw'}
scsi_disk = 'volume' if self.fc_host_support else 'block'
scsi_disk_params = {'disk': scsi_disk, 'type': 'lun',
'format': 'raw', 'bus': 'scsi'}
disks_xml = ''
for index, disk in enumerate(self.info['disks']):
params = dict(base_disk_params)
params['format'] = disk['format']
params['index'] = index
params.update(locals().get('%s_disk_params' %
disk['pool']['type'], {}))
volume = disk.get('volume')
if volume is not None:
params['path'] = self._get_volume_path(disk['pool']['name'],
volume)
else:
img = "%s-%s.img" % (vm_uuid, params['index'])
storage_path = self._get_storage_path(disk['pool']['name'])
params['path'] = os.path.join(storage_path, img)
params['pool_type'] = disk['pool']['type']
disks_xml += get_disk_xml(params)[1]
return unicode(disks_xml, 'utf-8')
def to_volume_list(self, vm_uuid):
ret = []
for i, d in enumerate(self.info['disks']):
# Create only .img. If storagepool is (i)SCSI, volumes will be LUNs
if d['pool']['type'] in ["iscsi", "scsi"]:
continue
index = d.get('index', i)
volume = "%s-%s.img" % (vm_uuid, index)
storage_path = self._get_storage_path(d['pool']['name'])
info = {'name': volume,
'capacity': d['size'],
'format': d['format'],
'path': '%s/%s' % (storage_path, volume),
'pool': d['pool']['name']}
if 'logical' == d['pool']['type'] or \
info['format'] not in ['qcow2', 'raw']:
info['allocation'] = info['capacity']
else:
info['allocation'] = 0
if 'base' in d:
info['base'] = dict()
base_fmt = imageinfo.probe_img_info(d['base'])['format']
if base_fmt is None:
raise InvalidParameter("KCHTMPL0024E", {'path': d['base']})
info['base']['path'] = d['base']
info['base']['format'] = base_fmt
v_tree = E.volume(E.name(info['name']))
v_tree.append(E.allocation(str(info['allocation']), unit='G'))
v_tree.append(E.capacity(str(info['capacity']), unit='G'))
target_fmt = info['format']
if 'base' in d:
# target must be qcow2 in order to use a backing file
target_fmt = 'qcow2'
v_tree.append(E.backingStore(
E.path(info['base']['path']),
E.format(type=info['base']['format'])))
target = E.target(
E.format(type=target_fmt), E.path(info['path']))
v_tree.append(target)
info['xml'] = etree.tostring(v_tree)
ret.append(info)
return ret
def _get_networks_xml(self):
networks = ""
params = {'type': 'network',
'model': self.info['nic_model']}
for nw in self.info['networks']:
params['network'] = nw
networks += get_iface_xml(params, self.info['arch'],
self.info['os_distro'],
self.info['os_version'])
return unicode(networks, 'utf-8')
def _get_input_output_xml(self):
sound = """
<sound model='%(sound_model)s' />
"""
mouse = """
<input type='mouse' bus='%(mouse_bus)s'/>
"""
keyboard = """
<input type='%(kbd_type)s' bus='%(kbd_bus)s'> </input>
"""
tablet = """
<input type='tablet' bus='%(kbd_bus)s'> </input>
"""
video = """
<video>
<model type='%(video_model)s'/>
</video>
"""
input_output = ""
if 'mouse_bus' in self.info.keys():
input_output += mouse % self.info
if 'kbd_bus' in self.info.keys():
input_output += keyboard % self.info
if 'tablet_bus' in self.info.keys():
input_output += tablet % self.info
if 'sound_model' in self.info.keys():
input_output += sound % self.info
if 'video_model' in self.info.keys():
input_output += video % self.info
return input_output
def _get_cpu_xml(self):
# Include CPU topology, if provided
cpu_info = self.info.get('cpu_info')
if cpu_info is not None:
cpu_topo = cpu_info.get('topology')
return get_cpu_xml(0,
self.info.get('memory') << 10,
cpu_topo)
def _get_max_memory(self, guest_memory):
# Setting maxMemory of the VM, which will be lesser value between:
# 1TB, (Template Memory * 4), Host Physical Memory.
max_memory = MAX_MEM_LIM
if hasattr(psutil, 'virtual_memory'):
host_memory = psutil.virtual_memory().total >> 10
else:
host_memory = psutil.TOTAL_PHYMEM >> 10
if host_memory < max_memory:
max_memory = host_memory
if (((guest_memory * 4) << 10) < max_memory):
max_memory = (guest_memory * 4) << 10
# set up arch to ppc64 instead of ppc64le due to libvirt compatibility
if self.info["arch"] == "ppc64":
# in Power, memory must be aligned in 256MiB
if (max_memory >> 10) % PPC_MEM_ALIGN != 0:
alignment = max_memory % (PPC_MEM_ALIGN << 10)
max_memory -= alignment
return max_memory
def to_vm_xml(self, vm_name, vm_uuid, **kwargs):
params = dict(self.info)
params['name'] = vm_name
params['uuid'] = vm_uuid
params['networks'] = self._get_networks_xml()
params['input_output'] = self._get_input_output_xml()
params['qemu-namespace'] = ''
params['cdroms'] = ''
params['qemu-stream-cmdline'] = ''
params['disks'] = self._get_disks_xml(vm_uuid)
params['serial'] = get_serial_xml(params)
graphics = dict(self.info['graphics'])
graphics.update(kwargs.get('graphics', {}))
params['graphics'] = get_graphics_xml(graphics)
libvirt_stream_protocols = kwargs.get('libvirt_stream_protocols', [])
cdrom_xml = self._get_cdrom_xml(libvirt_stream_protocols)
max_vcpus = kwargs.get('max_vcpus', 1)
if not urlparse.urlparse(self.info.get('cdrom', "")).scheme in \
libvirt_stream_protocols and \
params.get('iso_stream', False):
params['qemu-stream-cmdline'] = cdrom_xml
else:
params['cdroms'] = cdrom_xml
# max memory
params['max_memory'] = self._get_max_memory(params['memory'])
# Setting maximum number of slots to avoid errors when hotplug memory
# Number of slots are the numbers of chunks of 1GB that fit inside
# the max_memory of the host minus memory assigned to the VM. It
# cannot have more than 32 slots in Power.
params['slots'] = ((params['max_memory'] >> 10) -
params['memory']) >> 10
if params['slots'] < 0:
raise OperationFailed("KCHVM0041E",
{'maxmem': str(params['max_memory'] >> 10)})
elif params['slots'] == 0:
params['slots'] = 1
elif params['slots'] > 32:
distro, _, _ = platform.linux_distribution()
if distro == "IBM_PowerKVM":
params['slots'] = 32
# set a hard limit using max_memory + 1GiB
params['hard_limit'] = params['max_memory'] + (1024 << 10)
cpu_topo = self.info.get('cpu_info').get('topology')
if (cpu_topo is not None):
sockets = int(max_vcpus / (cpu_topo['cores'] *
cpu_topo['threads']))
self.info['cpu_info']['topology']['sockets'] = sockets
# Reduce maxvcpu to fit number of sockets if necessary
total_max_vcpu = sockets * cpu_topo['cores'] * cpu_topo['threads']
if total_max_vcpu != max_vcpus:
max_vcpus = total_max_vcpu
params['vcpus'] = "<vcpu current='%s'>%d</vcpu>" % \
(params['cpus'], max_vcpus)
else:
params['vcpus'] = "<vcpu current='%s'>%d</vcpu>" % \
(params['cpus'], max_vcpus)
params['cpu_info'] = self._get_cpu_xml()
xml = """
<domain type='%(domain)s'>
%(qemu-stream-cmdline)s
<name>%(name)s</name>
<uuid>%(uuid)s</uuid>
<memtune>
<hard_limit unit='KiB'>%(hard_limit)s</hard_limit>
</memtune>
<maxMemory slots='%(slots)s' unit='KiB'>%(max_memory)s</maxMemory>
<memory unit='MiB'>%(memory)s</memory>
%(vcpus)s
%(cpu_info)s
<os>
<type arch='%(arch)s'>hvm</type>
<boot dev='hd'/>
<boot dev='cdrom'/>
</os>
<features>
<acpi/>
<apic/>
<pae/>
</features>
<clock offset='utc'/>
<on_poweroff>destroy</on_poweroff>
<on_reboot>restart</on_reboot>
<on_crash>restart</on_crash>
<devices>
%(disks)s
%(cdroms)s
%(networks)s
%(graphics)s
%(input_output)s
%(serial)s
<memballoon model='virtio' />
</devices>
</domain>
""" % params
return xml
def validate(self):
for disk in self.info.get('disks'):
pool_uri = disk.get('pool', {}).get('name')
self._storage_validate(pool_uri)
self._network_validate()
self._iso_validate()
def _iso_validate(self):
pass
def _network_validate(self):
pass
def _storage_validate(self):
pass
def fork_vm_storage(self, vm_uuid):
pass
def _get_storage_path(self, pool_uri=None):
return ''
def _get_storage_type(self, pool=None):
return ''
def _get_volume_path(self):
return ''
def _get_all_networks_name(self):
return []
def _get_all_storagepools_name(self):
return []
def validate_integrity(self):
invalid = {}
# validate networks integrity
invalid_networks = list(set(self.info['networks']) -
set(self._get_all_networks_name()))
if invalid_networks:
invalid['networks'] = invalid_networks
# validate storagepools integrity
for disk in self.info['disks']:
pool_uri = disk['pool']['name']
pool_name = pool_name_from_uri(pool_uri)
if pool_name not in self._get_all_storagepools_name():
invalid['storagepools'] = [pool_name]
# validate iso integrity
# FIXME when we support multiples cdrom devices
iso = self.info.get('cdrom')
if iso:
if os.path.exists(iso):
st_mode = os.stat(iso).st_mode
if not (stat.S_ISREG(st_mode) or stat.S_ISBLK(st_mode)):
invalid['cdrom'] = [iso]
elif not check_url_path(iso):
invalid['cdrom'] = [iso]
self.info['invalid'] = invalid
return self.info