WIP ioctl: rename logical_to_ino to logical_ino

Wipperdewip

Author: knorrie

btrfs/ctree.py

@@ -1340,8 +1340,8 @@ class ExtentItem(ItemData):
     is ignored when creating these kind of objects from a metadata search.
 
     Instead, to find out who is referencing data from an extent, the
-    :func:`btrfs.ioctl.logical_to_ino` and
-    :func:`btrfs.ioctl.logical_to_ino_v2` functions can be used.
+    :func:`btrfs.ioctl.logical_ino` and
+    :func:`btrfs.ioctl.logical_ino_v2` functions can be used.
 
     :ivar int vaddr: Virtual address where the Extent starts (taken from the
         objectid field of the item key).

btrfs/ioctl.py

@@ -489,7 +489,7 @@ def _search(fd, tree, min_key=None, max_key=None,
 Inode = namedtuple('Inode', ['inum', 'offset', 'root'])
 
 
-def logical_to_ino(fd, vaddr, bufsize=4096):
+def logical_ino(fd, vaddr, bufsize=4096):
     """Call the `BTRFS_IOC_LOGICAL_INO` ioctl.
 
     The `LOGICAL_INO` ioctl helps us converting a virtual address into a list
@@ -500,7 +500,7 @@ def logical_to_ino(fd, vaddr, bufsize=4096):
 
         >>> import btrfs
         >>> with btrfs.FileSystem('/') as fs:
-        ...     btrfs.ioctl.logical_to_ino(fs.fd, 607096483840)
+        ...     btrfs.ioctl.logical_ino(fs.fd, 607096483840)
         ([Inode(inum=4686948, offset=0, root=259),
           Inode(inum=4686948, offset=0, root=2104)], 0)
 
@@ -523,15 +523,24 @@ def logical_to_ino(fd, vaddr, bufsize=4096):
     reference any block in the extent, use the logical ino v2 ioctl instead,
     while setting the ignore_offset flag.
     """
-    return _logical_to_ino(fd, vaddr, bufsize, _v2=False)
+    return _logical_ino(fd, vaddr, bufsize, _v2=False)
+
+
+def logical_to_ino(*args, **kwargs):
+    """
+    .. deprecated:: 15
+       Backwards compatibility function. Use :func:`~btrfs.ioctl.logical_ino`
+       instead.
+    """
+    return logical_ino(*args, **kwargs)
 
 
 ioctl_logical_ino_args_v2 = struct.Struct('=QQ24xQQ')
 IOC_LOGICAL_INO_V2 = _IOWR(BTRFS_IOCTL_MAGIC, 59, ioctl_logical_ino_args)
 LOGICAL_INO_ARGS_IGNORE_OFFSET = 1 << 0
 
 
-def logical_to_ino_v2(fd, vaddr, bufsize=4096, ignore_offset=False):
+def logical_ino_v2(fd, vaddr, bufsize=4096, ignore_offset=False):
     """Call the `BTRFS_IOC_LOGICAL_INO_V2` ioctl.
 
     The `LOGICAL_INO_V2` ioctl helps us converting a virtual address into a
@@ -542,7 +551,7 @@ def logical_to_ino_v2(fd, vaddr, bufsize=4096, ignore_offset=False):
 
         >>> import btrfs
         >>> with btrfs.FileSystem('/') as fs:
-        ...     btrfs.ioctl.logical_to_ino_v2(fs.fd, 607096483840)
+        ...     btrfs.ioctl.logical_ino_v2(fs.fd, 607096483840)
         ([Inode(inum=4686948, offset=0, root=259),
           Inode(inum=4686948, offset=0, root=2104)], 0)
 
@@ -562,10 +571,19 @@ def logical_to_ino_v2(fd, vaddr, bufsize=4096, ignore_offset=False):
     results, retry the call with a larger buffer, adding the amount of bytes
     that was reported to be additionally needed.
     """
-    return _logical_to_ino(fd, vaddr, bufsize, ignore_offset, _v2=True)
+    return _logical_ino(fd, vaddr, bufsize, ignore_offset, _v2=True)
+
+
+def logical_to_ino_v2(*args, **kwargs):
+    """
+    .. deprecated:: 15
+       Backwards compatibility function. Use
+       :func:`~btrfs.ioctl.logical_ino_v2` instead.
+    """
+    return logical_ino(*args, **kwargs)
 
 
-def _logical_to_ino(fd, vaddr, bufsize=4096, ignore_offset=False, _v2=True):
+def _logical_ino(fd, vaddr, bufsize=4096, ignore_offset=False, _v2=True):
     if _v2:
         bufsize = min(bufsize, 16777216)
     else:

examples/show_block_group_data_extent_filenames.py

@@ -10,28 +10,28 @@
 
 
 def using_v1(fd, vaddr):
-    return btrfs.ioctl.logical_to_ino(fd, vaddr)
+    return btrfs.ioctl.logical_ino(fd, vaddr)
 
 
 def using_v2(fd, vaddr):
-    inodes, bytes_missed = btrfs.ioctl.logical_to_ino_v2(fd, vaddr, ignore_offset=True)
+    inodes, bytes_missed = btrfs.ioctl.logical_ino_v2(fd, vaddr, ignore_offset=True)
     if bytes_missed > 0:
         inodes, bytes_missed = \
-            btrfs.ioctl.logical_to_ino_v2(fd, vaddr, bufsize=65536+bytes_missed,
+            btrfs.ioctl.logical_ino_v2(fd, vaddr, bufsize=65536+bytes_missed,
                                           ignore_offset=True)
     return inodes, bytes_missed
 
 
 def find_out_about_v1_or_v2(fd, vaddr):
-    global logical_to_ino_fn
+    global logical_ino_fn
     try:
         inodes, bytes_missed = using_v2(fd, vaddr)
-        logical_to_ino_fn = using_v2
+        logical_ino_fn = using_v2
         return inodes, bytes_missed
     except IOError as e:
         if e.errno == errno.ENOTTY:
             inodes, bytes_missed = using_v1(fd, vaddr)
-            logical_to_ino_fn = using_v1
+            logical_ino_fn = using_v1
             return inodes, bytes_missed
         raise
 
@@ -43,13 +43,13 @@ def find_out_about_v1_or_v2(fd, vaddr):
     block_group = fs.block_group(vaddr)
     print(block_group)
 
-    logical_to_ino_fn = find_out_about_v1_or_v2
+    logical_ino_fn = find_out_about_v1_or_v2
 
     for extent in fs.extents(vaddr, vaddr + block_group.length - 1):
         if isinstance(extent, btrfs.ctree.ExtentItem) \
                 and extent.flags & btrfs.ctree.EXTENT_FLAG_DATA:
             print(extent)
-            inodes, bytes_missed = logical_to_ino_fn(fs.fd, extent.vaddr)
+            inodes, bytes_missed = logical_ino_fn(fs.fd, extent.vaddr)
             for inode in inodes:
                 if inode.root == btrfs.ctree.FS_TREE_OBJECTID or \
                     (inode.root >= btrfs.ctree.FIRST_FREE_OBJECTID and
@@ -70,10 +70,10 @@ def find_out_about_v1_or_v2(fd, vaddr):
                 else:
                     print("    root {} inode {} offset {}".format(
                         inode.root, inode.inum, inode.offset))
-            if len(inodes) == 0 and logical_to_ino_fn == using_v1:
+            if len(inodes) == 0 and logical_ino_fn == using_v1:
                 print("    [... no result and no kernel support for LOGICAL_INO_V2]")
             if bytes_missed > 0:
-                if logical_to_ino_fn == using_v1:
+                if logical_ino_fn == using_v1:
                     print("    [... remainder can't be shown; no kernel support for LOGICAL_INO_V2]")  # noqa
                 else:
                     print("    [... remainder can't be shown; too many items for buffer size]")