Change in vdsm[master]: gluster: Get size information of a gluster volume. - vdsm-patches - Fedora mailing-lists

11 Jun 2014

Darshan N has uploaded a new change for review.
Change subject: gluster: Get size information of a gluster volume.
......................................................................
gluster: Get size information of a gluster volume.
New vdsm gluster verb to get free, used and total size of
gluster volume. This verb uses libgfapi to get the statistics
related to volume. This patch makes use of ctypes to utilize
the libgfapi.
verb: glusterVolumeStatsInfoGet
Output format:
{"sizeTotal": LONG as STR, "sizeFree": LONG as STR, "sizeUsed": LONG as STR}
Change-Id: If5d622738ae955eb4002f56fc73adb4f07f0b857
Signed-off-by: darshan n dnarayan@redhat.com
---
M client/vdsClientGluster.py
M vdsm.spec.in
M vdsm/gluster/Makefile.am
M vdsm/gluster/__init__.py
M vdsm/gluster/api.py
M vdsm/gluster/exception.py
A vdsm/gluster/gfapi.py
M vdsm/gluster/vdsmapi-gluster-schema.json
8 files changed, 236 insertions(+), 1 deletion(-)
git pull ssh://gerrit.ovirt.org:29418/vdsm refs/changes/81/28581/1

diff --git a/client/vdsClientGluster.py b/client/vdsClientGluster.py
index 9fa58b2..421c853 100644
--- a/client/vdsClientGluster.py
+++ b/client/vdsClientGluster.py
@@ -422,6 +422,14 @@
         pp.pprint(status)
         return status['status']['code'], status['status']['message']
+    def do_glusterVolumeStatsInfoGet(self, args):
+        params = self._eqSplit(args)
+        volumeName = params.get('volumeName', '')
+
+        status = self.s.glusterVolumeStatsInfoGet(volumeName)
+        pp.pprint(status)
+        return status['status']['code'], status['status']['message']
+
def getGlusterCmdDict(serv):
     return \
@@ -718,4 +726,9 @@
              ('[taskIds=<task_id1,task_id2,..>]',
               'list all or given gluster tasks'
               )),
+         'glusterVolumeStatsInfoGet': (
+             serv.do_glusterVolumeStatsInfoGet,
+             ('volumeName=<volume name>',
+              'Returns total, free and used space(bytes) of gluster volume'
+              )),
          }
diff --git a/vdsm.spec.in b/vdsm.spec.in
index df027d0..b93847b 100644
--- a/vdsm.spec.in
+++ b/vdsm.spec.in
@@ -1484,6 +1484,7 @@
 %doc COPYING
 %{_datadir}/%{vdsm_name}/gluster/api.py*
 %{_datadir}/%{vdsm_name}/gluster/vdsmapi-gluster-schema.json
+%{_datadir}/%{vdsm_name}/gluster/gfapi.py*
 %{_datadir}/%{vdsm_name}/gluster/hooks.py*
 %{_datadir}/%{vdsm_name}/gluster/services.py*
 %{_datadir}/%{vdsm_name}/gluster/tasks.py*
diff --git a/vdsm/gluster/Makefile.am b/vdsm/gluster/Makefile.am
index b397e95..3c307aa 100644
--- a/vdsm/gluster/Makefile.am
+++ b/vdsm/gluster/Makefile.am
@@ -31,6 +31,7 @@
    api.py \
    cli.py \
    exception.py \
+	gfapi.py \
    hooks.py \
    services.py \
    tasks.py \
diff --git a/vdsm/gluster/__init__.py b/vdsm/gluster/__init__.py
index 0aefb8d..b83efbb 100644
--- a/vdsm/gluster/__init__.py
+++ b/vdsm/gluster/__init__.py
@@ -22,7 +22,7 @@
 import tempfile
 from functools import wraps
-MODULE_LIST = ('cli', 'hooks', 'services', 'tasks')
+MODULE_LIST = ('cli', 'hooks', 'services', 'tasks', 'gfapi')
def makePublic(func):
diff --git a/vdsm/gluster/api.py b/vdsm/gluster/api.py
index 128ff7d..5cdd599 100644
--- a/vdsm/gluster/api.py
+++ b/vdsm/gluster/api.py
@@ -306,6 +306,10 @@
         status = self.svdsmProxy.glusterTasksList(taskIds)
         return {'tasks': status}
+    @exportAsVerb
+    def volumeStatsInfoGet(self, volumeName, options=None):
+        return self.svdsmProxy.glusterVolumeStatsInfoGet(volumeName)
+
def getGlusterMethods(gluster):
     l = []
