add stdlib in brlib.h (unexplained error in __abs_choose_expr)

Makefile

@@ -51,12 +51,15 @@ CPPFLAGS  := -I $(INCDIR)
 CPPFLAGS  += -DDEBUG_DEBUG                                  # activate logs funcs
 CPPFLAGS  += -DDEBUG_POOL                                   # mem pools
 
+CPPFLAGS  += -DBUG_ON					    # bug_on in bug.h
+CPPFLAGS  += -DWARN_ON					    # warn_on in bug.h
+
 # remove extraneous spaces (due to spaces before comments)
 CPPFLAGS  := $(strip $(CPPFLAGS))
 
 ##################################### compiler flags
 CFLAGS    := -std=gnu11
-CFLAGS    += -O2
+CFLAGS    += -O3
 CFLAGS    += -g
 CFLAGS    += -Wall
 CFLAGS    += -Wextra
@@ -180,7 +183,7 @@ cleanobjdir:
 
 $(OBJDIR)/%.o: $(SRCDIR)/%.c | $(OBJDIR) $(DEPDIR)
 	@echo compiling $< "->" $@.
-	$(CC) -c $(DEPFLAGS) $(CPPFLAGS) $(CFLAGS) $< -o $@
+	@$(CC) -c $(DEPFLAGS) $(CPPFLAGS) $(CFLAGS) $< -o $@
 
 ##################################### brlib libraries
 .PHONY: cleanlib cleanlibdir
@@ -248,7 +251,7 @@ cleanccls:
 # maybe run cleanobj cleanlibobj in commands ?
 $(CCLSCMDS): cleanobj $(SRC) | $(CCLSROOT)
 	@echo "Generating ccls compile commands file ($@)."
-	@$(BEAR) -- make test
+	@$(BEAR) -- $(MAKE) test
 
 ##################################### valgrind (mem check)
 .PHONY: memcheck

README.org

@@ -7,16 +7,16 @@
 
 This work is, with exceptions below, Copyright (C) 2021-2024 Bruno Raoult
 ("br"), and licensed under the GNU General Public License v3.0 or later.
+
 Some rights reserved. See COPYING.
 
