xfs: rename diff_two_keys routines
authorFedor Pchelkin <pchelkin@ispras.ru>
Wed, 2 Jul 2025 09:39:28 +0000 (12:39 +0300)
committerCarlos Maiolino <cem@kernel.org>
Thu, 24 Jul 2025 15:30:13 +0000 (17:30 +0200)
One may think that diff_two_keys routines are used to compute the actual
difference between the arguments but they return a result of a
three-way-comparison of the passed operands. So it looks more appropriate
to denote them as cmp_two_keys.

Found by Linux Verification Center (linuxtesting.org).

Signed-off-by: Fedor Pchelkin <pchelkin@ispras.ru>
Reviewed-by: Darrick J. Wong <djwong@kernel.org>
Signed-off-by: Carlos Maiolino <cem@kernel.org>
fs/xfs/libxfs/xfs_alloc_btree.c
fs/xfs/libxfs/xfs_bmap_btree.c
fs/xfs/libxfs/xfs_btree.c
fs/xfs/libxfs/xfs_btree.h
fs/xfs/libxfs/xfs_ialloc_btree.c
fs/xfs/libxfs/xfs_refcount_btree.c
fs/xfs/libxfs/xfs_rmap_btree.c
fs/xfs/libxfs/xfs_rtrefcount_btree.c
fs/xfs/libxfs/xfs_rtrmap_btree.c
fs/xfs/scrub/rcbag_btree.c

index a4ac37b..42e4b81 100644 (file)
@@ -214,7 +214,7 @@ xfs_cntbt_key_diff(
 }
 
 STATIC int64_t