diff --git a/vdsm/gluster/exception.py b/vdsm/gluster/exception.py
index c7a4dae..26f7443 100644
--- a/vdsm/gluster/exception.py
+++ b/vdsm/gluster/exception.py
@@ -486,3 +486,28 @@
         prefix = "%s: " % (action)
         self.message = prefix + "Service action is not supported"
         self.err = [self.message]
+
+
+class GlusterLibgfapiException(GlusterException):
+    code = 4570
+    message = "Gluster Libgfapi Exception"
+
+
+class GlusterVolumeStatsInfoGetFailedException(GlusterLibgfapiException):
+    code = 4571
+    message = "Failed to get Gluster volume Size info"
+
+
+class GlusterVolumeSetVolfileServerFailedException(GlusterLibgfapiException):
+    code = 4572
+    message = "setting volfile server failed"
+
+
+class GlusterVolumeGlfsInitFailedException(GlusterLibgfapiException):
+    code = 4573
+    message = "glfs inint failed"
+
+
+class GlusterVolumeGlfsFinitFailedException(GlusterLibgfapiException):
+    code = 4574
+    message = "glfs finit failed"
diff --git a/vdsm/gluster/gfapi.py b/vdsm/gluster/gfapi.py
new file mode 100644
index 0000000..5d566cc
--- /dev/null
+++ b/vdsm/gluster/gfapi.py
@@ -0,0 +1,158 @@
+#
+# Copyright 2013 Red Hat, Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
+#
+# Refer to the README and COPYING files for full details of the license
+#
+import ctypes
+from ctypes.util import find_library
+import os
+
+import exception as ge
+from . import makePublic
+
+
+GLUSTER_VOL_PROTOCAL = 'tcp'
+GLUSTER_VOL_HOST = 'localhost'
+GLUSTER_VOL_PORT = 24007
+GLUSTER_VOL_PATH = "/"
+_api = None
+
+
+class StatVfsStruct(ctypes.Structure):
+    _fields_ = [
+        ('f_bsize', ctypes.c_ulong),
+        ('f_frsize', ctypes.c_ulong),
+        ('f_blocks', ctypes.c_ulong),
+        ('f_bfree', ctypes.c_ulong),
+        ('f_bavail', ctypes.c_ulong),
+        ('f_files', ctypes.c_ulong),
+        ('f_ffree', ctypes.c_ulong),
+        ('f_favail', ctypes.c_ulong),
+        ('f_fsid', ctypes.c_ulong),
+        ('f_flag', ctypes.c_ulong),
+        ('f_namemax', ctypes.c_ulong),
+        ('__f_spare', ctypes.c_int * 6),
+        ]
+
+
+def _lazyInitGfapi():
+    """
+    Lazy loading libgfapi
+    """
+    global _api
+    if not _api:
+        _api = ctypes.CDLL(find_library("gfapi"),
+                           ctypes.RTLD_GLOBAL,
+                           use_errno=True)
+    return
+
+
+def _volumeMount(volumeId):
+    _glfs_new = ctypes.CFUNCTYPE(
+        ctypes.c_void_p, ctypes.c_char_p)(('glfs_new', _api))
+    fs = _glfs_new(volumeId)
+
+    _glfs_set_volfile_server = ctypes.CFUNCTYPE(
+        ctypes.c_int,
+        ctypes.c_void_p,
+        ctypes.c_char_p,
+        ctypes.c_char_p,
+        ctypes.c_int)(('glfs_set_volfile_server', _api))
+    rc = _glfs_set_volfile_server(fs,
+                                  GLUSTER_VOL_PROTOCAL,
+                                  GLUSTER_VOL_HOST,
+                                  GLUSTER_VOL_PORT)
+    if rc != 0:
+        raise ge.GlusterVolumeSetVolfileServerFailedException(rc=rc)
+
+    _glfs_init = ctypes.CFUNCTYPE(
+        ctypes.c_int, ctypes.c_void_p)(('glfs_init', _api))
+    rc = _glfs_init(fs)
+    if rc != 0:
+        errMsg = ""
+        if rc == 1:
+            errMsg += "Volume is stopped."
+        elif rc == -1:
+            errMsg += "Volume not found."
+        raise ge.GlusterVolumeGlfsInitFailedException(rc=rc,
+                                                      err=[errMsg])
+    return fs
+
+
+def _volumeUmount(fs, volumeId):
+    _glfs_fini = ctypes.CFUNCTYPE(
+        ctypes.c_int, ctypes.c_void_p)(('glfs_fini', _api))
+    rc = _glfs_fini(fs)
+    if rc != 0:
+        raise ge.GlusterVolumeGlfsFinitFailedException(rc=rc)
+
+
+def volumeStatvfs(volumeId):
+    statvfsdata = StatVfsStruct()
+    _lazyInitGfapi()
+
+    # Define return type and argtypes of glfs_statvfs
+    _api.glfs_statvfs.restype = ctypes.c_int
+    _api.glfs_statvfs.argtypes = [ctypes.c_void_p,
+                                  ctypes.c_char_p,
+                                  ctypes.POINTER(StatVfsStruct)]
+
+    fs = _volumeMount(volumeId)
+    _glfs_statvfs = ctypes.CFUNCTYPE(ctypes.c_int,
+                                     ctypes.c_void_p,
+                                     ctypes.c_char_p,
+                                     ctypes.c_void_p)(('glfs_statvfs', _api))
+
+    rc = _glfs_statvfs(fs, GLUSTER_VOL_PATH, ctypes.byref(statvfsdata))
+    if rc != 0:
+        raise ge.GlusterVolumeStatsInfoGetFailedException(rc=rc,
+                                                          volId=volumeId)
+
+    _volumeUmount(fs, volumeId)
+
+    # To convert to os.statvfs_result we need to pass tuple/list in
+    # following order: bsize, frsize, blocks, bfree, bavail, files,
+    #                  ffree, favail, flag, namemax
+    return os.statvfs_result((statvfsdata.f_bsize,
+                              statvfsdata.f_frsize,
+                              statvfsdata.f_blocks,
+                              statvfsdata.f_bfree,
+                              statvfsdata.f_bavail,
+                              statvfsdata.f_files,
+                              statvfsdata.f_ffree,
+                              statvfsdata.f_favail,
+                              statvfsdata.f_flag,
+                              statvfsdata.f_namemax))
+
+
+@makePublic
+def volumeStatsInfoGet(volumeName):
+
+    data = volumeStatvfs(volumeName)
+
+    # f_blocks = Total number of blocks
+    # f_bfree = Total number of blocks free
+    # f_bavail = Total number of blocks available for non root user
+    # total blocks available = f_blocks - (f_bfree - f_bavail)
+
+    total = (data.f_blocks - (data.f_bfree - data.f_bavail)) * data.f_bsize
+    free = data.f_bavail * data.f_bsize
+    used = total - free
+
+    return {'sizeTotal': str(total),
+            'sizeFree': str(free),
+            'sizeUsed': str(used)}
diff --git a/vdsm/gluster/vdsmapi-gluster-schema.json b/vdsm/gluster/vdsmapi-gluster-schema.json
index 4e80679..4ddd182 100644
--- a/vdsm/gluster/vdsmapi-gluster-schema.json
+++ b/vdsm/gluster/vdsmapi-gluster-schema.json
@@ -1205,3 +1205,36 @@
 ##
 {'command': {'class': 'GlusterHost', 'name': 'list'},
  'returns': ['HostList']}