-*The licence exceptions are:**
+*** The licence exceptions are:*
-_Cutest testing framework.__
+
-You can find the original work on
+**** _Cutest testing framework.__
-[[https://sourceforge.net/projects/cutest/files/cutest/][sourceforge]].
+You can find the original work on [[https://sourceforge.net/projects/cutest/files/cutest/][sourceforge]].
 
 This software is (C) 2000-2003 Asim Jalis, under the zlib License.
-See [[test/cutest/license.txt][license local copy]] or
+See [[test/cutest/license.txt][license local copy]] or <https://spdx.org/licenses/Zlib.html>.
-<https://spdx.org/licenses/Zlib.html>.
 
 ** Installation:
 *** clone repository

include/bitops-emulated/generic-bswap.h

@@ -0,0 +1,38 @@
+/* generic-bswap.h - generic bswap implementations.
+ *
+ * Copyright (C) 2024 Bruno Raoult ("br")
+ * Licensed under the GNU General Public License v3.0 or later.
+ * Some rights reserved. See COPYING.
+ *
+ * You should have received a copy of the GNU General Public License along with this
+ * program. If not, see <https://www.gnu.org/licenses/gpl-3.0-standalone.html>.
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later <https://spdx.org/licenses/GPL-3.0-or-later.html>
+ *
+ */
+#ifndef _GENERIC_BSWAP_H_
+#define _GENERIC_BSWAP_H_
+
+#include "brlib.h"
+
+/* Adapted from: http://www-graphics.stanford.edu/%7Eseander/bithacks.html
+ */
+static __always_inline u32 __bswap32_emulated(u32 n)
+{
+   const u32 k = 0x00FF00FF;
+   n = ((n >>  8) & k) | ((n & k) <<  8);
+   n = ( n >> 16)      | ( n      << 16);
+   return n;
+}
+
+static __always_inline u64 __bswap64_emulated(u64 n)
+{
+   const u64 k1 = 0x00FF00FF00FF00FFull;
+   const u64 k2 = 0x0000FFFF0000FFFFull;
+   n = ((n >>  8) & k1) | ((n & k1) <<  8);
+   n = ((n >> 16) & k2) | ((n & k2) << 16);
+   n = ( n >> 32)       | ( n       << 32);
+   return n;
+}
+
+#endif  /* _GENERIC_BSWAP_H_ */

include/bitops-emulated/generic-clz.h

@@ -13,7 +13,7 @@
 #ifndef _GENERIC_CLZ_H_
 #define _GENERIC_CLZ_H_
 
-#include "br.h"
+#include "brlib.h"
 
 /* Adapted from: http://www-graphics.stanford.edu/%7Eseander/bithacks.html
  */

include/bitops-emulated/generic-ctz.h

@@ -13,7 +13,7 @@
 #ifndef _GENERIC_CTZ_H_
 #define _GENERIC_CTZ_H_
 
-#include "br.h"
+#include "brlib.h"
 
 /* Adapted from: http://www-graphics.stanford.edu/%7Eseander/bithacks.html
  */

include/bitops-emulated/generic-ilog2.h

@@ -13,7 +13,7 @@
 #ifndef _GENERIC_ILOG2_H_
 #define _GENERIC_ILOG2_H_
 
-#include "br.h"
+#include "brlib.h"
 
 /*
  * See https://stackoverflow.com/a/11398748/3079831

include/bitops.h

@@ -13,9 +13,10 @@
 #ifndef _BITS_H
 #define _BITS_H
 
-#include "br.h"
+#include "brlib.h"
 #include "bitops-emulated/generic-ctz.h"
 #include "bitops-emulated/generic-clz.h"
+#include "bitops-emulated/generic-bswap.h"
 
 #ifndef __has_builtin
 #define __has_builtin(x) 0
@@ -35,7 +36,9 @@
 #if __has_builtin(__builtin_ffs)
 #   define HAS_FFS
 #endif
-
+#if __has_builtin(__builtin_bswap32)
+#   define HAS_BSWAP
+#endif
 
 /**
  * print_bitops_impl() - print bitops implementation.
@@ -174,6 +177,24 @@ void print_bitops_impl(void);
 #define ffz32(n)  ffs32(~(n))
 #define ffz64(n)  ffs64(~(n))
 
+/**
+ * bswap32, bswap64 - reverse bytes: 0x01020304 -> 0x04030201
+ * @n: unsigned 32 or 64 bits integer.
+ *
+ * ffs(n) is similar to ctz(n) + 1, but returns 0 if n == 0 (except
+ * for ctz version, where ffs(0) is undefined).
+ * ffz(n) is ffz(~n), with undefine value if n = 0.
+ */
+#if defined(HAS_BSWAP)
+#   define __bswap32_native(n)  __builtin_bswap32(n)
+#   define __bswap64_native(n)  __builtin_bswap64(n)
+#   define bswap32(n) __bswap32_native(n)
+#   define bswap64(n) __bswap64_native(n)
+#else
+#   define bswap32(n) __bswap32_emulated(n)
+#   define bswap64(n) __bswap64_emulated(n)
+#endif
+
 /**
  * fls32, fls64 - return one plus MSB index: 00101000 -> 6
  * @n: unsigned 32 or 64 bits integer.

include/brlib.h

@@ -1,4 +1,4 @@
-/* br.h - misc macros.
+/* brlib.h - misc types/macros.
  *
  * Copyright (C) 2021-2024 Bruno Raoult ("br")
  * Licensed under the GNU General Public License v3.0 or later.
@@ -15,9 +15,10 @@
  * This header contains generic stuff.
  */
 
-#ifndef _BR_H
+#ifndef _BRLIB_H
-#define _BR_H
+#define _BRLIB_H
 
+#include <stdlib.h>
 #include <stdint.h>
 #include <stdbool.h>
 #include <bits/wordsize.h>                        /* defines __WORDSIZE: 32 or 64 */
@@ -267,4 +268,4 @@ typedef signed char schar;
 	({ signed type __x = (x); __x < 0 ? -__x : __x; }), other)
 
 
-#endif  /* _BR_H */
+#endif  /* _BRLIB_H */

include/bug.h

@@ -1,68 +1,56 @@
-/* SPDX-License-Identifier: GPL-2.0 */
+/* bug.h - bug_on/warn_on/warn functions.
-#ifndef _BR_BUG_H
+ *
-#define _BR_BUG_H
+ * Copyright (C) 2021-2024 Bruno Raoult ("br")
+ * Licensed under the GNU General Public License v3.0 or later.
+ * Some rights reserved. See COPYING.
+ *
+ * You should have received a copy of the GNU General Public License along with this
+ * program. If not, see <https://www.gnu.org/licenses/gpl-3.0-standalone.html>.
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later <https://spdx.org/licenses/GPL-3.0-or-later.html>
+ *
+ */
+
+#ifndef _BUG_H
+#define _BUG_H
 
 #include <stdio.h>
 #include <stdlib.h>
+#include <stdbool.h>
 #include <stdarg.h>
+
 #include "likely.h"
-#include "debug.h"
 
-/* BUG functions inspired by Linux kernel's <asm/bug.h>
+#ifdef BUG_ON
- */
+#define bug_on(expr) do {                                                      \
-
+        if (unlikely(expr)) {                                                  \
-#define panic() exit(0xff)
+            fprintf(stderr,                                                    \
-
+                    "** BUG IN %s[%s:%d]: assertion \"" #expr "\" failed.\n",  \
-/*
+                    __func__, __FILE__,__LINE__);                              \
- * Don't use BUG() or BUG_ON() unless there's really no way out; one
+            abort();                                                           \
- * example might be detecting data structure corruption in the middle
+        }                                                                      \
- * of an operation that can't be backed out of.  If the (sub)system
- * can somehow continue operating, perhaps with reduced functionality,
- * it's probably not BUG-worthy.
- *
- */
-#define BUG() do {                                                                      \
-        fprintf(stderr, "BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __func__); \
-        panic();                                                                        \
     } while (0)
+#else
+#define bug_on(expr) ({ 0; })
+#endif
 
-#define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while (0)
+#ifdef WARN_ON
+#define warn_on(expr) ({                                                       \
+        int _ret = !!(expr);                                                   \
+        if (unlikely(_ret))                                                    \
+            fprintf(stderr,                                                    \
+                    "** WARN ON %s[%s:%d]: assertion \"" #expr "\" failed.\n", \
+                    __func__, __FILE__,__LINE__);                              \
+         unlikely(_ret);                                                       \
+    })
+#else
+#define warn_on(expr) ({ 0; })
+#endif
+#define warn(expr, args...) ({                                                 \
+        int _ret = !!(expr);                                                   \
+        if (unlikely(_ret))                                                    \
+            fprintf(stderr, ##args);                                           \
+        unlikely(_ret);                                                        \
+    })
 
-/*
+#endif /* _BUG_H */
- * WARN(), WARN_ON(), WARN_ON_ONCE, and so on can be used to report significant
- * issues that need prompt attention if they should ever appear at runtime.
- *
- * Do not use these macros when checking for invalid external inputs
- * (e.g. invalid system call arguments, or invalid data coming from
- * network/devices), and on transient conditions like ENOMEM or EAGAIN.
- * These macros should be used for recoverable kernel issues only.
- * For invalid external inputs, transient conditions, etc use
- * pr_err[_once/_ratelimited]() followed by dump_stack(), if necessary.
- * Do not include "BUG"/"WARNING" in format strings manually to make these
- * conditions distinguishable from kernel issues.
- *
- * Use the versions with printk format strings to provide better diagnostics.
- */
-#define __WARN() do {                                                      \
-        fprintf(stderr, "WARNING: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __func__); \
-    } while (0)
-
-#define __WARN_printf(arg...) do {              \
-        vfprintf(stderr, arg);                  \
-    } while (0)
-
-#define WARN_ON(condition) ({                   \
-            int __ret_warn_on = !!(condition);  \
-            if (unlikely(__ret_warn_on))        \
-		__WARN();                       \
-            unlikely(__ret_warn_on);            \
-        })
-
-#define WARN(condition, format...) ({           \
-            int __ret_warn_on = !!(condition);  \
-            if (unlikely(__ret_warn_on))        \
-		__WARN_printf(format);          \
-            unlikely(__ret_warn_on);            \
-        })
-
-#endif /* _BR_BUG_H */

