feat(ctld): make socket operations async

Author: rkojedzinszky

src/middlewared/middlewared/ctld.py

@@ -1,4 +1,5 @@
 import socket
+import asyncio
 from urllib.parse import quote
 
 
@@ -7,36 +8,36 @@ class CTLDControl:
 
     def __init__(self):
         self.sock = None
+        self.loop = asyncio.get_event_loop()
 
-    def open(self):
+    async def open(self):
         self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_SEQPACKET)
-        self.sock.connect(self.socket)
+        self.sock.setblocking(False)
+        await self.loop.sock_connect(self.sock, self.socket)
 
     def close(self):
         self.sock.close()
         self.sock = None
 
-    def cmd(self, command, id, args=[]):
+    async def cmd(self, command, id, args=[]):
         line = ' '.join([command, quote(id), *args])
         line = line.encode()
 
-        if self.sock.send(line) != len(line):
-            raise RuntimeError("Failed writing to socket")
-
-        ret = self.sock.recv(4096)
+        await self.loop.sock_sendall(self.sock, line)
+        ret = await self.loop.sock_recv(self.sock, 4096)
         ret = ret.decode()
 
         if not ret.startswith("OK"):
             raise RuntimeError("ctld-control: {}".format(ret))
 
-    def __enter__(self):
-        self.open()
+    async def __aenter__(self):
+        await self.open()
         return self
 
-    def __exit__(self, exc_type, exc_value, traceback):
+    async def __aexit__(self, exc_type, exc_value, traceback):
         self.close()
 
-    def auth_group_set(self, id, type_, auths):
+    async def auth_group_set(self, id, type_, auths):
         """
         Parameters
         ----------
@@ -54,12 +55,12 @@ def auth_group_set(self, id, type_, auths):
 
         args += ["auth={}".format(quote(i)) for i in a]
 
-        return self.cmd("auth-group-set", id, args)
+        await self.cmd("auth-group-set", id, args)
 
-    def auth_group_del(self, id):
-        return self.cmd("auth-group-del", id, [])
+    async def auth_group_del(self, id):
+        await self.cmd("auth-group-del", id, [])
 
-    def lun_set(self, id, ctl_lun, path, blocksize, serial, device_id, size, pblocksize=None, **options):
+    async def lun_set(self, id, ctl_lun, path, blocksize, serial, device_id, size, pblocksize=None, **options):
         args=[
             "ctl-lun={}".format(ctl_lun),
             "path={}".format(quote(path)),
@@ -77,12 +78,12 @@ def lun_set(self, id, ctl_lun, path, blocksize, serial, device_id, size, pblocks
         for key, value in options.items():
             args.append("option={}={}".format(key, quote(str(value))))
 
-        return self.cmd("lun-set", id, args)
+        await self.cmd("lun-set", id, args)
 
-    def lun_del(self, id):
-        return self.cmd("lun-del", id)
+    async def lun_del(self, id):
+        await self.cmd("lun-del", id)
 
-    def target_add(self, id, alias=None, pgs=[], ag=None):
+    async def target_add(self, id, alias=None, pgs=[], ag=None):
         args = []
 
         if alias is not None:
@@ -96,10 +97,10 @@ def target_add(self, id, alias=None, pgs=[], ag=None):
         if ag is not None:
             args.append('auth-group={}'.format(ag))
 
-        return self.cmd("target-add", id, args)
+        await self.cmd("target-add", id, args)
 
-    def target_del(self, id):
-        return self.cmd("target-del", id)
+    async def target_del(self, id):
+        await self.cmd("target-del", id)
 
-    def target_set_luns(self, id, luns=[]):
-        return self.cmd("target-set-lun", id, luns)
+    async def target_set_luns(self, id, luns=[]):
+        await self.cmd("target-set-lun", id, luns)

src/middlewared/middlewared/plugins/iscsi.py

@@ -468,15 +468,15 @@ async def ctld_set(self, tag):
             for i in await self.middleware.call(
             'datastore.query', 'services.iscsitargetauthcredential', [['iscsi_target_auth_tag', '=', tag]]
         )]
-        with ctld.CTLDControl() as c:
+        async with ctld.CTLDControl() as c:
             for grp in await self.middleware.call(
                 'datastore.query', 'services.iscsitargetgroups', [['iscsi_target_authgroup', '=', tag]]
             ):
                 type_ = grp['iscsi_target_authtype']
                 if type_ == 'CHAP Mutual':
                     type_ = 'chap-mutual'
                 agname = 'ag4tg%d_%d' % (grp['iscsi_target']['id'], grp['id'])
-                c.auth_group_set(agname, type_, auths)
+                await c.auth_group_set(agname, type_, auths)
 
 
 class iSCSITargetExtentModel(sa.Model):
@@ -1088,8 +1088,8 @@ async def ctld_set(self, e):
         if e['ro']:
             options['readonly'] = "on"
 
-        with ctld.CTLDControl() as c:
-            c.lun_set(
+        async with ctld.CTLDControl() as c:
+            await c.lun_set(
                 e['name'],
                 e['id'] - 1,
                 path,
@@ -1103,8 +1103,8 @@ async def ctld_set(self, e):
 
     @private
     async def ctld_del(self, name):
-        with ctld.CTLDControl() as c:
-            c.lun_del(name)
+        async with ctld.CTLDControl() as c:
+            await c.lun_del(name)
 
 
 class iSCSITargetAuthorizedInitiatorModel(sa.Model):
@@ -1606,15 +1606,15 @@ async def ctld_add(self, target):
                 'agname': 'ag4tg%d_%d' % (target['id'], grp['id']),
             })
 
-        with ctld.CTLDControl() as c:
+        async with ctld.CTLDControl() as c:
             pgs = []
 
             for i in groups:
                 type_ = i['grp']['iscsi_target_authtype']
                 if type_ == 'CHAP Mutual':
                     type_ = 'chap-mutual'
 
-                c.auth_group_set(i['agname'], type_.lower(), i['auths'])
+                await c.auth_group_set(i['agname'], type_.lower(), i['auths'])
 
                 pgtag = i['grp']['iscsi_target_portalgroup']['iscsi_target_portal_tag']
 
@@ -1625,19 +1625,19 @@ async def ctld_add(self, target):
                     pgs.append('pg%d:%s' % (pgtag, i['agname']))
 
             # create target
-            c.target_add(name, alias, pgs)
+            await c.target_add(name, alias, pgs)
 
     @private
     async def ctld_del(self, target, tgg):
         name = await self.target_name(target)
 
-        with ctld.CTLDControl() as c:
-            c.target_del(name)
+        async with ctld.CTLDControl() as c:
+            await c.target_del(name)
 
             for grp in tgg:
                 agname = 'ag4tg%d_%d' % (target['id'], grp['id'])
 
-                c.auth_group_del(agname)
+                await c.auth_group_del(agname)
 
     @private
     async def ctld_set_luns(self, target):
@@ -1673,8 +1673,8 @@ async def ctld_set_luns(self, target):
                 lundef = ''
             luns.append('lun{}{}'.format(lunidx, lundef))
 
-        with ctld.CTLDControl() as c:
-            c.target_set_luns(name, luns)
+        async with ctld.CTLDControl() as c:
+            await c.target_set_luns(name, luns)
 
 
 class iSCSITargetToExtentModel(sa.Model):