[RFC PATCH 03/10] Add helper to format attribute bitmaps

[Chuck Lever <cel@kernel.org>]

From: Chuck Lever <chuck.lever@oracle.com>

I'm about to add several new attribute-related tests. Introduce
attr_bitmap_to_str() in nfs4lib.py to convert attribute bitmaps to
human-readable symbolic strings.

Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
---
 nfs4.1/nfs4lib.py | 69 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 69 insertions(+)

diff --git a/nfs4.1/nfs4lib.py b/nfs4.1/nfs4lib.py
index d3a1550f1ce1..5c2149002a27 100644
--- a/nfs4.1/nfs4lib.py
+++ b/nfs4.1/nfs4lib.py
@@ -564,6 +564,75 @@ def attr_name(bitnum):
     """Returns string corresponding to attr bitnum"""
     return bitnum2attr.get(bitnum, "unknown_%r" % bitnum)
 
+def attr_bitmap_to_str(bitmap):
+    """Convert an attribute bitmap to a symbolic string representation"""
+    attrs = [
+        (xdrdef.nfs4_const.FATTR4_SUPPORTED_ATTRS, "SUPPORTED_ATTRS"),
+        (xdrdef.nfs4_const.FATTR4_TYPE, "TYPE"),
+        (xdrdef.nfs4_const.FATTR4_FH_EXPIRE_TYPE, "FH_EXPIRE_TYPE"),
+        (xdrdef.nfs4_const.FATTR4_CHANGE, "CHANGE"),
+        (xdrdef.nfs4_const.FATTR4_SIZE, "SIZE"),
+        (xdrdef.nfs4_const.FATTR4_LINK_SUPPORT, "LINK_SUPPORT"),
+        (xdrdef.nfs4_const.FATTR4_SYMLINK_SUPPORT, "SYMLINK_SUPPORT"),
+        (xdrdef.nfs4_const.FATTR4_NAMED_ATTR, "NAMED_ATTR"),
+        (xdrdef.nfs4_const.FATTR4_FSID, "FSID"),
+        (xdrdef.nfs4_const.FATTR4_UNIQUE_HANDLES, "UNIQUE_HANDLES"),
+        (xdrdef.nfs4_const.FATTR4_LEASE_TIME, "LEASE_TIME"),
+        (xdrdef.nfs4_const.FATTR4_RDATTR_ERROR, "RDATTR_ERROR"),
+        (xdrdef.nfs4_const.FATTR4_ACL, "ACL"),
+        (xdrdef.nfs4_const.FATTR4_ACLSUPPORT, "ACLSUPPORT"),
+        (xdrdef.nfs4_const.FATTR4_ARCHIVE, "ARCHIVE"),
+        (xdrdef.nfs4_const.FATTR4_CANSETTIME, "CANSETTIME"),
+        (xdrdef.nfs4_const.FATTR4_CASE_INSENSITIVE, "CASE_INSENSITIVE"),
+        (xdrdef.nfs4_const.FATTR4_CASE_PRESERVING, "CASE_PRESERVING"),
+        (xdrdef.nfs4_const.FATTR4_CHOWN_RESTRICTED, "CHOWN_RESTRICTED"),
+        (xdrdef.nfs4_const.FATTR4_FILEHANDLE, "FILEHANDLE"),
+        (xdrdef.nfs4_const.FATTR4_FILEID, "FILEID"),
+        (xdrdef.nfs4_const.FATTR4_FILES_AVAIL, "FILES_AVAIL"),
+        (xdrdef.nfs4_const.FATTR4_FILES_FREE, "FILES_FREE"),
+        (xdrdef.nfs4_const.FATTR4_FILES_TOTAL, "FILES_TOTAL"),
+        (xdrdef.nfs4_const.FATTR4_FS_LOCATIONS, "FS_LOCATIONS"),
+        (xdrdef.nfs4_const.FATTR4_HIDDEN, "HIDDEN"),
+        (xdrdef.nfs4_const.FATTR4_HOMOGENEOUS, "HOMOGENEOUS"),
+        (xdrdef.nfs4_const.FATTR4_MAXFILESIZE, "MAXFILESIZE"),
+        (xdrdef.nfs4_const.FATTR4_MAXLINK, "MAXLINK"),
+        (xdrdef.nfs4_const.FATTR4_MAXNAME, "MAXNAME"),
+        (xdrdef.nfs4_const.FATTR4_MAXREAD, "MAXREAD"),
+        (xdrdef.nfs4_const.FATTR4_MAXWRITE, "MAXWRITE"),
+        (xdrdef.nfs4_const.FATTR4_MIMETYPE, "MIMETYPE"),
+        (xdrdef.nfs4_const.FATTR4_MODE, "MODE"),
+        (xdrdef.nfs4_const.FATTR4_NO_TRUNC, "NO_TRUNC"),
+        (xdrdef.nfs4_const.FATTR4_NUMLINKS, "NUMLINKS"),
+        (xdrdef.nfs4_const.FATTR4_OWNER, "OWNER"),
+        (xdrdef.nfs4_const.FATTR4_OWNER_GROUP, "OWNER_GROUP"),
+        (xdrdef.nfs4_const.FATTR4_QUOTA_AVAIL_HARD, "QUOTA_AVAIL_HARD"),
+        (xdrdef.nfs4_const.FATTR4_QUOTA_AVAIL_SOFT, "QUOTA_AVAIL_SOFT"),
+        (xdrdef.nfs4_const.FATTR4_QUOTA_USED, "QUOTA_USED"),
+        (xdrdef.nfs4_const.FATTR4_RAWDEV, "RAWDEV"),
+        (xdrdef.nfs4_const.FATTR4_SPACE_AVAIL, "SPACE_AVAIL"),
+        (xdrdef.nfs4_const.FATTR4_SPACE_FREE, "SPACE_FREE"),
+        (xdrdef.nfs4_const.FATTR4_SPACE_TOTAL, "SPACE_TOTAL"),
+        (xdrdef.nfs4_const.FATTR4_SPACE_USED, "SPACE_USED"),
+        (xdrdef.nfs4_const.FATTR4_SYSTEM, "SYSTEM"),
+        (xdrdef.nfs4_const.FATTR4_TIME_ACCESS, "TIME_ACCESS"),
+        (xdrdef.nfs4_const.FATTR4_TIME_ACCESS_SET, "TIME_ACCESS_SET"),
+        (xdrdef.nfs4_const.FATTR4_TIME_BACKUP, "TIME_BACKUP"),
+        (xdrdef.nfs4_const.FATTR4_TIME_CREATE, "TIME_CREATE"),
+        (xdrdef.nfs4_const.FATTR4_TIME_DELTA, "TIME_DELTA"),
+        (xdrdef.nfs4_const.FATTR4_TIME_METADATA, "TIME_METADATA"),
+        (xdrdef.nfs4_const.FATTR4_TIME_MODIFY, "TIME_MODIFY"),
+        (xdrdef.nfs4_const.FATTR4_TIME_MODIFY_SET, "TIME_MODIFY_SET"),
+        (xdrdef.nfs4_const.FATTR4_MOUNTED_ON_FILEID, "MOUNTED_ON_FILEID"),
+        (xdrdef.nfs4_const.FATTR4_SUPPATTR_EXCLCREAT, "SUPPATTR_EXCLCREAT"),
+        (xdrdef.nfs4_const.FATTR4_SEC_LABEL, "SEC_LABEL"),
+        (xdrdef.nfs4_const.FATTR4_XATTR_SUPPORT, "XATTR_SUPPORT"),
+    ]
+    result = []
+    for bit, name in attrs:
+        if bitmap & (1 << bit):
+            result.append(name)
+    return ", ".join(result) if result else "(none)"
+
 class NFS4Error(Exception):
     def __init__(self, status, attrs=0, lock_denied=None, tag=None, check_msg=None):
         self.status = status
-- 
2.51.1