fix: stop SMGC service on SR detach to prevent orphaned systemd units

Signed-off-by: Mathieu Labourier <mathieu.labourier@vates.tech>

Author: Millefeuille42

drivers/CephFSSR.py

@@ -216,6 +216,7 @@ def detach(self, sr_uuid) -> None:
         self.unmount(self.mountpoint, True)
         os.unlink(self.path)
         self.attached = False
+        cleanup.stop_gc_service(sr_uuid)
 
     @override
     def create(self, sr_uuid, size) -> None:

drivers/FileSR.py

@@ -197,6 +197,7 @@ def detach(self, sr_uuid) -> None:
             except Exception as e:
                 raise xs_errors.XenError('SRInUse', opterr=str(e))
         self.attached = False
+        cleanup.stop_gc_service(sr_uuid)
 
     @override
     def scan(self, sr_uuid) -> None:

drivers/GlusterFSSR.py

@@ -196,6 +196,7 @@ def detach(self, sr_uuid) -> None:
         self.unmount(self.mountpoint, True)
         os.unlink(self.path)
         self.attached = False
+        cleanup.stop_gc_service(sr_uuid)
 
     @override
     def create(self, sr_uuid, size) -> None:

drivers/LVHDSR.py

@@ -668,6 +668,7 @@ def detach(self, uuid) -> None:
         # However, we should still delete lock files on slaves as it is the
         # only place to do so.
         self._cleanup(self.isMaster)
+        cleanup.stop_gc_service(uuid)
 
     @override
     def forget_vdi(self, uuid) -> None:

drivers/LinstorSR.py

@@ -746,6 +746,7 @@ def attach(self, uuid) -> None:
     def detach(self, uuid) -> None:
         util.SMlog('LinstorSR.detach for {}'.format(self.uuid))
         cleanup.abort(self.uuid)
+        cleanup.stop_gc_service(uuid)
 
     @override
     @_locked_load

drivers/MooseFSSR.py

@@ -210,6 +210,7 @@ def detach(self, sr_uuid) -> None:
         os.chdir(SR.MOUNT_BASE)
         self.unmount(self.mountpoint, True)
         self.attached = False
+        cleanup.stop_gc_service(sr_uuid)
 
     @override
     def create(self, sr_uuid, size) -> None:

drivers/NFSSR.py

@@ -206,6 +206,7 @@ def detach(self, sr_uuid) -> None:
             raise xs_errors.XenError('NFSUnMount', opterr=exc.errstr)
 
         self.attached = False
+        cleanup.stop_gc_service(sr_uuid)
 
     @override
     def create(self, sr_uuid, size) -> None:

drivers/SMBSR.py

@@ -248,6 +248,7 @@ def detach(self, sr_uuid) -> None:
             raise xs_errors.XenError('SMBUnMount', opterr=exc.errstr)
 
         self.attached = False
+        cleanup.stop_gc_service(sr_uuid)
 
     @override
     def create(self, sr_uuid, size) -> None:

drivers/cleanup.py

@@ -4040,6 +4040,18 @@ def start_gc_service(sr_uuid, wait=False):
     subprocess.run(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, close_fds=True)
 
 
+def stop_gc_service(sr_uuid):
+    """
+    Stops the templated systemd service which runs GC on the given SR UUID.
+    """
+    sr_uuid_esc = sr_uuid.replace("-", "\\x2d")
+    util.SMlog(f"Stopping SMGC@{sr_uuid}...")
+    cmd = ["/usr/bin/systemctl", "--quiet", "stop", f"SMGC@{sr_uuid_esc}"]
+    try:
+        subprocess.run(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, close_fds=True, check=True)
+    except subprocess.CalledProcessError as e:
+        util.SMlog(f"Failed to stop gc service `SMGC@{sr_uuid_esc}`: `{e.stderr.decode().strip()}`")
+
 def gc_force(session, srUuid, force=False, dryRun=False, lockSR=False):
     """Garbage collect all deleted VDIs in SR "srUuid". The caller must ensure
     the SR lock is held.