include/debug.h

@@ -17,7 +17,7 @@
 #include <stdio.h>
 #include <stdbool.h>
 
-#include <br.h>
+#include "brlib.h"
 
 #define NANOSEC  1000000000                       /* nano sec in sec */
 #define MILLISEC 1000000                          /* milli sec in sec */

include/hash.h

@@ -10,7 +10,7 @@
 
 #include <asm/bitsperlong.h>
 
-#include "br.h"
+#include "brlib.h"
 #include "bitops.h"
 
 /*

include/pjwhash-inline.h

@@ -14,7 +14,7 @@
 #ifndef _PJWHASH_INLINE_H
 #define _PJWHASH_INLINE_H
 
-#include "br.h"
+#include "brlib.h"
 
 #define THREE_QUARTERS ((int) ((BITS_PER_INT * 3) / 4))
 #define ONE_EIGHTH     ((int) (BITS_PER_INT / 8))

include/pjwhash.h

@@ -13,7 +13,7 @@
 #ifndef _PJWHASH_H
 #define _PJWHASH_H
 
-#include "br.h"
+#include "brlib.h"
 
 /**
  * unsigned int pjwhash - PJW hash function

include/plist.h

@@ -279,7 +279,7 @@ static inline int plist_node_empty(const struct plist_node *node)
 #ifdef CONFIG_DEBUG_PLIST
 # define plist_first_entry(head, type, member)          \
     ({                                                  \
-	WARN_ON(plist_head_empty(head));                \
+	warn_on(plist_head_empty(head));                \
 	container_of(plist_first(head), type, member);  \
     })
 #else
@@ -296,7 +296,7 @@ static inline int plist_node_empty(const struct plist_node *node)
 #ifdef CONFIG_DEBUG_PLIST
 # define plist_last_entry(head, type, member)           \
     ({                                                  \
-	WARN_ON(plist_head_empty(head));                \
+	warn_on(plist_head_empty(head));                \
 	container_of(plist_last(head), type, member);   \
     })
 #else

include/pool.h

@@ -17,7 +17,7 @@
 #include <stdint.h>
 #include <stddef.h>
 
-#include "br.h"
+#include "brlib.h"
 #include "list.h"
 
 #define POOL_NAME_LENGTH (16)                     /* max name length including trailing \0 */

