From c8d26c253e7526ec1e3a0cda7d123ac6efdcc10a Mon Sep 17 00:00:00 2001
From: Bahtiar `kalkin-` Gadimov <bahtiar@gadimov.de>
Date: Sun, 22 Nov 2015 18:51:55 +0100
Subject: [PATCH] Storage refactor device config generation

- QubesVmStorage provides now a default get_config_params() method which should
  be enough for all possible Storage implementations.
- When writing a custom Storage implementation, one has just to reimplement the
  following methods:
  * root_dev_config()
  * private_dev_config()
  * volatile_dev_config()
- QubesVmStorage provides a default implementation of other_dev_config(),
  because it can be shared by all storage implementations
---
 core/storage/__init__.py | 41 ++++++++++++++++++++++++++++++++++++++++
 core/storage/xen.py      | 35 +++++++---------------------------
 2 files changed, 48 insertions(+), 28 deletions(-)

diff --git a/core/storage/__init__.py b/core/storage/__init__.py
index c5d3c4a1..b5a744aa 100644
--- a/core/storage/__init__.py
+++ b/core/storage/__init__.py
@@ -89,8 +89,49 @@ class QubesVmStorage(object):
         return template.format(path=path, vdev=vdev, type=type, params=params)
 
     def get_config_params(self):
+        args = {}
+        args['rootdev'] = self.root_dev_config()
+        args['privatedev'] = self.private_dev_config()
+        args['volatiledev'] = self.volatile_dev_config()
+        args['otherdevs'] = self.other_dev_config()
+
+        return args
+
+    def root_dev_config(self):
         raise NotImplementedError
 
+    def private_dev_config(self):
+        raise NotImplementedError
+
+    def volatile_dev_config(self):
+        raise NotImplementedError
+
+    def other_dev_config(self):
+        if self.modules_img is not None:
+            return self.format_disk_dev(self.modules_img,
+                                        None,
+                                        self.modules_dev,
+                                        self.modules_img_rw)
+        elif self.drive is not None:
+            (drive_type, drive_domain, drive_path) = self.drive.split(":")
+            if drive_type == "hd":
+                drive_type = "disk"
+
+            writable = False
+            if drive_type == "disk":
+                writable = True
+
+            if drive_domain.lower() == "dom0":
+                drive_domain = None
+
+            return self.format_disk_dev(drive_path, None,
+                                        self.modules_dev,
+                                        rw=writable,
+                                        type=drive_type,
+                                        domain=drive_domain)
+        else:
+            return ''
+
     def _copy_file(self, source, destination):
         """
         Effective file copy, preserving sparse files etc.
diff --git a/core/storage/xen.py b/core/storage/xen.py
index 51df4e3a..cdc52355 100644
--- a/core/storage/xen.py
+++ b/core/storage/xen.py
@@ -64,7 +64,7 @@ class XenStorage(QubesVmStorage):
             self.root_img = os.path.join(vmdir, 'root.img')
         self.volatile_img = os.path.join(vmdir, 'volatile.img')
 
-    def _get_rootdev(self):
+    def root_dev_config(self):
         if self.vm.is_template() and \
                 os.path.exists(os.path.join(self.vmdir, "root-cow.img")):
             return self.format_disk_dev(
@@ -92,34 +92,13 @@ class XenStorage(QubesVmStorage):
                     "{dir}/root.img".format(dir=self.vmdir),
                     None, self.root_dev, True)
 
-    def get_config_params(self):
-        args = {}
-        args['rootdev'] = self._get_rootdev()
-        args['privatedev'] = \
-                self.format_disk_dev(self.private_img,
-                        None, self.private_dev, True)
-        args['volatiledev'] = \
-                self.format_disk_dev(self.volatile_img,
-                        None, self.volatile_dev, True)
-        if self.modules_img is not None:
-            args['otherdevs'] = \
-                    self.format_disk_dev(self.modules_img,
-                            None, self.modules_dev, self.modules_img_rw)
-        elif self.drive is not None:
-            (drive_type, drive_domain, drive_path) = self.drive.split(":")
-            if drive_type == "hd":
-                drive_type = "disk"
-            if drive_domain.lower() == "dom0":
-                drive_domain = None
+    def private_dev_config(self):
+        return self.format_disk_dev(self.private_img, None,
+                                    self.private_dev, True)
 
-            args['otherdevs'] = self.format_disk_dev(drive_path, None,
-                    self.modules_dev,
-                    rw=True if drive_type == "disk" else False, type=drive_type,
-                    domain=drive_domain)
-        else:
-            args['otherdevs'] = ''
-
-        return args
+    def volatile_dev_config(self):
+        return self.format_disk_dev(self.volatile_img, None,
+                                    self.volatile_dev, True)
 
     def create_on_disk_private_img(self, verbose, source_template = None):
         if source_template: