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
|
# Copyright (C) 2010, 2013 Red Hat, Inc.
# Copyright (C) 2010 Cole Robinson <crobinso@redhat.com>
#
# This work is licensed under the GNU GPLv2 or later.
# See the COPYING file in the top-level directory.
import logging
from .baseclass import vmmGObject
class vmmLibvirtObject(vmmGObject):
__gsignals__ = {
"state-changed": (vmmGObject.RUN_FIRST, None, []),
"initialized": (vmmGObject.RUN_FIRST, None, [bool]),
}
_STATUS_ACTIVE = 1
_STATUS_INACTIVE = 2
def __init__(self, conn, backend, key, parseclass):
vmmGObject.__init__(self)
self._conn = conn
self._backend = backend
self._key = key
self._parseclass = parseclass
self.__initialized = False
self.__status = None
self._support_isactive = None
self._xmlobj = None
self._xmlobj_to_define = None
self._is_xml_valid = False
# These should be set by the child classes if necessary
self._inactive_xml_flags = 0
self._active_xml_flags = 0
# Cache object name. We may need to do this even
# before init_libvirt_state since it might be needed ahead of time.
self._name = None
self.get_name()
@staticmethod
def log_redefine_xml_diff(obj, origxml, newxml):
if origxml == newxml:
logging.debug("Redefine requested for %s, but XML didn't change!",
obj)
return
import difflib
diff = "".join(difflib.unified_diff(origxml.splitlines(1),
newxml.splitlines(1),
fromfile="Original XML",
tofile="New XML"))
logging.debug("Redefining %s with XML diff:\n%s", obj, diff)
@staticmethod
def lifecycle_action(fn):
"""
Decorator for object lifecycle actions like start, stop, delete.
Will make sure any necessary state is updated accordingly.
"""
def newfn(self, *args, **kwargs):
ret = fn(self, *args, **kwargs)
# If events are supported, this is a no-op, but the event loop
# will trigger force_status_update, which will refresh_xml as well.
#
# If events aren't supported, the priority tick will call
# self.tick(), which will call force_status_update
poll_param = self._conn_tick_poll_param() # pylint: disable=protected-access
tick_kwargs = {poll_param: True}
self.conn.schedule_priority_tick(**tick_kwargs)
return ret
return newfn
def __repr__(self):
try:
name = self.get_name()
except Exception:
name = ""
return "<%s name=%s id=%s>" % (
self.__class__.__name__, name, hex(id(self)))
def _cleanup(self):
self._backend = None
def _get_conn(self):
return self._conn
conn = property(_get_conn)
def get_backend(self):
return self._backend
def get_connkey(self):
return self._key
def is_domain(self):
return self.class_name() == "domain"
def is_network(self):
return self.class_name() == "network"
def is_pool(self):
return self.class_name() == "pool"
def is_nodedev(self):
return self.class_name() == "nodedev"
def is_interface(self):
return self.class_name() == "interface"
def change_name_backend(self, newbackend):
# Used for changing the backing object after a rename
self._backend = newbackend
def define_name(self, newname):
oldconnkey = self.get_connkey()
oldname = self.get_xmlobj().name
self.ensure_latest_xml()
xmlobj = self._make_xmlobj_to_define()
if xmlobj.name == newname:
return
logging.debug("Changing %s name from %s to %s",
self, oldname, newname)
origxml = xmlobj.get_xml()
xmlobj.name = newname
newxml = xmlobj.get_xml()
try:
self._key = newname
self.conn.rename_object(self, origxml, newxml, oldconnkey)
except Exception:
self._key = oldname
raise
finally:
self.__force_refresh_xml()
#############################################################
# Functions that should probably be overridden in sub class #
#############################################################
def _XMLDesc(self, flags):
raise NotImplementedError()
def class_name(self):
raise NotImplementedError()
def _conn_tick_poll_param(self):
# The parameter name for conn.tick() object polling. So
# for vmmDomain == "pollvm"
raise NotImplementedError()
def reports_stats(self):
return False
def _using_events(self):
return False
def _check_supports_isactive(self):
return False
def _get_backend_status(self):
raise NotImplementedError()
def _define(self, xml):
ignore = xml
return
def delete(self, force=True):
ignore = force
def get_name(self):
if self._name is None:
self._name = self._backend_get_name()
return self._name
def _backend_get_name(self):
return self._backend.name()
def tick(self, stats_update=True):
raise NotImplementedError()
def _init_libvirt_state(self):
raise NotImplementedError()
def init_libvirt_state(self):
"""
Function called by vmmConnection to populate initial state when
a new object appears.
"""
if self.__initialized:
return
initialize_failed = False
try:
self._init_libvirt_state()
except Exception:
logging.debug("Error initializing libvirt state for %s", self,
exc_info=True)
initialize_failed = True
self.__initialized = True
self.idle_emit("initialized", initialize_failed)
###################
# Status handling #
###################
def _get_status(self):
return self.__status
def is_active(self):
# vmmDomain overwrites this since it has more fine grained statuses
return self._get_status() == self._STATUS_ACTIVE
def run_status(self):
if self.is_active():
return _("Active")
return _("Inactive")
def _refresh_status(self, newstatus=None, cansignal=True):
"""
Grab the object status/active state from libvirt, and if the
status has changed, update the XML cache. Typically called from
object tick functions for manually updating the object state.
:param newstatus: Used by vmmDomain as a small optimization to
avoid polling info() twice
:param cansignal: If True, this function will signal state-changed
if required.
:returns: True if status changed, false otherwise
"""
if (self._using_events() and
self.__status is not None):
return False
if newstatus is None:
newstatus = self._get_backend_status()
status = newstatus
if status == self.__status:
return False
self.__status = status
self.ensure_latest_xml(nosignal=True)
if cansignal:
self.idle_emit("state-changed")
return True
def _backend_get_active(self):
if self._support_isactive is None:
self._support_isactive = self._check_supports_isactive()
if not self._support_isactive:
return self._STATUS_ACTIVE
return (bool(self._backend.isActive()) and
self._STATUS_ACTIVE or
self._STATUS_INACTIVE)
##################
# Public XML API #
##################
def recache_from_event_loop(self):
"""
Updates the VM status and XML, because we received an event from
libvirt's event implementations. That's the only time this should
be used.
We refresh status and XML because they are tied together in subtle
ways, like runtime XML changing when a VM is started.
"""
try:
self.__force_refresh_xml(nosignal=True)
# status = None forces a signal to be emitted
self.__status = None
self._refresh_status()
except Exception as e:
# If we hit an exception here, it's often that the object
# disappeared, so request the poll loop to be updated
logging.debug("Error refreshing %s from events: %s", self, e)
poll_param = self._conn_tick_poll_param()
if poll_param:
kwargs = {"force": True, poll_param: True}
logging.debug("Scheduling priority tick with: %s", kwargs)
self.conn.schedule_priority_tick(**kwargs)
def ensure_latest_xml(self, nosignal=False):
"""
Refresh XML if it isn't up to date, basically if we aren't using
events.
"""
if (self._using_events() and
self._xmlobj and
self._is_xml_valid):
return
self.__force_refresh_xml(nosignal=nosignal)
def __force_refresh_xml(self, nosignal=False):
"""
Force an xml update. Signal 'state-changed' if domain xml has
changed since last refresh
:param nosignal: If true, don't send state-changed. Used by
callers that are going to send it anyways.
"""
origxml = None
if self._xmlobj:
origxml = self._xmlobj.get_xml()
self._invalidate_xml()
active_xml = self._XMLDesc(self._active_xml_flags)
self._xmlobj = self._parseclass(self.conn.get_backend(),
parsexml=active_xml)
self._is_xml_valid = True
if not nosignal and origxml != active_xml:
self.idle_emit("state-changed")
def get_xmlobj(self, inactive=False, refresh_if_nec=True):
"""
Get object xml, return it wrapped in a virtinst object.
If cached xml is invalid, update.
:param inactive: Return persistent XML, not the running config.
No effect if domain is not running. Use this flag
if the XML will be used for redefining a guest
:param refresh_if_nec: Check if XML is out of date, and if so,
refresh it (default behavior). Skipping a refresh is
useful to prevent updating xml in the tick loop when
it's not that important (disk/net stats)
"""
if inactive:
# If inactive XML requested, always return a fresh object even if
# the current object is inactive XML (like when the domain is
# stopped). Callers that request inactive are basically expecting
# a new copy.
inactive_xml = self._XMLDesc(self._inactive_xml_flags)
return self._parseclass(self.conn.get_backend(),
parsexml=inactive_xml)
if (self._xmlobj is None or
(refresh_if_nec and not self._is_xml_valid)):
self.ensure_latest_xml()
return self._xmlobj
@property
def xmlobj(self):
return self.get_xmlobj()
def get_xml_to_define(self):
"""
Return the raw inactive XML we would use to alter/define an
object. Used by the xmleditor UI
"""
return self._make_xmlobj_to_define().get_xml()
def define_xml(self, xml):
"""
Define the passed in XML, and log a diff against the current XML.
Generally subclasses should use _redefine_xmlobj with higher
level wrappers, but this is needed for the XML editor
"""
origxml = self.get_xml_to_define()
newxml = xml
self._redefine_xml_internal(origxml, newxml)
#########################
# Internal XML routines #
#########################
def _invalidate_xml(self):
"""
Mark cached XML as invalid. Subclasses may extend this
to invalidate any specific caches of their own
"""
self._name = None
# While for events we do want to clear cached XML values like
# _name, the XML is never invalid.
self._is_xml_valid = self._using_events()
def _make_xmlobj_to_define(self):
"""
Build an xmlobj that should be used for defining new XML.
Most subclasses shouldn't touch this, but vmmDomainVirtinst needs to.
"""
return self.get_xmlobj(inactive=True)
def _redefine_xml_internal(self, origxml, newxml):
self.log_redefine_xml_diff(self, origxml, newxml)
if origxml != newxml:
self._define(newxml)
if self._using_events():
return
# Make sure we have latest XML.
self.ensure_latest_xml(nosignal=True)
# We force a signal even if XML didn't change, so the details
# window is correctly refreshed.
self.idle_emit("state-changed")
def _redefine_xmlobj(self, xmlobj):
"""
Redefine the passed xmlobj, which should be generated with
self._make_xmlobj_to_define() and which has accumulated edits
from UI fields.
Most subclasses shouldn't alter this, but vmmDomainVirtinst needs to.
"""
origxml = self._make_xmlobj_to_define().get_xml()
newxml = xmlobj.get_xml()
self._redefine_xml_internal(origxml, newxml)
|