-xfs_bnobt_diff_two_keys(
+xfs_bnobt_cmp_two_keys(
        struct xfs_btree_cur            *cur,
        const union xfs_btree_key       *k1,
        const union xfs_btree_key       *k2,
@@ -227,7 +227,7 @@ xfs_bnobt_diff_two_keys(
 }
 
 STATIC int64_t
-xfs_cntbt_diff_two_keys(
+xfs_cntbt_cmp_two_keys(
        struct xfs_btree_cur            *cur,
        const union xfs_btree_key       *k1,
        const union xfs_btree_key       *k2,
@@ -440,7 +440,7 @@ const struct xfs_btree_ops xfs_bnobt_ops = {
        .init_ptr_from_cur      = xfs_allocbt_init_ptr_from_cur,
        .key_diff               = xfs_bnobt_key_diff,
        .buf_ops                = &xfs_bnobt_buf_ops,
-       .diff_two_keys          = xfs_bnobt_diff_two_keys,
+       .cmp_two_keys           = xfs_bnobt_cmp_two_keys,
        .keys_inorder           = xfs_bnobt_keys_inorder,
        .recs_inorder           = xfs_bnobt_recs_inorder,
        .keys_contiguous        = xfs_allocbt_keys_contiguous,
@@ -470,7 +470,7 @@ const struct xfs_btree_ops xfs_cntbt_ops = {
        .init_ptr_from_cur      = xfs_allocbt_init_ptr_from_cur,
        .key_diff               = xfs_cntbt_key_diff,
        .buf_ops                = &xfs_cntbt_buf_ops,
-       .diff_two_keys          = xfs_cntbt_diff_two_keys,
+       .cmp_two_keys           = xfs_cntbt_cmp_two_keys,
        .keys_inorder           = xfs_cntbt_keys_inorder,
        .recs_inorder           = xfs_cntbt_recs_inorder,
        .keys_contiguous        = NULL, /* not needed right now */
index 908d7b0..1cee9c2 100644 (file)
@@ -379,7 +379,7 @@ xfs_bmbt_key_diff(
 }
 
 STATIC int64_t
-xfs_bmbt_diff_two_keys(
+xfs_bmbt_cmp_two_keys(
        struct xfs_btree_cur            *cur,
        const union xfs_btree_key       *k1,
        const union xfs_btree_key       *k2,
@@ -648,7 +648,7 @@ const struct xfs_btree_ops xfs_bmbt_ops = {
        .init_high_key_from_rec = xfs_bmbt_init_high_key_from_rec,
        .init_rec_from_cur      = xfs_bmbt_init_rec_from_cur,
        .key_diff               = xfs_bmbt_key_diff,
-       .diff_two_keys          = xfs_bmbt_diff_two_keys,
+       .cmp_two_keys           = xfs_bmbt_cmp_two_keys,
        .buf_ops                = &xfs_bmbt_buf_ops,
        .keys_inorder           = xfs_bmbt_keys_inorder,
        .recs_inorder           = xfs_bmbt_recs_inorder,
index 299ce7f..c8164c1 100644 (file)
@@ -5058,7 +5058,7 @@ xfs_btree_simple_query_range(
        int                             error;
 
        ASSERT(cur->bc_ops->init_high_key_from_rec);
-       ASSERT(cur->bc_ops->diff_two_keys);
+       ASSERT(cur->bc_ops->cmp_two_keys);
 
        /*
         * Find the leftmost record.  The btree cursor must be set
index 355b304..1046bbf 100644 (file)
@@ -176,15 +176,15 @@ struct xfs_btree_ops {
                            const union xfs_btree_key *key);
 
        /*
-        * Difference between key2 and key1 -- positive if key1 > key2,
-        * negative if key1 < key2, and zero if equal.  If the @mask parameter
-        * is non NULL, each key field to be used in the comparison must
-        * contain a nonzero value.
+        * Compare key1 and key2 -- positive if key1 > key2, negative if
+        * key1 < key2, and zero if equal.  If the @mask parameter is non NULL,
+        * each key field to be used in the comparison must contain a nonzero
+        * value.
         */
-       int64_t (*diff_two_keys)(struct xfs_btree_cur *cur,
-                                const union xfs_btree_key *key1,
-                                const union xfs_btree_key *key2,
-                                const union xfs_btree_key *mask);
+       int64_t (*cmp_two_keys)(struct xfs_btree_cur *cur,
+                               const union xfs_btree_key *key1,
+                               const union xfs_btree_key *key2,
+                               const union xfs_btree_key *mask);
 
        const struct xfs_buf_ops        *buf_ops;
 
@@ -546,7 +546,7 @@ xfs_btree_keycmp_lt(
        const union xfs_btree_key       *key1,
        const union xfs_btree_key       *key2)
 {
-       return cur->bc_ops->diff_two_keys(cur, key1, key2, NULL) < 0;
+       return cur->bc_ops->cmp_two_keys(cur, key1, key2, NULL) < 0;
 }
 
 static inline bool
@@ -555,7 +555,7 @@ xfs_btree_keycmp_gt(
        const union xfs_btree_key       *key1,
        const union xfs_btree_key       *key2)
 {
-       return cur->bc_ops->diff_two_keys(cur, key1, key2, NULL) > 0;
+       return cur->bc_ops->cmp_two_keys(cur, key1, key2, NULL) > 0;
 }
 
 static inline bool
@@ -564,7 +564,7 @@ xfs_btree_keycmp_eq(
        const union xfs_btree_key       *key1,
        const union xfs_btree_key       *key2)
 {
-       return cur->bc_ops->diff_two_keys(cur, key1, key2, NULL) == 0;
+       return cur->bc_ops->cmp_two_keys(cur, key1, key2, NULL) == 0;
 }
 
 static inline bool
@@ -602,7 +602,7 @@ xfs_btree_masked_keycmp_lt(
        const union xfs_btree_key       *key2,
        const union xfs_btree_key       *mask)
 {
-       return cur->bc_ops->diff_two_keys(cur, key1, key2, mask) < 0;
+       return cur->bc_ops->cmp_two_keys(cur, key1, key2, mask) < 0;
 }
 
 static inline bool
@@ -612,7 +612,7 @@ xfs_btree_masked_keycmp_gt(
        const union xfs_btree_key       *key2,
        const union xfs_btree_key       *mask)
 {
-       return cur->bc_ops->diff_two_keys(cur, key1, key2, mask) > 0;
+       return cur->bc_ops->cmp_two_keys(cur, key1, key2, mask) > 0;
 }
 
 static inline bool
index 6f270d8..307734d 100644 (file)
@@ -275,7 +275,7 @@ xfs_inobt_key_diff(
 }
 
 STATIC int64_t
-xfs_inobt_diff_two_keys(
+xfs_inobt_cmp_two_keys(
        struct xfs_btree_cur            *cur,
        const union xfs_btree_key       *k1,
        const union xfs_btree_key       *k2,
@@ -432,7 +432,7 @@ const struct xfs_btree_ops xfs_inobt_ops = {
        .init_ptr_from_cur      = xfs_inobt_init_ptr_from_cur,
        .key_diff               = xfs_inobt_key_diff,
        .buf_ops                = &xfs_inobt_buf_ops,
-       .diff_two_keys          = xfs_inobt_diff_two_keys,
+       .cmp_two_keys           = xfs_inobt_cmp_two_keys,
        .keys_inorder           = xfs_inobt_keys_inorder,
        .recs_inorder           = xfs_inobt_recs_inorder,
        .keys_contiguous        = xfs_inobt_keys_contiguous,
@@ -462,7 +462,7 @@ const struct xfs_btree_ops xfs_finobt_ops = {
        .init_ptr_from_cur      = xfs_finobt_init_ptr_from_cur,
        .key_diff               = xfs_inobt_key_diff,
        .buf_ops                = &xfs_finobt_buf_ops,
-       .diff_two_keys          = xfs_inobt_diff_two_keys,
+       .cmp_two_keys           = xfs_inobt_cmp_two_keys,
        .keys_inorder           = xfs_inobt_keys_inorder,
        .recs_inorder           = xfs_inobt_recs_inorder,
        .keys_contiguous        = xfs_inobt_keys_contiguous,
index 54505fe..83f7758 100644 (file)
@@ -189,7 +189,7 @@ xfs_refcountbt_key_diff(
 }
 
 STATIC int64_t
-xfs_refcountbt_diff_two_keys(
+xfs_refcountbt_cmp_two_keys(
        struct xfs_btree_cur            *cur,
        const union xfs_btree_key       *k1,
        const union xfs_btree_key       *k2,
@@ -341,7 +341,7 @@ const struct xfs_btree_ops xfs_refcountbt_ops = {
        .init_ptr_from_cur      = xfs_refcountbt_init_ptr_from_cur,
        .key_diff               = xfs_refcountbt_key_diff,
        .buf_ops                = &xfs_refcountbt_buf_ops,
-       .diff_two_keys          = xfs_refcountbt_diff_two_keys,
+       .cmp_two_keys           = xfs_refcountbt_cmp_two_keys,
        .keys_inorder           = xfs_refcountbt_keys_inorder,
        .recs_inorder           = xfs_refcountbt_recs_inorder,
        .keys_contiguous        = xfs_refcountbt_keys_contiguous,
index 2cab694..77f5868 100644 (file)
@@ -274,7 +274,7 @@ xfs_rmapbt_key_diff(
 }
 
 STATIC int64_t
-xfs_rmapbt_diff_two_keys(
+xfs_rmapbt_cmp_two_keys(
        struct xfs_btree_cur            *cur,
        const union xfs_btree_key       *k1,
        const union xfs_btree_key       *k2,
@@ -517,7 +517,7 @@ const struct xfs_btree_ops xfs_rmapbt_ops = {
        .init_ptr_from_cur      = xfs_rmapbt_init_ptr_from_cur,
        .key_diff               = xfs_rmapbt_key_diff,
        .buf_ops                = &xfs_rmapbt_buf_ops,
-       .diff_two_keys          = xfs_rmapbt_diff_two_keys,
+       .cmp_two_keys           = xfs_rmapbt_cmp_two_keys,
        .keys_inorder           = xfs_rmapbt_keys_inorder,
        .recs_inorder           = xfs_rmapbt_recs_inorder,
        .keys_contiguous        = xfs_rmapbt_keys_contiguous,
@@ -634,7 +634,7 @@ const struct xfs_btree_ops xfs_rmapbt_mem_ops = {
        .init_ptr_from_cur      = xfbtree_init_ptr_from_cur,
        .key_diff               = xfs_rmapbt_key_diff,
        .buf_ops                = &xfs_rmapbt_mem_buf_ops,
-       .diff_two_keys          = xfs_rmapbt_diff_two_keys,
+       .cmp_two_keys           = xfs_rmapbt_cmp_two_keys,
        .keys_inorder           = xfs_rmapbt_keys_inorder,
        .recs_inorder           = xfs_rmapbt_recs_inorder,
        .keys_contiguous        = xfs_rmapbt_keys_contiguous,
index 3db5e7a..3ef2947 100644 (file)
@@ -171,7 +171,7 @@ xfs_rtrefcountbt_key_diff(
 }
 
 STATIC int64_t
-xfs_rtrefcountbt_diff_two_keys(
+xfs_rtrefcountbt_cmp_two_keys(
        struct xfs_btree_cur            *cur,
        const union xfs_btree_key       *k1,
        const union xfs_btree_key       *k2,
@@ -389,7 +389,7 @@ const struct xfs_btree_ops xfs_rtrefcountbt_ops = {
        .init_ptr_from_cur      = xfs_rtrefcountbt_init_ptr_from_cur,
        .key_diff               = xfs_rtrefcountbt_key_diff,
        .buf_ops                = &xfs_rtrefcountbt_buf_ops,
-       .diff_two_keys          = xfs_rtrefcountbt_diff_two_keys,
+       .cmp_two_keys           = xfs_rtrefcountbt_cmp_two_keys,
        .keys_inorder           = xfs_rtrefcountbt_keys_inorder,
        .recs_inorder           = xfs_rtrefcountbt_recs_inorder,
        .keys_contiguous        = xfs_rtrefcountbt_keys_contiguous,
index 9bdc2cb..6325502 100644 (file)
@@ -216,7 +216,7 @@ xfs_rtrmapbt_key_diff(
 }
 
 STATIC int64_t
-xfs_rtrmapbt_diff_two_keys(
+xfs_rtrmapbt_cmp_two_keys(
        struct xfs_btree_cur            *cur,
        const union xfs_btree_key       *k1,
        const union xfs_btree_key       *k2,
@@ -513,7 +513,7 @@ const struct xfs_btree_ops xfs_rtrmapbt_ops = {
        .init_ptr_from_cur      = xfs_rtrmapbt_init_ptr_from_cur,
        .key_diff               = xfs_rtrmapbt_key_diff,
        .buf_ops                = &xfs_rtrmapbt_buf_ops,
-       .diff_two_keys          = xfs_rtrmapbt_diff_two_keys,
+       .cmp_two_keys           = xfs_rtrmapbt_cmp_two_keys,
        .keys_inorder           = xfs_rtrmapbt_keys_inorder,
        .recs_inorder           = xfs_rtrmapbt_recs_inorder,
        .keys_contiguous        = xfs_rtrmapbt_keys_contiguous,
@@ -622,7 +622,7 @@ const struct xfs_btree_ops xfs_rtrmapbt_mem_ops = {
        .init_ptr_from_cur      = xfbtree_init_ptr_from_cur,
        .key_diff               = xfs_rtrmapbt_key_diff,
        .buf_ops                = &xfs_rtrmapbt_mem_buf_ops,
-       .diff_two_keys          = xfs_rtrmapbt_diff_two_keys,
+       .cmp_two_keys           = xfs_rtrmapbt_cmp_two_keys,
        .keys_inorder           = xfs_rtrmapbt_keys_inorder,
        .recs_inorder           = xfs_rtrmapbt_recs_inorder,
        .keys_contiguous        = xfs_rtrmapbt_keys_contiguous,
index 709356d..c3c7025 100644 (file)
@@ -69,7 +69,7 @@ rcbagbt_key_diff(
 }
 
 STATIC int64_t
-rcbagbt_diff_two_keys(
+rcbagbt_cmp_two_keys(
        struct xfs_btree_cur            *cur,
        const union xfs_btree_key       *k1,
        const union xfs_btree_key       *k2,
@@ -203,7 +203,7 @@ static const struct xfs_btree_ops rcbagbt_mem_ops = {
        .init_ptr_from_cur      = xfbtree_init_ptr_from_cur,
        .key_diff               = rcbagbt_key_diff,
        .buf_ops                = &rcbagbt_mem_buf_ops,
-       .diff_two_keys          = rcbagbt_diff_two_keys,
+       .cmp_two_keys           = rcbagbt_cmp_two_keys,
        .keys_inorder           = rcbagbt_keys_inorder,
        .recs_inorder           = rcbagbt_recs_inorder,
 };