src/list_sort.c

@@ -3,7 +3,7 @@
 /*
  * Taken from linux kernel: lib/list_sort.c
  */
-#include "br.h"
+#include "brlib.h"
 #include "list_sort.h"
 #include "list.h"
 #include "likely.h"

src/plist.c

@@ -32,7 +32,7 @@ static struct plist_head test_head;
 static void plist_check_prev_next(struct list_head *t, struct list_head *p,
 				  struct list_head *n)
 {
-    WARN(n->prev != p || p->next != n,
+    warn(n->prev != p || p->next != n,
          "top: %p, n: %p, p: %p\n"
          "prev: %p, n: %p, p: %p\n"
          "next: %p, n: %p, p: %p\n",
@@ -76,8 +76,8 @@ void plist_add(struct plist_node *node, struct plist_head *head)
     struct list_head *node_next = &head->node_list;
 
     plist_check_head(head);
-    WARN_ON(!plist_node_empty(node));
+    warn_on(!plist_node_empty(node));
-    WARN_ON(!list_empty(&node->prio_list));
+    warn_on(!list_empty(&node->prio_list));
 
     if (plist_head_empty(head))
         goto ins_node;
@@ -148,8 +148,8 @@ void plist_requeue(struct plist_node *node, struct plist_head *head)
     struct list_head *node_next = &head->node_list;
 
     plist_check_head(head);
-    BUG_ON(plist_head_empty(head));
+    bug_on(plist_head_empty(head));
-    BUG_ON(plist_node_empty(node));
+    bug_on(plist_node_empty(node));
 
     if (node == plist_last(head))
         return;

src/pool.c

@@ -17,7 +17,7 @@
 #include <stdlib.h>
 #include <errno.h>
 
-#include "br.h"
+#include "brlib.h"
 #include "list.h"
 #include "pool.h"
 #include "debug.h"

test/bitops-test.c

@@ -14,12 +14,13 @@
 #include <stdio.h>
 #include <stdlib.h>
 
-#include "br.h"
+#include "brlib.h"
 #include "bitops.h"
 #include "cutest/CuTest.h"
 
 static const struct test32_1 {
     u32 t32;                                      /* input */
+    u32 bswap;
     int popc;
     int ctz;
     int clz;
@@ -32,19 +33,19 @@ static const struct test32_1 {
         uchar bfe[32];
     };
 } test32_1[] = {
-    { 0x00000000,  0,  32, 32,  0, 1,  0,  0,     /* sometimes undefined */
+    { 0x00000000, 0x00000000, 0, 32, 32,  0, 1,  0,  0, /* sometimes undefined */
       { 0, { 0 } } },
-    { 0xffffffff, 32,   0,  0,  1, 0, 32, 31,
+    { 0xffffffff, 0xffffffff, 32,   0,  0,  1, 0, 32, 31,
       { 32, { 0,  1,  2,  3,  4,  5,  6,  7, 8,  9, 10, 11, 12, 13, 14, 15,
             16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31 } } },
-    { 0x00000001,  1,   0, 31,  1, 2,  1,  0,
+    { 0x00000001, 0x01000000,  1,   0, 31,  1, 2,  1,  0,
       { 1, { 0 } } },
-    { 0x80000000,  1,  31,  0, 32, 1, 32, 31,
+    { 0x80000000, 0x00000080,  1,  31,  0, 32, 1, 32, 31,
       { 1, { 31 } } },
-    { 0x71800718, 10,   3,  1,  4, 1, 31, 30,
+    { 0x71800718, 0x18078071, 10,   3,  1,  4, 1, 31, 30,
       /* 0111 0001 1000 0000 0000 0111 0001 1000 */
       { 10, { 3, 4, 8, 9, 10, 23, 24, 28, 29, 30 } } },
-    { 0x07eeeef7, 22,   0,  5,  1, 4, 27, 26,
+    { 0x07eeeef7, 0xf7eeee07, 22,   0,  5,  1, 4, 27, 26,
       /* 0000 0111 1110 1110 1110 1110 0111 1111*/
       { 22, { 0, 1, 2, 4, 5, 6, 7, 9, 10, 11, 13,
             14, 15, 17, 18, 19, 21, 22, 23, 24, 25, 26 } } },
@@ -52,7 +53,8 @@ static const struct test32_1 {
 
 static const struct test64_1 {
     u64 t64;                                      /* input */
-    int popc;
+    u64 bswap;
+    int popc;                                     /* some values may be undefined */
     int ctz;
     int clz;
     int ffs;
@@ -64,22 +66,22 @@ static const struct test64_1 {
         uchar bfe[64];
     };
 } test64_1[] = {
-    { 0x0000000000000000,  0, 64, 64,  0, 1,  0,  0, /* sometimes undefined */
+    { 0x0000000000000000, 0x0000000000000000,  0, 64, 64,  0, 1,  0,  0,
       { 0, { 0 } } },
-    { 0xffffffffffffffff, 64,  0,  0,  1, 0, 64, 63,
+    { 0xffffffffffffffff, 0xffffffffffffffff, 64,  0,  0,  1, 0, 64, 63,
       { 64, { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15,
             16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31,
             32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47,
             48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 } } },
-    { 0x0000000100000001,  2,  0, 31,  1, 2, 33, 32,
+    { 0x0000000100000001, 0x0100000001000000,  2,  0, 31,  1, 2, 33, 32,
       { 2, { 0, 32 } } },
-    { 0x8000000000000000,  1, 63,  0, 64, 1, 64, 63,
+    { 0x8000000000000000, 0x0000000000000080,  1, 63,  0, 64, 1, 64, 63,
       { 1, { 63 } } },
-    { 0x7180071871800718, 20,  3,  1,  4, 1, 63, 62,
+    { 0x7180071871800718, 0x1807807118078071, 20,  3,  1,  4, 1, 63, 62,
       /* 2 x 0111 0001 1000 0000 0000 0111 0001 1000 */
       { 20, { 3, 4, 8, 9, 10, 23, 24, 28, 29, 30,
             35, 36, 40, 41, 42, 55, 56, 60, 61, 62 } } },
-    { 0x07eeeef707eeeef7, 44,  0,  5,  1, 4, 59, 58 ,
+    { 0x07eeeef707eeeef7, 0xf7eeee07f7eeee07, 44,  0,  5,  1, 4, 59, 58 ,
       /* 2 x 0000 0111 1110 1110 1110 1110 0111 1111*/
       { 44, { 0, 1, 2, 4, 5, 6, 7, 9, 10, 11, 13,
             14, 15, 17, 18, 19, 21, 22, 23, 24, 25, 26,
@@ -167,6 +169,20 @@ static void cutest_fls(CuTest *tc)
     }
 }
 
+static void cutest_bswap(CuTest *tc)
+{
+    for (uint i = 0; i < ARRAY_SIZE(test32_1); ++i) {
+        int res = bswap32(test32_1[i].t32);
+        //printf("fls32 t=%#x r=%d e=%d\n", test32_1[i].t32, res, test32_1[i].fls);
+        CuAssertIntEquals(tc, test32_1[i].bswap, res);
+    }
+    for (uint i = 0; i < ARRAY_SIZE(test64_1); ++i) {
+        int res = bswap64(test64_1[i].t64);
+        //printf("fls64 t=%#llx r=%d e=%d\n", test64_1[i].t64, res, test64_1[i].fls);
+        CuAssertIntEquals(tc, test64_1[i].bswap, res);
+    }
+}
+
 static void cutest_ilog(CuTest *tc)
 {
     for (uint i = 0; i < ARRAY_SIZE(test32_1); ++i) {
@@ -322,6 +338,7 @@ static CuSuite *bitops_GetSuite()
     SUITE_ADD_TEST(suite, cutest_fls);
     SUITE_ADD_TEST(suite, cutest_ilog);
     SUITE_ADD_TEST(suite, cutest_bfe);
+    SUITE_ADD_TEST(suite, cutest_bswap);
 
     SUITE_ADD_TEST(suite, cutest_rol);
     SUITE_ADD_TEST(suite, cutest_ror);

test/pool-test.c

@@ -1,7 +1,7 @@
 #include <stdio.h>
 #include <stdlib.h>
 
-#include "br.h"
+#include "brlib.h"
 #include "pool.h"
 #include "debug.h"