refactor(constants.py): move VG_LOCATION, VG_PREFIX and NS_PREFIX_LVM

Signed-off-by: Ronan Abhamon <ronan.abhamon@vates.fr>

Author: Wescoeur

drivers/LVMSR.py

@@ -41,6 +41,7 @@
 from journaler import Journaler
 from refcounter import RefCounter
 from ipc import IPCFlag
+from constants import NS_PREFIX_LVM, VG_LOCATION, VG_PREFIX
 from lvmanager import LVActivator
 from vditype import VdiType
 import XenAPI # pylint: disable=import-error
@@ -55,7 +56,7 @@
 import glob
 from constants import CBTLOG_TAG
 from fairlock import Fairlock
-DEV_MAPPER_ROOT = os.path.join('/dev/mapper', lvhdutil.VG_PREFIX)
+DEV_MAPPER_ROOT = os.path.join('/dev/mapper', VG_PREFIX)
 
 geneology: Dict[str, List[str]] = {}
 CAPABILITIES = ["SR_PROBE", "SR_UPDATE", "SR_TRIM",
@@ -162,8 +163,8 @@ def load(self, sr_uuid) -> None:
         self.lock = lock.Lock(lock.LOCK_TYPE_SR, self.uuid)
         self.sr_vditype = SR.DEFAULT_TAP
         self.uuid = sr_uuid
-        self.vgname = lvhdutil.VG_PREFIX + self.uuid
-        self.path = os.path.join(lvhdutil.VG_LOCATION, self.vgname)
+        self.vgname = VG_PREFIX + self.uuid
+        self.path = os.path.join(VG_LOCATION, self.vgname)
         self.mdpath = os.path.join(self.path, self.MDVOLUME_NAME)
         self.provision = self.PROVISIONING_DEFAULT
 
@@ -860,8 +861,8 @@ def _updateStats(self, uuid, virtAllocDelta):
     @deviceCheck
     def probe(self) -> str:
         return lvutil.srlist_toxml(
-                lvutil.scan_srlist(lvhdutil.VG_PREFIX, self.dconf['device']),
-                lvhdutil.VG_PREFIX,
+                lvutil.scan_srlist(VG_PREFIX, self.dconf['device']),
+                VG_PREFIX,
                 ('metadata' in self.srcmd.params['sr_sm_config'] and \
                  self.srcmd.params['sr_sm_config']['metadata'] == 'true'))
 
@@ -990,7 +991,7 @@ def _undoCloneOp(self, lvs, origUuid, baseUuid, clonUuid):
         if base.readonly:
             self.lvmCache.setReadonly(base.name, False)
 
-        ns = lvhdutil.NS_PREFIX_LVM + self.uuid
+        ns = NS_PREFIX_LVM + self.uuid
         origRefcountBinary = RefCounter.check(origUuid, ns)[1]
         origRefcountNormal = 0
 
@@ -1248,7 +1249,7 @@ def _updateSlavesOnClone(self, hostRefs, origOldLV, origLV,
                 "action1": "refresh",
                 "lvName1": origLV,
                 "action2": "activate",
-                "ns2": lvhdutil.NS_PREFIX_LVM + self.uuid,
+                "ns2": NS_PREFIX_LVM + self.uuid,
                 "lvName2": baseLV,
                 "uuid2": baseUuid}
 
@@ -1288,7 +1289,7 @@ def _updateSlavesOnRemove(self, hostRefs, baseUuid, baseLV):
         args = {"vgName": self.vgname,
                 "action1": "cleanupLockAndRefcount",
                 "uuid1": baseUuid,
-                "ns1": lvhdutil.NS_PREFIX_LVM + self.uuid}
+                "ns1": NS_PREFIX_LVM + self.uuid}
 
         masterRef = util.get_this_host_ref(self.session)
         for hostRef in hostRefs:
@@ -1303,11 +1304,11 @@ def _updateSlavesOnRemove(self, hostRefs, baseUuid, baseLV):
 
     def _cleanup(self, skipLockCleanup=False):
         """delete stale refcounter, flag, and lock files"""
-        RefCounter.resetAll(lvhdutil.NS_PREFIX_LVM + self.uuid)
+        RefCounter.resetAll(NS_PREFIX_LVM + self.uuid)
         IPCFlag(self.uuid).clearAll()
         if not skipLockCleanup:
             lock.Lock.cleanupAll(self.uuid)
-            lock.Lock.cleanupAll(lvhdutil.NS_PREFIX_LVM + self.uuid)
+            lock.Lock.cleanupAll(NS_PREFIX_LVM + self.uuid)
 
     def _prepareTestMode(self):
         util.SMlog("Test mode: %s" % self.testMode)
@@ -1469,7 +1470,7 @@ def delete(self, sr_uuid, vdi_uuid, data_only=False) -> None:
 
         try:
             self.sr.lvmCache.remove(self.lvname)
-            self.sr.lock.cleanup(vdi_uuid, lvhdutil.NS_PREFIX_LVM + sr_uuid)
+            self.sr.lock.cleanup(vdi_uuid, NS_PREFIX_LVM + sr_uuid)
             self.sr.lock.cleanupAll(vdi_uuid)
         except xs_errors.SRException as e:
             util.SMlog(
@@ -1786,7 +1787,7 @@ def _snapshot(self, snapType, cloneOp=False, cbtlog=None, cbt_consistency=None):
             baseLV = lvhdutil.LV_PREFIX[self.vdi_type] + baseUuid
             self.sr.lvmCache.rename(self.lvname, baseLV)
             self.sr.lvActivator.replace(self.uuid, baseUuid, baseLV, False)
-            RefCounter.set(baseUuid, 1, 0, lvhdutil.NS_PREFIX_LVM + self.sr.uuid)
+            RefCounter.set(baseUuid, 1, 0, NS_PREFIX_LVM + self.sr.uuid)
             self.uuid = baseUuid
             self.lvname = baseLV
             self.path = os.path.join(self.sr.path, baseLV)
@@ -1861,7 +1862,7 @@ def _createSnap(self, snapUuid, snapSizeLV, isNew):
         self.sr.lvmCache.create(snapLV, int(snapSizeLV))
         util.fistpoint.activate("LVHDRT_clone_vdi_after_lvcreate", self.sr.uuid)
         if isNew:
-            RefCounter.set(snapUuid, 1, 0, lvhdutil.NS_PREFIX_LVM + self.sr.uuid)
+            RefCounter.set(snapUuid, 1, 0, NS_PREFIX_LVM + self.sr.uuid)
         self.sr.lvActivator.add(snapUuid, snapLV, False)
         parentRaw = (self.vdi_type == VdiType.RAW)
         vhdutil.snapshot(snapPath, self.path, parentRaw, lvhdutil.MSIZE_MB)
@@ -1898,7 +1899,7 @@ def _finishSnapshot(self, snapVDI, snapVDI2, hostRefs, cloneOp=False, snapType=N
                 (not snapVDI2 or snap2Parent != self.uuid):
             util.SMlog("%s != %s != %s => deleting unused base %s" % \
                     (snapParent, self.uuid, snap2Parent, self.lvname))
-            RefCounter.put(self.uuid, False, lvhdutil.NS_PREFIX_LVM + self.sr.uuid)
+            RefCounter.put(self.uuid, False, NS_PREFIX_LVM + self.sr.uuid)
             self.sr.lvmCache.remove(self.lvname)
             self.sr.lvActivator.remove(self.uuid, False)
             if hostRefs:
@@ -1921,7 +1922,7 @@ def _finishSnapshot(self, snapVDI, snapVDI2, hostRefs, cloneOp=False, snapType=N
             # cannot affect the VDIs here because they cannot  possibly be
             # involved in coalescing at this point, and at the relinkSkip step
             # that activates the children, which takes the SR lock.)
-            ns = lvhdutil.NS_PREFIX_LVM + self.sr.uuid
+            ns = NS_PREFIX_LVM + self.sr.uuid
             (cnt, bcnt) = RefCounter.check(snapVDI.uuid, ns)
             RefCounter.set(self.uuid, bcnt + 1, 0, ns)
 
@@ -2128,7 +2129,7 @@ def _loadThis(self):
     def _chainSetActive(self, active, binary, persistent=False):
         if binary:
             (count, bcount) = RefCounter.checkLocked(self.uuid,
-                lvhdutil.NS_PREFIX_LVM + self.sr.uuid)
+                NS_PREFIX_LVM + self.sr.uuid)
             if (active and bcount > 0) or (not active and bcount == 0):
                 return  # this is a redundant activation/deactivation call
 

drivers/blktap2.py

@@ -41,6 +41,7 @@
 import xs_errors
 import XenAPI # pylint: disable=import-error
 import scsiutil
+from constants import NS_PREFIX_LVM
 from syslog import openlog, syslog
 from stat import *  # S_ISBLK(), ...
 from vditype import VdiType
@@ -1672,7 +1673,7 @@ def _activate_locked(self, sr_uuid, vdi_uuid, options):
             if hasattr(self.target.vdi.sr, 'DRIVER_TYPE') and \
                self.target.vdi.sr.DRIVER_TYPE == 'lvhd' and \
                VdiType.isCowImage(vdi_type):
-                lock = Lock("lvchange-p", lvhdutil.NS_PREFIX_LVM + sr_uuid)
+                lock = Lock("lvchange-p", NS_PREFIX_LVM + sr_uuid)
                 lock.acquire()
 
             # When we attach a static VDI for HA, we cannot communicate with

drivers/cleanup.py

@@ -53,6 +53,8 @@
 from time import monotonic as _time
 from vditype import VdiType, VdiTypeExtension, VDI_TYPE_TO_EXTENSION
 
+from constants import NS_PREFIX_LVM, VG_LOCATION, VG_PREFIX
+
 try:
     from linstorjournaler import LinstorJournaler
     from linstorvhdutil import LinstorVhdUtil
@@ -782,7 +784,7 @@ def rename(self, uuid) -> None:
 
     def delete(self) -> None:
         "Physically delete the VDI"
-        lock.Lock.cleanup(self.uuid, lvhdutil.NS_PREFIX_LVM + self.sr.uuid)
+        lock.Lock.cleanup(self.uuid, NS_PREFIX_LVM + self.sr.uuid)
         lock.Lock.cleanupAll(self.uuid)
         self._clear()
 
@@ -1317,7 +1319,7 @@ def rename(self, uuid) -> None:
         if self.sr.lvActivator.get(oldUuid, False):
             self.sr.lvActivator.replace(oldUuid, self.uuid, self.fileName, False)
 
-        ns = lvhdutil.NS_PREFIX_LVM + self.sr.uuid
+        ns = NS_PREFIX_LVM + self.sr.uuid
         (cnt, bcnt) = RefCounter.check(oldUuid, ns)
         RefCounter.set(self.uuid, cnt, bcnt, ns)
         RefCounter.reset(oldUuid, ns)
@@ -1333,7 +1335,7 @@ def delete(self) -> None:
             self.sr.forgetVDI(self.uuid)
         finally:
             self.sr.unlock()
-        RefCounter.reset(self.uuid, lvhdutil.NS_PREFIX_LVM + self.sr.uuid)
+        RefCounter.reset(self.uuid, NS_PREFIX_LVM + self.sr.uuid)
         VDI.delete(self)
 
     @override
@@ -3043,8 +3045,8 @@ class LVMSR(SR):
 
     def __init__(self, uuid, xapi, createLock, force):
         SR.__init__(self, uuid, xapi, createLock, force)
-        self.vgName = "%s%s" % (lvhdutil.VG_PREFIX, self.uuid)
-        self.path = os.path.join(lvhdutil.VG_LOCATION, self.vgName)
+        self.vgName = "%s%s" % (VG_PREFIX, self.uuid)
+        self.path = os.path.join(VG_LOCATION, self.vgName)
 
         sr_ref = self.xapi.session.xenapi.SR.get_by_uuid(self.uuid)
         other_conf = self.xapi.session.xenapi.SR.get_other_config(sr_ref)
@@ -3170,7 +3172,7 @@ def _updateNode(self, vdi) -> None:
         # this node is really the parent node) - minus 1 if it is online (since
         # non-leaf nodes increment their normal counts when they are online and
         # we are now a leaf, storing that 1 in the binary refcount).
-        ns = lvhdutil.NS_PREFIX_LVM + self.uuid
+        ns = NS_PREFIX_LVM + self.uuid
         cCnt, cBcnt = RefCounter.check(vdi.uuid, ns)
         pCnt, pBcnt = RefCounter.check(vdi.parent.uuid, ns)
         pCnt = pCnt - cBcnt
@@ -3236,7 +3238,7 @@ def _undoInterruptedCoalesceLeaf(self, childUuid, parentUuid):
             # refcount (best effort - assume that it had succeeded if the
             # second rename succeeded; if not, this adjustment will be wrong,
             # leading to a non-deactivation of the LV)
-            ns = lvhdutil.NS_PREFIX_LVM + self.uuid
+            ns = NS_PREFIX_LVM + self.uuid
             cCnt, cBcnt = RefCounter.check(child.uuid, ns)
             pCnt, pBcnt = RefCounter.check(parent.uuid, ns)
             pCnt = pCnt + cBcnt
@@ -3283,7 +3285,7 @@ def _checkSlaves(self, vdi):
                 "lvName1": vdi.fileName,
                 "action2": "cleanupLockAndRefcount",
                 "uuid2": vdi.uuid,
-                "ns2": lvhdutil.NS_PREFIX_LVM + self.uuid}
+                "ns2": NS_PREFIX_LVM + self.uuid}
         onlineHosts = self.xapi.getOnlineHosts()
         abortFlag = IPCFlag(self.uuid)
         for pbdRecord in self.xapi.getAttachedPBDs():
@@ -3341,7 +3343,7 @@ def _updateSlavesOnRename(self, vdi, oldNameLV, origParentUuid) -> None:
                 "lvName2": vdi.fileName,
                 "action3": "cleanupLockAndRefcount",
                 "uuid3": origParentUuid,
-                "ns3": lvhdutil.NS_PREFIX_LVM + self.uuid}
+                "ns3": NS_PREFIX_LVM + self.uuid}
         for slave in slaves:
             Util.log("Updating %s to %s on slave %s" % \
                     (oldNameLV, vdi.fileName,
@@ -4123,7 +4125,7 @@ def debug(sr_uuid, cmd, vdi_uuid):
         vdi._activate()
         print("VDI file: %s" % vdi.path)
     if cmd == "deactivate":
-        ns = lvhdutil.NS_PREFIX_LVM + sr.uuid
+        ns = NS_PREFIX_LVM + sr.uuid
         sr.lvmCache.deactivate(ns, vdi.uuid, vdi.fileName, False)
     if cmd == "inflate":
         vdi.inflateFully()

drivers/constants.py

@@ -1,4 +1,13 @@
+from sm_typing import Final
+
 EXT_PREFIX = 'XSLocalEXT-'
 CBT_BLOCK_SIZE = (64 * 1024)
 CBTLOG_TAG = "cbtlog"
 CBT_UTIL = "/usr/sbin/cbt-util"
+
+VG_LOCATION: Final = "/dev"
+VG_PREFIX: Final = "VG_XenStorage-"
+
+# Ref counting for VDI's: we need a ref count for LV activation/deactivation
+# on the master.
+NS_PREFIX_LVM: Final = "lvm-"

drivers/lvhd-thin

@@ -28,12 +28,14 @@ from journaler import Journaler
 import lvutil
 import os
 
+from constants import VG_PREFIX
+
 def attach(session, args):
     if util.is_master(session):
         os.environ['LVM_SYSTEM_DIR'] = lvutil.MASTER_LVM_CONF
     srUuid = args["srUuid"]
     vdiUuid = args["vdiUuid"]
-    vgName = "%s%s" % (lvhdutil.VG_PREFIX, srUuid)
+    vgName = "%s%s" % (VG_PREFIX, srUuid)
     lvmCache = LVMCache(vgName)
     journaler = Journaler(lvmCache)
     try:
@@ -48,7 +50,7 @@ def detach(session, args):
         os.environ['LVM_SYSTEM_DIR'] = lvutil.MASTER_LVM_CONF
     srUuid = args["srUuid"]
     vdiUuid = args["vdiUuid"]
-    vgName = "%s%s" % (lvhdutil.VG_PREFIX, srUuid)
+    vgName = "%s%s" % (VG_PREFIX, srUuid)
     lvmCache = LVMCache(vgName)
     try:
         lvhdutil.detachThin(session, lvmCache, args["srUuid"], args["vdiUuid"])

drivers/lvmanager.py

@@ -20,6 +20,7 @@
 import util
 import lvhdutil
 
+from constants import NS_PREFIX_LVM
 
 class LVManagerException(util.SMException):
     pass
@@ -42,7 +43,7 @@ class LVActivator:
     PERSISTENT = True
 
     def __init__(self, srUuid, lvmCache):
-        self.ns = lvhdutil.NS_PREFIX_LVM + srUuid
+        self.ns = NS_PREFIX_LVM + srUuid
         self.lvmCache = lvmCache
         self.lvActivations = dict()
         self.openFiles = dict()

drivers/lvmcache.py

@@ -20,6 +20,8 @@
 import util
 import lvutil
 import lvhdutil
+
+from constants import NS_PREFIX_LVM
 from lock import Lock
 from refcounter import RefCounter
 
@@ -226,7 +228,7 @@ def setReadonly(self, lvName, readonly):
         path = self._getPath(lvName)
         if self.lvs[lvName].readonly != readonly:
             uuids = util.findall_uuid(path)
-            ns = lvhdutil.NS_PREFIX_LVM + uuids[0]
+            ns = NS_PREFIX_LVM + uuids[0]
             # Taking this lock is needed to avoid a race condition
             # with tap-ctl open (which is now taking the same lock)
             lock = Lock("lvchange-p", ns)

drivers/lvutil.py

@@ -27,8 +27,7 @@
 import util
 import xs_errors
 import xml.dom.minidom
-from lvhdutil import VG_LOCATION, VG_PREFIX
-from constants import EXT_PREFIX
+from constants import EXT_PREFIX, VG_LOCATION, VG_PREFIX
 import lvmcache
 import srmetadata
 

drivers/tapdisk-pause

@@ -28,6 +28,8 @@ import XenAPI
 import lvhdutil
 import vhdutil
 import lvmcache
+
+from constants import NS_PREFIX_LVM, VG_PREFIX
 from vditype import VdiType
 
 try:
@@ -209,8 +211,8 @@ class Tapdisk:
             return str(False)
         if self.activate_parents:
             util.SMlog("Activating parents of %s" % self.vdi_uuid)
-            vg_name = lvhdutil.VG_PREFIX + self.sr_uuid
-            ns = lvhdutil.NS_PREFIX_LVM + self.sr_uuid
+            vg_name = VG_PREFIX + self.sr_uuid
+            ns = NS_PREFIX_LVM + self.sr_uuid
             lvm_cache = lvmcache.LVMCache(vg_name)
             lv_name = lvhdutil.LV_PREFIX[VdiType.VHD] + self.vdi_uuid
             vdi_list = vhdutil.getParentChain(lv_name,

drivers/trim_util.py

@@ -25,6 +25,8 @@
 import vhdutil
 import lvutil
 
+from constants import VG_LOCATION, VG_PREFIX
+
 TRIM_LV_TAG = "_trim_lv"
 TRIM_CAP = "SR_TRIM"
 LOCK_RETRY_ATTEMPTS = 3
@@ -37,11 +39,11 @@
 
 
 def _vg_by_sr_uuid(sr_uuid):
-    return lvhdutil.VG_PREFIX + sr_uuid
+    return VG_PREFIX + sr_uuid
 
 
 def _lvpath_by_vg_lv_name(vg_name, lv_name):
-    return os.path.join(lvhdutil.VG_LOCATION, vg_name, lv_name)
+    return os.path.join(VG_LOCATION, vg_name, lv_name)
 
 
 def to_xml(d):