qubes.py 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770
  1. #!/usr/bin/python2
  2. # -*- coding: utf-8 -*-
  3. #
  4. # The Qubes OS Project, http://www.qubes-os.org
  5. #
  6. # Copyright (C) 2010 Joanna Rutkowska <joanna@invisiblethingslab.com>
  7. #
  8. # This program is free software; you can redistribute it and/or
  9. # modify it under the terms of the GNU General Public License
  10. # as published by the Free Software Foundation; either version 2
  11. # of the License, or (at your option) any later version.
  12. #
  13. # This program is distributed in the hope that it will be useful,
  14. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. # GNU General Public License for more details.
  17. #
  18. # You should have received a copy of the GNU General Public License
  19. # along with this program; if not, write to the Free Software
  20. # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21. #
  22. #
  23. import sys
  24. import os
  25. import os.path
  26. import lxml.etree
  27. import xml.parsers.expat
  28. import fcntl
  29. import time
  30. import warnings
  31. import tempfile
  32. import grp
  33. # Do not use XenAPI or create/read any VM files
  34. # This is for testing only!
  35. dry_run = False
  36. #dry_run = True
  37. if not dry_run:
  38. import xen.lowlevel.xc
  39. import xen.lowlevel.xl
  40. import xen.lowlevel.xs
  41. qubes_base_dir = "/var/lib/qubes"
  42. system_path = {
  43. 'qubes_guid_path': '/usr/bin/qubes-guid',
  44. 'qrexec_daemon_path': '/usr/lib/qubes/qrexec-daemon',
  45. 'qrexec_client_path': '/usr/lib/qubes/qrexec-client',
  46. 'qubes_base_dir': qubes_base_dir,
  47. 'qubes_appvms_dir': qubes_base_dir + '/appvms',
  48. 'qubes_templates_dir': qubes_base_dir + '/vm-templates',
  49. 'qubes_servicevms_dir': qubes_base_dir + '/servicevms',
  50. 'qubes_store_filename': qubes_base_dir + '/qubes.xml',
  51. 'qubes_kernels_base_dir': qubes_base_dir + '/vm-kernels',
  52. # qubes_icon_dir is obsolete
  53. # use QIcon.fromTheme() where applicable
  54. 'qubes_icon_dir': '/usr/share/icons/hicolor/128x128/devices',
  55. 'config_template_pv': '/usr/share/qubes/vm-template.conf',
  56. 'qubes_pciback_cmd': '/usr/lib/qubes/unbind-pci-device.sh',
  57. 'prepare_volatile_img_cmd': '/usr/lib/qubes/prepare-volatile-img.sh',
  58. 'monitor_layout_notify_cmd': '/usr/bin/qubes-monitor-layout-notify',
  59. }
  60. vm_files = {
  61. 'root_img': 'root.img',
  62. 'rootcow_img': 'root-cow.img',
  63. 'volatile_img': 'volatile.img',
  64. 'clean_volatile_img': 'clean-volatile.img.tar',
  65. 'private_img': 'private.img',
  66. 'kernels_subdir': 'kernels',
  67. 'firewall_conf': 'firewall.xml',
  68. 'whitelisted_appmenus': 'whitelisted-appmenus.list',
  69. 'updates_stat_file': 'updates.stat',
  70. }
  71. defaults = {
  72. 'memory': 400,
  73. 'kernelopts': "nopat",
  74. 'kernelopts_pcidevs': "nopat iommu=soft swiotlb=4096",
  75. 'dom0_update_check_interval': 6*3600,
  76. # how long (in sec) to wait for VMs to shutdown,
  77. # before killing them (when used qvm-run with --wait option),
  78. 'shutdown_counter_max': 60,
  79. 'vm_default_netmask': "255.255.255.0",
  80. # Set later
  81. 'appvm_label': None,
  82. 'template_label': None,
  83. 'servicevm_label': None,
  84. }
  85. qubes_max_qid = 254
  86. qubes_max_netid = 254
  87. class QubesException (Exception):
  88. pass
  89. if not dry_run:
  90. xc = xen.lowlevel.xc.xc()
  91. xs = xen.lowlevel.xs.xs()
  92. xl_ctx = xen.lowlevel.xl.ctx()
  93. class QubesHost(object):
  94. def __init__(self):
  95. self.physinfo = xc.physinfo()
  96. self.xen_total_mem = long(self.physinfo['total_memory'])
  97. self.xen_no_cpus = self.physinfo['nr_cpus']
  98. # print "QubesHost: total_mem = {0}B".format (self.xen_total_mem)
  99. # print "QubesHost: free_mem = {0}".format (self.get_free_xen_memory())
  100. # print "QubesHost: total_cpus = {0}".format (self.xen_no_cpus)
  101. @property
  102. def memory_total(self):
  103. return self.xen_total_mem
  104. @property
  105. def no_cpus(self):
  106. return self.xen_no_cpus
  107. def get_free_xen_memory(self):
  108. ret = self.physinfo['free_memory']
  109. return long(ret)
  110. def measure_cpu_usage(self, previous=None, previous_time = None,
  111. wait_time=1):
  112. """measure cpu usage for all domains at once"""
  113. if previous is None:
  114. previous_time = time.time()
  115. previous = {}
  116. info = xc.domain_getinfo(0, qubes_max_qid)
  117. for vm in info:
  118. previous[vm['domid']] = {}
  119. previous[vm['domid']]['cpu_time'] = (
  120. vm['cpu_time'] / vm['online_vcpus'])
  121. previous[vm['domid']]['cpu_usage'] = 0
  122. time.sleep(wait_time)
  123. current_time = time.time()
  124. current = {}
  125. info = xc.domain_getinfo(0, qubes_max_qid)
  126. for vm in info:
  127. current[vm['domid']] = {}
  128. current[vm['domid']]['cpu_time'] = (
  129. vm['cpu_time'] / max(vm['online_vcpus'], 1))
  130. if vm['domid'] in previous.keys():
  131. current[vm['domid']]['cpu_usage'] = (
  132. float(current[vm['domid']]['cpu_time'] -
  133. previous[vm['domid']]['cpu_time']) /
  134. long(1000**3) / (current_time-previous_time) * 100)
  135. if current[vm['domid']]['cpu_usage'] < 0:
  136. # VM has been rebooted
  137. current[vm['domid']]['cpu_usage'] = 0
  138. else:
  139. current[vm['domid']]['cpu_usage'] = 0
  140. return (current_time, current)
  141. class QubesVmLabel(object):
  142. def __init__(self, index, color, name, dispvm=False):
  143. self.name = name
  144. self.index = index
  145. self.color = color
  146. self.icon = '{}-{}'.format(('dispvm' if dispvm else 'appvm'), name)
  147. # self.icon_path is obsolete
  148. # use QIcon.fromTheme(label.icon) where applicable
  149. self.icon_path = os.path.join(
  150. system_path['qubes_icon_dir'], self.icon) + ".png"
  151. # Globally defined lables
  152. QubesVmLabels = {
  153. "red": QubesVmLabel(1, "0xcc0000", "red" ),
  154. "orange": QubesVmLabel(2, "0xf57900", "orange" ),
  155. "yellow": QubesVmLabel(3, "0xedd400", "yellow" ),
  156. "green": QubesVmLabel(4, "0x73d216", "green" ),
  157. "gray": QubesVmLabel(5, "0x555753", "gray" ),
  158. "blue": QubesVmLabel(6, "0x3465a4", "blue" ),
  159. "purple": QubesVmLabel(7, "0x75507b", "purple" ),
  160. "black": QubesVmLabel(8, "0x000000", "black" ),
  161. }
  162. QubesDispVmLabels = {
  163. "red": QubesVmLabel(1, "0xcc0000", "red", dispvm=True),
  164. "orange": QubesVmLabel(2, "0xf57900", "orange", dispvm=True),
  165. "yellow": QubesVmLabel(3, "0xedd400", "yellow", dispvm=True),
  166. "green": QubesVmLabel(4, "0x73d216", "green", dispvm=True),
  167. "gray": QubesVmLabel(5, "0x555753", "gray", dispvm=True),
  168. "blue": QubesVmLabel(6, "0x3465a4", "blue", dispvm=True),
  169. "purple": QubesVmLabel(7, "0x75507b", "purple", dispvm=True),
  170. "black": QubesVmLabel(8, "0x000000", "black", dispvm=True),
  171. }
  172. defaults["appvm_label"] = QubesVmLabels["red"]
  173. defaults["template_label"] = QubesVmLabels["black"]
  174. defaults["servicevm_label"] = QubesVmLabels["red"]
  175. QubesVmClasses = {}
  176. def register_qubes_vm_class(vm_class):
  177. QubesVmClasses[vm_class.__name__] = vm_class
  178. # register class as local for this module - to make it easy to import from
  179. # other modules
  180. setattr(sys.modules[__name__], vm_class.__name__, vm_class)
  181. class QubesVmCollection(dict):
  182. """
  183. A collection of Qubes VMs indexed by Qubes id (qid)
  184. """
  185. def __init__(self, store_filename=system_path["qubes_store_filename"]):
  186. super(QubesVmCollection, self).__init__()
  187. self.default_netvm_qid = None
  188. self.default_fw_netvm_qid = None
  189. self.default_template_qid = None
  190. self.default_kernel = None
  191. self.updatevm_qid = None
  192. self.qubes_store_filename = store_filename
  193. self.clockvm_qid = None
  194. self.qubes_store_file = None
  195. def values(self):
  196. for qid in self.keys():
  197. yield self[qid]
  198. def items(self):
  199. for qid in self.keys():
  200. yield (qid, self[qid])
  201. def __iter__(self):
  202. for qid in sorted(super(QubesVmCollection, self).keys()):
  203. yield qid
  204. keys = __iter__
  205. def __setitem__(self, key, value):
  206. if key not in self:
  207. return super(QubesVmCollection, self).__setitem__(key, value)
  208. else:
  209. assert False, "Attempt to add VM with qid that already exists in the collection!"
  210. def add_new_vm(self, vm_type, **kwargs):
  211. if vm_type not in QubesVmClasses.keys():
  212. raise ValueError("Unknown VM type: %s" % vm_type)
  213. qid = self.get_new_unused_qid()
  214. vm_cls = QubesVmClasses[vm_type]
  215. if 'template' in kwargs:
  216. if not vm_cls.is_template_compatible(kwargs['template']):
  217. raise QubesException("Template not compatible with selected "
  218. "VM type")
  219. vm = vm_cls(qid=qid, collection=self, **kwargs)
  220. if not self.verify_new_vm(vm):
  221. raise QubesException("Wrong VM description!")
  222. self[vm.qid] = vm
  223. # make first created NetVM the default one
  224. if self.default_fw_netvm_qid is None and vm.is_netvm():
  225. self.set_default_fw_netvm(vm)
  226. if self.default_netvm_qid is None and vm.is_proxyvm():
  227. self.set_default_netvm(vm)
  228. # make first created TemplateVM the default one
  229. if self.default_template_qid is None and vm.is_template():
  230. self.set_default_template(vm)
  231. # make first created ProxyVM the UpdateVM
  232. if self.updatevm_qid is None and vm.is_proxyvm():
  233. self.set_updatevm_vm(vm)
  234. # by default ClockVM is the first NetVM
  235. if self.clockvm_qid is None and vm.is_netvm():
  236. self.set_clockvm_vm(vm)
  237. return vm
  238. def add_new_appvm(self, name, template,
  239. dir_path = None, conf_file = None,
  240. private_img = None,
  241. label = None):
  242. warnings.warn("Call to deprecated function, use add_new_vm instead",
  243. DeprecationWarning, stacklevel=2)
  244. return self.add_new_vm("QubesAppVm", name=name, template=template,
  245. dir_path=dir_path, conf_file=conf_file,
  246. private_img=private_img,
  247. netvm = self.get_default_netvm(),
  248. kernel = self.get_default_kernel(),
  249. uses_default_kernel = True,
  250. label=label)
  251. def add_new_hvm(self, name, label = None):
  252. warnings.warn("Call to deprecated function, use add_new_vm instead",
  253. DeprecationWarning, stacklevel=2)
  254. return self.add_new_vm("QubesHVm", name=name, label=label)
  255. def add_new_disposablevm(self, name, template, dispid,
  256. label = None, netvm = None):
  257. warnings.warn("Call to deprecated function, use add_new_vm instead",
  258. DeprecationWarning, stacklevel=2)
  259. return self.add_new_vm("QubesDisposableVm", name=name, template=template,
  260. netvm = netvm,
  261. label=label, dispid=dispid)
  262. def add_new_templatevm(self, name,
  263. dir_path = None, conf_file = None,
  264. root_img = None, private_img = None,
  265. installed_by_rpm = True):
  266. warnings.warn("Call to deprecated function, use add_new_vm instead",
  267. DeprecationWarning, stacklevel=2)
  268. return self.add_new_vm("QubesTemplateVm", name=name,
  269. dir_path=dir_path, conf_file=conf_file,
  270. root_img=root_img, private_img=private_img,
  271. installed_by_rpm=installed_by_rpm,
  272. netvm = self.get_default_netvm(),
  273. kernel = self.get_default_kernel(),
  274. uses_default_kernel = True)
  275. def add_new_netvm(self, name, template,
  276. dir_path = None, conf_file = None,
  277. private_img = None, installed_by_rpm = False,
  278. label = None):
  279. warnings.warn("Call to deprecated function, use add_new_vm instead",
  280. DeprecationWarning, stacklevel=2)
  281. return self.add_new_vm("QubesNetVm", name=name, template=template,
  282. label=label,
  283. private_img=private_img, installed_by_rpm=installed_by_rpm,
  284. uses_default_kernel = True,
  285. dir_path=dir_path, conf_file=conf_file)
  286. def add_new_proxyvm(self, name, template,
  287. dir_path = None, conf_file = None,
  288. private_img = None, installed_by_rpm = False,
  289. label = None):
  290. warnings.warn("Call to deprecated function, use add_new_vm instead",
  291. DeprecationWarning, stacklevel=2)
  292. return self.add_new_vm("QubesProxyVm", name=name, template=template,
  293. label=label,
  294. private_img=private_img, installed_by_rpm=installed_by_rpm,
  295. dir_path=dir_path, conf_file=conf_file,
  296. uses_default_kernel = True,
  297. netvm = self.get_default_fw_netvm())
  298. def set_default_template(self, vm):
  299. if vm is None:
  300. self.default_template_qid = None
  301. else:
  302. assert vm.is_template(), "VM {0} is not a TemplateVM!".format(vm.name)
  303. self.default_template_qid = vm.qid
  304. def get_default_template(self):
  305. if self.default_template_qid is None:
  306. return None
  307. else:
  308. return self[self.default_template_qid]
  309. def set_default_netvm(self, vm):
  310. if vm is None:
  311. self.default_netvm_qid = None
  312. else:
  313. assert vm.is_netvm(), "VM {0} does not provide network!".format(vm.name)
  314. self.default_netvm_qid = vm.qid
  315. def get_default_netvm(self):
  316. if self.default_netvm_qid is None:
  317. return None
  318. else:
  319. return self[self.default_netvm_qid]
  320. def set_default_kernel(self, kernel):
  321. assert os.path.exists(
  322. os.path.join(system_path["qubes_kernels_base_dir"], kernel)), \
  323. "Kerel {0} not installed!".format(kernel)
  324. self.default_kernel = kernel
  325. def get_default_kernel(self):
  326. return self.default_kernel
  327. def set_default_fw_netvm(self, vm):
  328. if vm is None:
  329. self.default_fw_netvm_qid = None
  330. else:
  331. assert vm.is_netvm(), "VM {0} does not provide network!".format(vm.name)
  332. self.default_fw_netvm_qid = vm.qid
  333. def get_default_fw_netvm(self):
  334. if self.default_fw_netvm_qid is None:
  335. return None
  336. else:
  337. return self[self.default_fw_netvm_qid]
  338. def set_updatevm_vm(self, vm):
  339. if vm is None:
  340. self.updatevm_qid = None
  341. else:
  342. self.updatevm_qid = vm.qid
  343. def get_updatevm_vm(self):
  344. if self.updatevm_qid is None:
  345. return None
  346. else:
  347. return self[self.updatevm_qid]
  348. def set_clockvm_vm(self, vm):
  349. if vm is None:
  350. self.clockvm_qid = None
  351. else:
  352. self.clockvm_qid = vm.qid
  353. def get_clockvm_vm(self):
  354. if self.clockvm_qid is None:
  355. return None
  356. else:
  357. return self[self.clockvm_qid]
  358. def get_vm_by_name(self, name):
  359. for vm in self.values():
  360. if (vm.name == name):
  361. return vm
  362. return None
  363. def get_qid_by_name(self, name):
  364. vm = self.get_vm_by_name(name)
  365. return vm.qid if vm is not None else None
  366. def get_vms_based_on(self, template_qid):
  367. vms = set([vm for vm in self.values()
  368. if (vm.template and vm.template.qid == template_qid)])
  369. return vms
  370. def get_vms_connected_to(self, netvm_qid):
  371. new_vms = [ netvm_qid ]
  372. dependend_vms_qid = []
  373. # Dependency resolving only makes sense on NetVM (or derivative)
  374. if not self[netvm_qid].is_netvm():
  375. return set([])
  376. while len(new_vms) > 0:
  377. cur_vm = new_vms.pop()
  378. for vm in self[cur_vm].connected_vms.values():
  379. if vm.qid not in dependend_vms_qid:
  380. dependend_vms_qid.append(vm.qid)
  381. if vm.is_netvm():
  382. new_vms.append(vm.qid)
  383. vms = [vm for vm in self.values() if vm.qid in dependend_vms_qid]
  384. return vms
  385. def verify_new_vm(self, new_vm):
  386. # Verify that qid is unique
  387. for vm in self.values():
  388. if vm.qid == new_vm.qid:
  389. print >> sys.stderr, "ERROR: The qid={0} is already used by VM '{1}'!".\
  390. format(vm.qid, vm.name)
  391. return False
  392. # Verify that name is unique
  393. for vm in self.values():
  394. if vm.name == new_vm.name:
  395. print >> sys.stderr, \
  396. "ERROR: The name={0} is already used by other VM with qid='{1}'!".\
  397. format(vm.name, vm.qid)
  398. return False
  399. return True
  400. def get_new_unused_qid(self):
  401. used_ids = set([vm.qid for vm in self.values()])
  402. for id in range (1, qubes_max_qid):
  403. if id not in used_ids:
  404. return id
  405. raise LookupError ("Cannot find unused qid!")
  406. def get_new_unused_netid(self):
  407. used_ids = set([vm.netid for vm in self.values() if vm.is_netvm()])
  408. for id in range (1, qubes_max_netid):
  409. if id not in used_ids:
  410. return id
  411. raise LookupError ("Cannot find unused netid!")
  412. def check_if_storage_exists(self):
  413. try:
  414. f = open (self.qubes_store_filename, 'r')
  415. except IOError:
  416. return False
  417. f.close()
  418. return True
  419. def create_empty_storage(self):
  420. self.qubes_store_file = open (self.qubes_store_filename, 'w')
  421. self.clear()
  422. self.save()
  423. def lock_db_for_reading(self):
  424. self.qubes_store_file = open (self.qubes_store_filename, 'r')
  425. fcntl.lockf (self.qubes_store_file, fcntl.LOCK_SH)
  426. def lock_db_for_writing(self):
  427. self.qubes_store_file = open (self.qubes_store_filename, 'r+')
  428. fcntl.lockf (self.qubes_store_file, fcntl.LOCK_EX)
  429. def unlock_db(self):
  430. # intentionally do not call explicit unlock to not unlock the file
  431. # before all buffers are flushed
  432. self.qubes_store_file.close()
  433. def save(self):
  434. root = lxml.etree.Element(
  435. "QubesVmCollection",
  436. default_template=str(self.default_template_qid) \
  437. if self.default_template_qid is not None else "None",
  438. default_netvm=str(self.default_netvm_qid) \
  439. if self.default_netvm_qid is not None else "None",
  440. default_fw_netvm=str(self.default_fw_netvm_qid) \
  441. if self.default_fw_netvm_qid is not None else "None",
  442. updatevm=str(self.updatevm_qid) \
  443. if self.updatevm_qid is not None else "None",
  444. clockvm=str(self.clockvm_qid) \
  445. if self.clockvm_qid is not None else "None",
  446. default_kernel=str(self.default_kernel) \
  447. if self.default_kernel is not None else "None",
  448. )
  449. for vm in self.values():
  450. element = vm.create_xml_element()
  451. if element is not None:
  452. root.append(element)
  453. tree = lxml.etree.ElementTree(root)
  454. try:
  455. new_store_file = tempfile.NamedTemporaryFile(prefix=self.qubes_store_filename, delete=False)
  456. # XXX: do not get lock on the new file, as in all use cases
  457. # unlock_db() is the next operation after save()
  458. tree.write(new_store_file, encoding="UTF-8", pretty_print=True)
  459. new_store_file.flush()
  460. os.chmod(new_store_file.name, 0660)
  461. os.chown(new_store_file.name, -1, grp.getgrnam('qubes').gr_gid)
  462. os.rename(new_store_file.name, self.qubes_store_filename)
  463. self.qubes_store_file.close()
  464. self.qubes_store_file = new_store_file
  465. except EnvironmentError as err:
  466. print("{0}: export error: {1}".format(
  467. os.path.basename(sys.argv[0]), err))
  468. return False
  469. return True
  470. def set_netvm_dependency(self, element):
  471. kwargs = {}
  472. attr_list = ("qid", "uses_default_netvm", "netvm_qid")
  473. for attribute in attr_list:
  474. kwargs[attribute] = element.get(attribute)
  475. vm = self[int(kwargs["qid"])]
  476. if "uses_default_netvm" not in kwargs:
  477. vm.uses_default_netvm = True
  478. else:
  479. vm.uses_default_netvm = (
  480. True if kwargs["uses_default_netvm"] == "True" else False)
  481. if vm.uses_default_netvm is True:
  482. if vm.is_proxyvm():
  483. netvm = self.get_default_fw_netvm()
  484. else:
  485. netvm = self.get_default_netvm()
  486. kwargs.pop("netvm_qid")
  487. else:
  488. if kwargs["netvm_qid"] == "none" or kwargs["netvm_qid"] is None:
  489. netvm = None
  490. kwargs.pop("netvm_qid")
  491. else:
  492. netvm_qid = int(kwargs.pop("netvm_qid"))
  493. if netvm_qid not in self:
  494. netvm = None
  495. else:
  496. netvm = self[netvm_qid]
  497. # directly set internal attr to not call setters...
  498. vm._netvm = netvm
  499. if netvm:
  500. netvm.connected_vms[vm.qid] = vm
  501. def load_globals(self, element):
  502. default_template = element.get("default_template")
  503. self.default_template_qid = int(default_template) \
  504. if default_template.lower() != "none" else None
  505. default_netvm = element.get("default_netvm")
  506. if default_netvm is not None:
  507. self.default_netvm_qid = int(default_netvm) \
  508. if default_netvm != "None" else None
  509. #assert self.default_netvm_qid is not None
  510. default_fw_netvm = element.get("default_fw_netvm")
  511. if default_fw_netvm is not None:
  512. self.default_fw_netvm_qid = int(default_fw_netvm) \
  513. if default_fw_netvm != "None" else None
  514. #assert self.default_netvm_qid is not None
  515. updatevm = element.get("updatevm")
  516. if updatevm is not None:
  517. self.updatevm_qid = int(updatevm) \
  518. if updatevm != "None" else None
  519. #assert self.default_netvm_qid is not None
  520. clockvm = element.get("clockvm")
  521. if clockvm is not None:
  522. self.clockvm_qid = int(clockvm) \
  523. if clockvm != "None" else None
  524. self.default_kernel = element.get("default_kernel")
  525. def load(self):
  526. self.clear()
  527. try:
  528. tree = lxml.etree.parse(self.qubes_store_file)
  529. except (EnvironmentError,
  530. xml.parsers.expat.ExpatError) as err:
  531. print("{0}: import error: {1}".format(
  532. os.path.basename(sys.argv[0]), err))
  533. return False
  534. self.load_globals(tree.getroot())
  535. for (vm_class_name, vm_class) in sorted(QubesVmClasses.items(),
  536. key=lambda _x: _x[1].load_order):
  537. vms_of_class = tree.findall(vm_class_name)
  538. # first non-template based, then template based
  539. sorted_vms_of_class = sorted(vms_of_class, key= \
  540. lambda x: str(x.get('template_qid')).lower() != "none")
  541. for element in sorted_vms_of_class:
  542. try:
  543. vm = vm_class(xml_element=element, collection=self)
  544. self[vm.qid] = vm
  545. except (ValueError, LookupError) as err:
  546. print("{0}: import error ({1}): {2}".format(
  547. os.path.basename(sys.argv[0]), vm_class_name, err))
  548. raise
  549. return False
  550. # After importing all VMs, set netvm references, in the same order
  551. for (vm_class_name, vm_class) in sorted(QubesVmClasses.items(),
  552. key=lambda _x: _x[1].load_order):
  553. for element in tree.findall(vm_class_name):
  554. try:
  555. self.set_netvm_dependency(element)
  556. except (ValueError, LookupError) as err:
  557. print("{0}: import error2 ({}): {}".format(
  558. os.path.basename(sys.argv[0]), vm_class_name, err))
  559. return False
  560. # if there was no clockvm entry in qubes.xml, try to determine default:
  561. # root of default NetVM chain
  562. if tree.getroot().get("clockvm") is None:
  563. if self.default_netvm_qid is not None:
  564. clockvm = self[self.default_netvm_qid]
  565. # Find root of netvm chain
  566. while clockvm.netvm is not None:
  567. clockvm = clockvm.netvm
  568. self.clockvm_qid = clockvm.qid
  569. # Disable ntpd in ClockVM - to not conflict with ntpdate (both are
  570. # using 123/udp port)
  571. if self.clockvm_qid is not None:
  572. self[self.clockvm_qid].services['ntpd'] = False
  573. # Add dom0 if wasn't present in qubes.xml
  574. if not 0 in self.keys():
  575. dom0vm = QubesAdminVm (collection=self)
  576. self[dom0vm.qid] = dom0vm
  577. return True
  578. def pop(self, qid):
  579. if self.default_netvm_qid == qid:
  580. self.default_netvm_qid = None
  581. if self.default_fw_netvm_qid == qid:
  582. self.default_fw_netvm_qid = None
  583. if self.clockvm_qid == qid:
  584. self.clockvm_qid = None
  585. if self.updatevm_qid == qid:
  586. self.updatevm_qid = None
  587. if self.default_template_qid == qid:
  588. self.default_template_qid = None
  589. return super(QubesVmCollection, self).pop(qid)
  590. class QubesDaemonPidfile(object):
  591. def __init__(self, name):
  592. self.name = name
  593. self.path = "/var/run/qubes/" + name + ".pid"
  594. def create_pidfile(self):
  595. f = open (self.path, 'w')
  596. f.write(str(os.getpid()))
  597. f.close()
  598. def pidfile_exists(self):
  599. return os.path.exists(self.path)
  600. def read_pid(self):
  601. f = open (self.path)
  602. pid = f.read ().strip()
  603. f.close()
  604. return int(pid)
  605. def pidfile_is_stale(self):
  606. if not self.pidfile_exists():
  607. return False
  608. # check if the pid file is valid...
  609. proc_path = "/proc/" + str(self.read_pid()) + "/cmdline"
  610. if not os.path.exists (proc_path):
  611. print >> sys.stderr, \
  612. "Path {0} doesn't exist, assuming stale pidfile.".\
  613. format(proc_path)
  614. return True
  615. return False # It's a good pidfile
  616. def remove_pidfile(self):
  617. os.remove (self.path)
  618. def __enter__ (self):
  619. # assumes the pidfile doesn't exist -- you should ensure it before opening the context
  620. self.create_pidfile()
  621. def __exit__ (self, exc_type, exc_val, exc_tb):
  622. self.remove_pidfile()
  623. return False
  624. modules_dir = os.path.join(os.path.dirname(__file__), 'modules')
  625. for module_file in sorted(os.listdir(modules_dir)):
  626. if not module_file.endswith(".py") or module_file == "__init__.py":
  627. continue
  628. __import__('qubes.modules.%s' % module_file[:-3])
  629. # vim:sw=4:et: