jmap,likely,tdb2: use CCAN_<MODNAME>_DEBUG instead of DEBUG.
[ccan] / ccan / likely / likely.h
index 815ee2287fd0566248075217d9e36b56b2b45009..0fad89c42bb80088f78116a8bfb054123c8ef355 100644 (file)
@@ -4,7 +4,7 @@
 #include <ccan/str/str.h>
 #include <stdbool.h>
 
-#ifndef DEBUG
+#ifndef CCAN_LIKELY_DEBUG
 #if HAVE_BUILTIN_EXPECT
 /**
  * likely - indicate that a condition is likely to be true.
  * 99%; marginal cases should not be marked either way.
  *
  * See Also:
- *     unlikely(), unlikely_func, likely_stats()
+ *     unlikely(), likely_stats()
  *
  * Example:
  *     // Returns false if we overflow.
  *     static inline bool inc_int(unsigned int *val)
  *     {
- *             *(val)++;
+ *             (*val)++;
  *             if (likely(*val))
  *                     return true;
  *             return false;
  * code path and optimize appropriately; see likely() above.
  *
  * See Also:
- *     likely(), unlikely_func, likely_stats()
+ *     likely(), likely_stats(), COLD (compiler.h)
  *
  * Example:
  *     // Prints a warning if we overflow.
  *     static inline void inc_int(unsigned int *val)
  *     {
- *             *(val)++;
+ *             (*val)++;
  *             if (unlikely(*val == 0))
  *                     fprintf(stderr, "Overflow!");
  *     }
@@ -55,7 +55,7 @@
 #define likely(cond) (!!(cond))
 #define unlikely(cond) (!!(cond))
 #endif
-#else /* DEBUG versions */
+#else /* CCAN_LIKELY_DEBUG versions */
 #define likely(cond) \
        (_likely_trace(!!(cond), 1, stringify(cond), __FILE__, __LINE__))
 #define unlikely(cond) \
@@ -66,39 +66,15 @@ long _likely_trace(bool cond, bool expect,
                   const char *file, unsigned int line);
 #endif
 
-#if HAVE_ATTRIBUTE_COLD
-/**
- * unlikely_func - indicate that a function is unlikely to be called.
- *
- * This uses a compiler extension where available to indicate an unlikely
- * code path and optimize appropriately; see unlikely() above.
- *
- * It is usually used on logging or error routines.
- *
- * See Also:
- *     unlikely()
- *
- * Example:
- *     void unlikely_func die_moaning(const char *reason)
- *     {
- *             fprintf(stderr, "Dying: %s\n", reason);
- *             exit(1);
- *     }
- */
-#define unlikely_func __attribute__((cold))
-#else
-#define unlikely_func
-#endif
-
-#ifdef DEBUG
+#ifdef CCAN_LIKELY_DEBUG
 /**
  * likely_stats - return description of abused likely()/unlikely()
  * @min_hits: minimum number of hits
  * @percent: maximum percentage correct
  *
- * When DEBUG is defined, likely() and unlikely() trace their results: this
- * causes a significant slowdown, but allows analysis of whether the stats
- * are correct (unlikely_func can't traced).
+ * When CCAN_LIKELY_DEBUG is defined, likely() and unlikely() trace their
+ * results: this causes a significant slowdown, but allows analysis of 
+ * whether the branches are labelled correctly.
  *
  * This function returns a malloc'ed description of the least-correct
  * usage of likely() or unlikely().  It ignores places which have been
@@ -114,7 +90,7 @@ long _likely_trace(bool cond, bool expect,
  *     // Print every place hit more than twice which was wrong > 5%.
  *     static void report_stats(void)
  *     {
- *     #ifdef DEBUG
+ *     #ifdef CCAN_LIKELY_DEBUG
  *             const char *bad;
  *
  *             while ((bad = likely_stats(2, 95)) != NULL) {
@@ -125,5 +101,5 @@ long _likely_trace(bool cond, bool expect,
  *     }
  */
 const char *likely_stats(unsigned int min_hits, unsigned int percent);
-#endif /* DEBUG */
+#endif /* CCAN_LIKELY_DEBUG */
 #endif /* CCAN_LIKELY_H */