+
+##
+# @GlusterVolumeStatsInfo:
+#
+# Gluster Volumes disk usage statistics
+#
+# @sizeTotal: Total space available in bytes
+#
+# @sizeFree: Free space available in bytes
+#
+# @sizeUsed: Used space in bytes
+#
+# Since: 4.15.0
+##
+{'type': 'GlusterVolumeStatsInfo',
+ 'data': {'sizeTotal': 'str', 'sizeFree': 'str', 'sizeUsed': 'str'}}
+
+
+##
+# @GlusterVolume.statsInfoGet:
+#
+# Get the size info of gluster volume
+#
+# @volumeName: Gluster volume name
+#
+# Returns:
+# Stats info of GlusterFS volume
+#
+# Since: 4.15.0
+##
+{'command': {'class': 'GlusterVolume', 'name': 'statsInfoGet'},
+ 'data': {'volumeName': 'str'},
+ 'returns': 'GlusterVolumeStatsInfo'}
-- 
To view, visit http://gerrit.ovirt.org/28581
To unsubscribe, visit http://gerrit.ovirt.org/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: If5d622738ae955eb4002f56fc73adb4f07f0b857
Gerrit-PatchSet: 1
Gerrit-Project: vdsm
Gerrit-Branch: master
Gerrit-Owner: Darshan N dnarayan@redhat.com

    