LU-12610 cfs: add unlikely to CFS_ macros

[fs/lustre-release.git] / libcfs / include / libcfs / libcfs_fail.h

diff --git a/libcfs/include/libcfs/libcfs_fail.h b/libcfs/include/libcfs/libcfs_fail.h
index 9e57506..71b5900 100644 (file)
--- a/libcfs/include/libcfs/libcfs_fail.h
+++ b/libcfs/include/libcfs/libcfs_fail.h
@@ -43,16 +43,19 @@ int __cfs_fail_check_set(__u32 id, __u32 value, int set);
 int __cfs_fail_timeout_set(__u32 id, __u32 value, int ms, int set);
 
 enum {
-        CFS_FAIL_LOC_NOSET      = 0,
-        CFS_FAIL_LOC_ORSET      = 1,
-        CFS_FAIL_LOC_RESET      = 2,
-        CFS_FAIL_LOC_VALUE      = 3
+       CFS_FAIL_LOC_NOSET = 0,
+       CFS_FAIL_LOC_ORSET = 1,
+       CFS_FAIL_LOC_RESET = 2,
+       CFS_FAIL_LOC_VALUE = 3
 };
 
-/* Failure ranges
-       "0x0100 - 0x3fff" for Lustre
-       "0xe000 - 0xefff" for LNet
-       "0xf000 - 0xffff" for LNDs */
+/*
+ * Failure ranges:
+ *     "0x0100 - 0x3fff" for Lustre
+ *     "0xe000 - 0xefff" for LNet
+ *     "0xf000 - 0xffff" for LNDs
+ */
+
 /* Failure injection control */
 #define CFS_FAIL_MASK_SYS    0x0000FF00
 #define CFS_FAIL_MASK_LOC   (0x000000FF | CFS_FAIL_MASK_SYS)
@@ -81,6 +84,9 @@ static inline bool CFS_FAIL_PRECHECK(__u32 id)
               (cfs_fail_loc & id & CFS_FAULT));
 }
 
+#define UNLIKELY_CHECK_SET(id, value, set, quiet) \
+       (unlikely(cfs_fail_check_set(id, value, set, quiet)))
+
 static inline int cfs_fail_check_set(__u32 id, __u32 value, int set, int quiet)
 {
        unsigned long failed_once = cfs_fail_loc & CFS_FAILED; /* ok if racy */
@@ -100,66 +106,81 @@ static inline int cfs_fail_check_set(__u32 id, __u32 value, int set, int quiet)
        return ret;
 }
 
-/* If id hit cfs_fail_loc, return 1, otherwise return 0 */
+/*
+ *If id hit cfs_fail_loc, return 1, otherwise return 0
+ */
 #define CFS_FAIL_CHECK(id) \
-       cfs_fail_check_set(id, 0, CFS_FAIL_LOC_NOSET, 0)
+       UNLIKELY_CHECK_SET(id, 0, CFS_FAIL_LOC_NOSET, 0)
 #define CFS_FAIL_CHECK_QUIET(id) \
-       cfs_fail_check_set(id, 0, CFS_FAIL_LOC_NOSET, 1)
+       UNLIKELY_CHECK_SET(id, 0, CFS_FAIL_LOC_NOSET, 1)
 
-/* If id hit cfs_fail_loc and cfs_fail_val == (-1 or value) return 1,
- * otherwise return 0 */
+/*
+ * If id hit cfs_fail_loc and cfs_fail_val == (-1 or value) return 1,
+ * otherwise return 0
+ */
 #define CFS_FAIL_CHECK_VALUE(id, value) \
-       cfs_fail_check_set(id, value, CFS_FAIL_LOC_VALUE, 0)
+       UNLIKELY_CHECK_SET(id, value, CFS_FAIL_LOC_VALUE, 0)
 #define CFS_FAIL_CHECK_VALUE_QUIET(id, value) \
-       cfs_fail_check_set(id, value, CFS_FAIL_LOC_VALUE, 1)
+       UNLIKELY_CHECK_SET(id, value, CFS_FAIL_LOC_VALUE, 1)
 
-/* If id hit cfs_fail_loc, cfs_fail_loc |= value and return 1,
- * otherwise return 0 */
+/*
+ * If id hit cfs_fail_loc, cfs_fail_loc |= value and return 1,
+ * otherwise return 0
+ */
 #define CFS_FAIL_CHECK_ORSET(id, value) \
-       cfs_fail_check_set(id, value, CFS_FAIL_LOC_ORSET, 0)
+       UNLIKELY_CHECK_SET(id, value, CFS_FAIL_LOC_ORSET, 0)
 #define CFS_FAIL_CHECK_ORSET_QUIET(id, value) \
-       cfs_fail_check_set(id, value, CFS_FAIL_LOC_ORSET, 1)
+       UNLIKELY_CHECK_SET(id, value, CFS_FAIL_LOC_ORSET, 1)
 
-/* If id hit cfs_fail_loc, cfs_fail_loc = value and return 1,
- * otherwise return 0 */
+/*
+ * If id hit cfs_fail_loc, cfs_fail_loc = value and return 1,
+ * otherwise return 0
+ */
 #define CFS_FAIL_CHECK_RESET(id, value) \
-       cfs_fail_check_set(id, value, CFS_FAIL_LOC_RESET, 0)
+       UNLIKELY_CHECK_SET(id, value, CFS_FAIL_LOC_RESET, 0)
 #define CFS_FAIL_CHECK_RESET_QUIET(id, value) \
-       cfs_fail_check_set(id, value, CFS_FAIL_LOC_RESET, 1)
+       UNLIKELY_CHECK_SET(id, value, CFS_FAIL_LOC_RESET, 1)
+
+#define UNLIKELY_TIMEOUT_SET(id, value, ms, set) \
+       (unlikely(cfs_fail_timeout_set(id, value, ms, set)))
 
 static inline int cfs_fail_timeout_set(__u32 id, __u32 value, int ms, int set)
 {
-        if (unlikely(CFS_FAIL_PRECHECK(id)))
-                return __cfs_fail_timeout_set(id, value, ms, set);
-        else
-                return 0;
+       if (unlikely(CFS_FAIL_PRECHECK(id)))
+               return __cfs_fail_timeout_set(id, value, ms, set);
+       else
+               return 0;
 }
 
 /* If id hit cfs_fail_loc, sleep for seconds or milliseconds */
 #define CFS_FAIL_TIMEOUT(id, secs) \
-        cfs_fail_timeout_set(id, 0, (secs) * 1000, CFS_FAIL_LOC_NOSET)
+       UNLIKELY_TIMEOUT_SET(id, 0, (secs) * 1000, CFS_FAIL_LOC_NOSET)
 
 #define CFS_FAIL_TIMEOUT_MS(id, ms) \
-        cfs_fail_timeout_set(id, 0, ms, CFS_FAIL_LOC_NOSET)
+       UNLIKELY_TIMEOUT_SET(id, 0, ms, CFS_FAIL_LOC_NOSET)
 
-/* If id hit cfs_fail_loc, cfs_fail_loc |= value and
- * sleep seconds or milliseconds */
+/*
+ * If id hit cfs_fail_loc, cfs_fail_loc |= value and
+ * sleep seconds or milliseconds
+ */
 #define CFS_FAIL_TIMEOUT_ORSET(id, value, secs) \
-        cfs_fail_timeout_set(id, value, (secs) * 1000, CFS_FAIL_LOC_ORSET)
+       UNLIKELY_TIMEOUT_SET(id, value, (secs) * 1000, CFS_FAIL_LOC_ORSET)
 
 #define CFS_FAIL_TIMEOUT_RESET(id, value, secs) \
-       cfs_fail_timeout_set(id, value, secs * 1000, CFS_FAIL_LOC_RESET)
+       UNLIKELY_TIMEOUT_SET(id, value, secs * 1000, CFS_FAIL_LOC_RESET)
 
 #define CFS_FAIL_TIMEOUT_MS_ORSET(id, value, ms) \
-        cfs_fail_timeout_set(id, value, ms, CFS_FAIL_LOC_ORSET)
+       UNLIKELY_TIMEOUT_SET(id, value, ms, CFS_FAIL_LOC_ORSET)
 
 #define CFS_FAULT_CHECK(id)                    \
        CFS_FAIL_CHECK(CFS_FAULT | (id))
 
-/* The idea here is to synchronise two threads to force a race. The
+/*
+ * The idea here is to synchronise two threads to force a race. The
  * first thread that calls this with a matching fail_loc is put to
  * sleep. The next thread that calls with the same fail_loc wakes up
- * the first and continues. */
+ * the first and continues.
+ */
 static inline void cfs_race(__u32 id)
 {
        if (CFS_FAIL_PRECHECK(id)) {