re-arrange Makefile, and cleanup Emacs/ccls part

.dir-locals.el.wrong

@@ -1,3 +0,0 @@
-((nil .
-      ((projectile-project-root-functions . 'projectile-root-local)
-       )))

.gitignore

@@ -1,7 +1,11 @@
 compile_commands.json
 core
+/.ccls-cache/
+/test/test/
+/test/cutest/
+/tmp/
 # created when building
 /bin/
 /obj/
 /dep/
-/lib/
+/lib/

Makefile

@@ -1,6 +1,6 @@
 # brlib Makefile - GNU make only
 #
-# Copyright (C) 2021-2023 Bruno Raoult ("br")
+# Copyright (C) 2021-2024 Bruno Raoult ("br")
 # Licensed under the GNU General Public License v3.0 or later.
 # Some rights reserved. See COPYING.
 #
@@ -38,20 +38,14 @@ DLIB      := $(addsuffix .so, $(LIBDIR)/lib$(LIB))          # dynamic lib
 DEP_FN    := $(SRC_FN) $(LIBSRC_FN)
 DEP       := $(addprefix $(DEPDIR)/,$(DEP_FN:.c=.d))
 
-TESTSRC   := $(wildcard $(TESTDIR)/*.c)
+TEST      := $(wildcard $(TESTDIR)/*.c)
-TEST_FN   := $(notdir $(TESTSRC))
+TEST_FN   := $(notdir $(TEST))
 BIN       := $(addprefix $(BINDIR)/,$(TEST_FN:.c=))
 
-##################################### emacs projectile/ccls dirs & files
-PRJROOT   := .projectile
-EMACSLSP  := .dir-locals.el
-
-CCLSROOT  := .ccls-root
-CCLSFILE  := .ccls
 CCLSCMDS  := compile_commands.json
 
 ##################################### pre-processor flags
-CPPFLAGS  := -I$(INCDIR)
+CPPFLAGS  := -I $(INCDIR)
 #CPPFLAGS  += -DDEBUG                                       # global
 #CPPFLAGS  += -DDEBUG_DEBUG_C                               # log() funcs debug
 CPPFLAGS  += -DDEBUG_DEBUG                                  # activate logs funcs
@@ -80,27 +74,34 @@ CFLAGS    := $(strip $(CFLAGS))
 ##################################### archiver/linker/dependency flags
 ARFLAGS   := rcs
 LDFLAGS   := -L$(LIBDIR)
+LIBS      := -l$(LIB)
 DEPFLAGS   = -MMD -MP -MF $(DEPDIR)/$*.d
 
 ##################################### General targets
-.PHONY: all compile clean cleanall cleanallall
+.PHONY: all libs compile test emacs ccls bear clean cleanall cleanallall
 
+# default: build libraries
 all: libs
 
-compile: objs
+# default: build libraries
+libs: $(DLIB) $(SLIB)
 
-test: testbins
+# build objects
+compile: $(OBJ)
 
-clean: cleandep cleanobj cleanlib cleanbin
+# build test binaries
-
+test: $(BIN)
-cleanall: clean cleandepdir cleanobjdir cleanlibdir cleanbindir
-
-cleanallall: cleanall cleanemacs
 
 # setup emacs projectile/ccls
-emacs: emacs-setup
+emacs: $(PRJROOT) $(EMACSLSP)
+
 # update compile-commands.json
-ccls: $(CCLSCMDS)
+ccls bear: $(CCLSCMDS)
+
+# cleanup - need to think about a better system :-)
+clean: cleandep cleanobj cleanlib cleanbin
+cleanall: clean cleandepdir cleanobjdir cleanlibdir cleanbindir
+cleanallall: cleanall cleanemacs
 
 ##################################### cleaning functions
 # rmfiles - deletes a list of files in a directory if they exist.
@@ -169,9 +170,7 @@ cleandepdir:
 	@#[ -d $(DEPDIR) ] && echo cleaning depend files && $(RM) -f $(DEP) || true
 
 ##################################### objects
-.PHONY: objs cleanobj cleanobjdir
+.PHONY: cleanobj cleanobjdir
-
-objs: $(OBJ)
 
 cleanobj:
 	$(call rmfiles,$(OBJ),brlib object)
@@ -184,9 +183,7 @@ $(OBJDIR)/%.o: $(SRCDIR)/%.c | $(OBJDIR) $(DEPDIR)
 	$(CC) -c $(DEPFLAGS) $(CPPFLAGS) $(CFLAGS) $< -o $@
 
 ##################################### brlib libraries
-.PHONY: libs cleanlib cleanlibdir
+.PHONY: cleanlib cleanlibdir
-
-libs: $(DLIB) $(SLIB)
 
 cleanlib:
 	$(call rmfiles,$(DLIB) $(SLIB),library)
@@ -204,18 +201,18 @@ $(SLIB): $(OBJ) | $(LIBDIR)
 	@echo "building static library ($@)."
 	@$(AR) $(ARFLAGS) $@ $? > /dev/null
 
-##################################### tests
+##################################### testing
-.PHONY: testbins cleanbin cleanbindir
+.PHONY: cleanbin cleanbindir
-
-testbins: $(BIN)
-	echo $^
 
 cleanbin:
-	$(call rmfiles,$(TARGET),binary)
+	$(call rmfiles,$(BIN),binary)
 
 cleanbindir:
 	$(call rmdir,$(BINDIR),binaries)
 
+$(BINDIR)/%: $(TESTDIR)/%.c libs | $(BINDIR)
+	$(CC) $(CPPFLAGS) $(CFLAGS) $< $(LDFLAGS) $(LIBS) -o $@
+
 ##################################### pre-processed (.i) and assembler (.s) output
 %.i: %.c
 	@echo generating $@
@@ -225,32 +222,22 @@ cleanbindir:
 	@echo generating $@
 	@$(CC) -S -fverbose-asm $(CPPFLAGS) $(CFLAGS) $< -o $@
 
-##################################### Emacs
+##################################### Emacs & LSP (ccls)
-.PHONY: emacs-setup cleanemacs
+.PHONY: cleanemacs cleanccls
 
-emacs-setup: $(PRJROOT) $(EMACSLSP)
+#EMACSLSP   := .dir-locals.el
+CCLSFILES  := .projectile .ccls .ccls-root
+CCLSCACHE  := .ccls-cache
 
 cleanemacs:
-	$(call rmfiles, $(PRJROOT) $(EMACSLSP), Emacs);
+	$(call rmfiles, $(PRJROOT) $(EMACSLSP), Emacs/ccls);
 
-$(PRJROOT) $(EMACSLSP):
+$(CCLSFILES):
-	@if [[ $(@) = $(PRJROOT) ]] ;                           \
+	printf "creating Emacs dot-files.\n"
-	then                                                    \
-		echo "creating Emacs's projectile root file." ; \
-	else                                                    \
-		echo "creating Emacs's ccls root file." ;       \
-	fi
 	@$(TOUCH) $@
 
-##################################### LSP (ccls)
-.PHONY: cleanccls
-
 cleanccls:
-	$(call rmfiles, $(CCLSROOT), ccls);
+	$(call rmfiles, $(CCLSFILES), ccls);
-
-$(CCLSROOT):
-	echo "creating ccls root file."
-	@$(TOUCH) $@
 
 # generate compile_commands.json.
 # TODO: add includes and Makefile dependencies.
@@ -259,11 +246,7 @@ $(CCLSROOT):
 # maybe run cleanobj cleanlibobj in commands ?
 $(CCLSCMDS): cleanobj $(SRC) | $(CCLSROOT)
 	@echo "Generating ccls compile commands file ($@)."
-	@$(BEAR) -- make compile
+	@$(BEAR) -- make test
-
-#.PHONY: bear
-#bear: cleanobj cleanlibobj Makefile | $(CCLSROOT)
-#    @$(BEAR) -- make compile
 
 ##################################### valgrind (mem check)
 .PHONY: memcheck

include/bitops-emulated/generic-clz.h

@@ -0,0 +1,45 @@
+/* generic-clz.h - generic clz 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_CLZ_H_
+#define _GENERIC_CLZ_H_
+
+#include "br.h"
+
+/* Adapted from: http://www-graphics.stanford.edu/%7Eseander/bithacks.html
+ */
+static __always_inline int __clz32_emulated(u32 n)
+{
+    uint r, q;
+
+    r  = (n > 0xFFFF) << 4; n >>= r;
+    q  = (n > 0xFF  ) << 3; n >>= q; r |= q;
+    q  = (n > 0xF   ) << 2; n >>= q; r |= q;
+    q  = (n > 0x3   ) << 1; n >>= q; r |= q;
+    r |= (n >> 1);
+    return 31 - r;
+}
+
+static __always_inline int __clz64_emulated(u64 n)
+{
+    uint r, q;
+
+    r = (n > 0xFFFFFFFF) << 5; n >>= r;
+    q = (n > 0xFFFF)     << 4; n >>= q; r |= q;
+    q = (n > 0xFF  )     << 3; n >>= q; r |= q;
+    q = (n > 0xF   )     << 2; n >>= q; r |= q;
+    q = (n > 0x3   )     << 1; n >>= q; r |= q;
+    r |= (n >> 1);
+    return 63 - r;
+}
+
+#endif  /* _GENERIC_CLZ_H_ */

include/bitops-emulated/generic-ctz.h

@@ -0,0 +1,130 @@
+/* generic-ctz.h - generic ctz 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_CTZ_H_
+#define _GENERIC_CTZ_H_
+
+#include "br.h"
+
+/* Adapted from: http://www-graphics.stanford.edu/%7Eseander/bithacks.html
+ */
+static __always_inline int __ctz32_emulated(u32 n)
+{
+    int r = 0;
+    if (!(n & 0xffff)) {
+        n >>= 16;
+        r += 16;
+    }
+    if (!(n & 0xff)) {
+        n >>= 8;
+        r += 8;
+    }
+    if (!(n & 0xf)) {
+        n >>= 4;
+        r += 4;
+    }
+    if (!(n & 3)) {
+        n >>= 2;
+        r += 2;
+    }
+    if (!(n & 1)) {
+        n >>= 1;
+        r += 1;
+    }
+    return r;
+}
+
+#define __ctz32_emulated2(n) ({   \
+    int r = 0;                    \
+    if (!(n & 0xffff)) {          \
+        n >>= 16;                 \
+        r += 16;                  \
+    }                             \
+    if (!(n & 0xff)) {            \
+        n >>= 8;                  \
+        r += 8;                   \
+    }                             \
+    if (!(n & 0xf)) {             \
+        n >>= 4;                  \
+        r += 4;                   \
+    }                             \
+    if (!(n & 3)) {               \
+        n >>= 2;                  \
+        r += 2;                   \
+    }                             \
+    if (!(n & 1)) {               \
+        n >>= 1;                  \
+        r += 1;                   \
+    }                             \
+    r;                            \
+})
+
+static __always_inline int __ctz64_emulated(u64 n)
+{
+    int r = 0;                                    /* !!!!!!!!!!!!!!!!!!!!!!!! */
+    if (!(n & 0xffffffff)) {
+        n >>= 32;
+        r += 32;
+    }
+    if (!(n & 0xffff)) {
+        n >>= 16;
+        r += 16;
+    }
+    if (!(n & 0xff)) {
+        n >>= 8;
+        r += 8;
+    }
+    if (!(n & 0xf)) {
+        n >>= 4;
+        r += 4;
+    }
+    if (!(n & 3)) {
+        n >>= 2;
+        r += 2;
+    }
+    if (!(n & 1)) {
+        n >>= 1;
+        r += 1;
+    }
+    return r;
+}
+
+#define __ctz64_emulated2(n) ({   \
+    int r = 0;                  \
+    if (!(n & 0xffffffff)) {      \
+        n >>= 32;                 \
+        r += 32;                  \
+    }                             \
+    if (!(n & 0xffff)) {          \
+        n >>= 16;                 \
+        r += 16;                  \
+    }                             \
+    if (!(n & 0xff)) {            \
+        n >>= 8;                  \
+        r += 8;                   \
+    }                             \
+    if (!(n & 0xf)) {             \
+        n >>= 4;                  \
+        r += 4;                   \
+    }                             \
+    if (!(n & 3)) {               \
+        n >>= 2;                  \
+        r += 2;                   \
+    }                             \
+    if (!(n & 1)) {               \
+        n >>= 1;                  \
+        r += 1;                   \
+    }                             \
+    r;                            \
+})
+
+#endif  /* _GENERIC_CTZ_H_ */

include/bitops.h

@@ -0,0 +1,260 @@
+/* bitops.h - bits functions.
+ *
+ * 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 _BITS_H
+#define _BITS_H
+
+#include "br.h"
+#include "bitops-emulated/generic-ctz.h"
+#include "bitops-emulated/generic-clz.h"
+
+/* determine which native builtins are available
+ */
+#if __has_builtin(__builtin_popcount)
+#   define HAS_POPCOUNT
+#endif
+#if __has_builtin(__builtin_ctz)
+#   define HAS_CTZ
+#endif
+#if __has_builtin(__builtin_clz)
+#   define HAS_CLZ
+#endif
+#if __has_builtin(__builtin_ffs)
+#   define HAS_FFS
+#endif
+
+
+/**
+ * print_bitops_impl() - print bitops implementation.
+ *
+ * For basic bitops (popcount, ctz, etc...), print the implementation
+ * (builtin, emulated, ...).
+ */
+void print_bitops_impl(void);
+
+#ifndef __has_builtin
+#define __has_builtin(x) 0
+#endif
+
+/* no plan to support 32bits for now...
+ * #if __WORDSIZE != 64
+ * #error "Only 64 bits word size supported."
+ * #endif
+ */
+
+/**
+ * lsb, msb: least/most significant bit: 10101000
+ *                               msb = 7 ^   ^ lsb = 3
+ *
+ */
+#define lsb64(x) (ctz64(x))
+#define lsb32(x) (ctz32(x))
+#define msb64(x) (63 ^ clz64(x))
+#define msb32(x) (31 ^ clz32(x))
+
+/**
+ * popcount32, popcout64 - count set bits:  10101000 -> 3
+ * @num: unsigned 32 or 64 bits integer.
+ *
+ */
+#if defined(HAS_POPCOUNT)
+#   define __popcount32_native(n) __builtin_popcount(n)
+#   define __popcount64_native(n) __builtin_popcountll(n)
+
+#   define popcount64(n) __popcount64_native(n)
+#   define popcount32(n) __popcount32_native(n)
+
+/* see ctz section below */
+#   define __ctz32_popcount(n) (popcount(n & -n) - 1)
+#   define __ctz64_popcount(n) (popcountll(n & -n) - 1)
+
+/* see ffs section below */
+#   define __ffs32_popcount(n) (__builtin_popcount((n) ^ ~-(n)))
+#   define __ffs64_popcount(n) (__builtin_popcountll((n) ^ ~-(n)))
+
+#endif
+/* Brian Kernighan's algorithm - pretty efficient for likely sparse values
+ */
+#define __popcount_emulated(n)  ({      \
+    int ___count = 0;                   \
+    while (n) {                         \
+        ___count++;                     \
+        n &= (n - 1);                   \
+    }                                   \
+    ___count; })
+#if !defined(popcount32)
+#   define popcount32(n) __popcount_emulated(n)
+#endif
+#if !defined(popcount64)
+#   define popcount64(n) __popcount_emulated(n)
+#endif
+
+/**
+ * ctz32, ctz64 - count trailing zeros: 00101000 -> 3
+ * @num: unsigned 32 or 64 bits integer.
+ *
+ * Not defined if no bit set, so check for non-zero before calling this.
+ * This is similat the FFS (First Find Set), which has FFS(0) = 0.
+ */
+#if defined(HAS_CTZ)
+#   define __ctz32_native(n)  __builtin_ctz(n)
+#   define __ctz64_native(n)  __builtin_ctzll(n)
+#   define ctz32(n) __ctz32_native(n)
+#   define ctz64(n) __ctz64_native(n)
+
+/* see ffs section below */
+#   define __ffs32_ctz(n) ({ n? __builtin_ctz(n) + 1: 0; })
+#   define __ffs64_ctz(n) ({ n? __builtin_ctzll(n) + 1: 0; })
+#endif
+#if !defined(ctz32) && defined(__ctz32_popcount)
+#   define ctz32(n) __ctz32_popcount(n)
+#   define ctz64(n) __ctz64_popcount(n)
+#endif
+#if !defined(ctz32)
+#   define ctz32(n) __ctz32_emulated(n)
+#   define ctz64(n) __ctz64_emulated(n)
+#endif
+
+/**
+ * clz32, clz64 - count leading zeros: 00101000 -> 2
+ *
+ * @num: unsigned 32 or 64 bits integer.
+ *
+ * Not defined if no bit set, so check for non-zero before calling this.
+ */
+#if defined (HAS_CLZ)
+#   define __clz32_native(n)  __builtin_clz(n)
+#   define __clz64_native(n)  __builtin_clzll(n)
+#   define clz32(n) __clz32_native(n)
+#   define clz64(n) __clz64_native(n)
+#endif
+#if !defined(clz32)
+#   define clz32(n) __clz32_emulated(n)
+#   define clz64(n) __clz64_emulated(n)
+#endif
+
+/**
+ * ffs32, ffs64 - find first bit set, indexed from 0: 00101000 -> 4
+ * ffz32, ffz64 - find first bit unset, indexed from 0: 00101000 -> 0
+ * @num: 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_FFS)
+#   define __ffs32_native(n)  __builtin_ffs(n)
+#   define __ffs64_native(n)  __builtin_ffsll(n)
+#   define ffs32(n) __ffs32_native(n)
+#   define ffs64(n) __ffs64_native(n)
+#endif
+#define __ffs32_emulated(n) (popcount32((n) ^ ~-(n)))
+#define __ffs64_emulated(n) (popcount64((n) ^ ~-(n)))
+#if !defined(ffs32) && defined(__ffs32_popcount)
+#   define ffs32(n) __ffs32_popcount(n)
+#   define ffs64(n) __ffs64_popcount(n)
+#endif
+#if !defined(ffs32) && defined(__ffs32_ctz)
+#   define ffs32(n) __ffs32_ctz(n)
+#   define ffs64(n) __ffs64_ctzll(n)
+#endif
+#if !defined(ffs32)
+#   define ffs32(n) __ffs32_emulated(n)
+#   define ffs64(n) __ffs64_emulated(n)
+#endif
+#define ffz32(n)  ffs32(~(n))
+#define ffz64(n)  ffs64(~(n))
+
+/**
+ * fls32, fls64 - return one plus MSB index: 00101000 -> 6
+ * @num: unsigned 32 or 64 bits integer.
+ *
+ * Similar to nbits(n) - clz(n), but returns 0 if n == 0;
+ */
+#define fls32(n) ((n)? 32 - clz32(n): 0)
+#define fls64(n) ((n)? 64 - clz64(n): 0)
+
+/* rolXX/rorXX are taken from kernel's <linux/bitops.h> are are:
+ * SPDX-License-Identifier: GPL-2.0
+ */
+/**
+ * rol8, rol16, rol32, rol64 - rotate left
+ * @num: unsigned 8, 16, 32 or 64 bits integer
+ * @n: bits to roll
+ */
+#define rol8(num, n)  ((num << (n &  7)) | (num >> ((-n) &  7)))
+#define rol16(num, n) ((num << (n & 15)) | (num >> ((-n) & 15)))
+#define rol32(num, n) ((num << (n & 31)) | (num >> ((-n) & 31)))
+#define rol64(num, n) ((num << (n & 63)) | (num >> ((-n) & 63)))
+
+/**
+ * ror8, ror16, ror32, ror64 - rotate right
+ * @num: unsigned 8, 16, 32 or 64 bits integer
+ * @n: bits to roll
+ */
+#define ror8(num, n)  ((num >> (n &  7)) | (num << ((-n) &  7)))
+#define ror16(num, n) ((num >> (n & 15)) | (num << ((-n) & 15)))
+#define ror32(num, n) ((num >> (n & 31)) | (num << ((-n) & 31)))
+#define ror64(num, n) ((num >> (n & 63)) | (num << ((-n) & 63)))
+
+/**
+ * ilog2 - log base 2
+ * @n: unsigned 32 or 64 bits integer.
+ */
+#define ilog2_32(n) (fls32(n) - 1)
+#define ilog2_64(n) (fls64(n) - 1)
+
+/**
+ * is_pow2() - check if number is a power of two
+ * @n: the value to check
+ *
+ * Zero is *not* considered a power of two.
+ */
+#define is_pow2(n) (n != 0 && (((n) & ((n) - 1)) == 0))
+
+/**
+ * bit_for_eachXX - iterate over an integer bits (0-indexed)
+ * bit_for_eachXX_ffs - iterate over an integer bits (1-indexed)
+ * @pos:  int used as current bit
+ * @tmp:  temp u64/u32 used as temporary storage
+ * @ul:   u32/u64 to loop over
+ *
+ * Bits are 0-indexed from 0 with bit_for_each, and 1-indexed with
+ * bits_for_each_ffs.
+ *
+ * Example:
+ * u64 u=139, _t;           // u=b10001011
+ * int cur;
+ * bit_for_each64(cur, _t, u) {
+ *     printf("%d\n", cur);
+ * }
+ * This will display the position of each bit set in ul: 0, 1, 3, 7
+ *
+ */
+#define bit_for_each32(pos, tmp, ul)                 \
+    for (tmp = ul, pos = ctz32(tmp);                 \
+         tmp;                                        \
+         tmp ^= 1U << pos, pos = ctz32(tmp))
+#define bit_for_each64(pos, tmp, ul)                 \
+    for (tmp = ul, pos = ctz64(tmp);                 \
+         tmp;                                        \
+         tmp ^= 1UL << pos, pos = ctz64(tmp))
+#define bit_for_each64_ffs(pos, tmp, ul)             \
+    for (tmp = ul, pos = ffs64(tmp);                 \
+         tmp;                                        \
+         tmp &= (tmp - 1),  pos = ffs64(tmp))
+#define bit_for_each32_ffs(pos, tmp, ul)             \
+    for (tmp = ul, pos = ffs32(tmp);                 \
+         tmp;                                        \
+         tmp &= (tmp - 1),  pos = ffs32(tmp))
+
+#endif  /* _BITS_H */

include/bits.h

@@ -1,471 +0,0 @@
-/* bits.h - bits functions.
- *
- * Copyright (C) 2021-2022 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 _BITS_H
-#define _BITS_H
-
-#include "br.h"
-
-/**
- * print_bitops_impl() - print bitops implementation.
- *
- * For basic bitops (popcount, ctz, etc...), print the implementation
- * (builtin, emulated, ...).
- */
-void print_bitops_impl(void);
-
-#ifndef __has_builtin
-#define __has_builtin(x) 0
-#endif
-
-/* no plan to support 32bits for now...
- * #if __WORDSIZE != 64
- * #error "Only 64 bits word size supported."
- * #endif
- */
-
-/*  lsb, msb: least/most significant bit: 10101000
- *                                msb = 7 ^   ^ lsb = 3
- */
-#define lsb64(x) (ctz64(x))
-#define lsb32(x) (ctz32(x))
-#define msb64(x) (63 ^ clz64(x))
-#define msb32(x) (31 ^ clz32(x))
-
-/* count set bits:  10101000 -> 3
- *                  ^ ^ ^
- */
-static __always_inline int popcount64(u64 n)
-{
-#   if __has_builtin(__builtin_popcountll)
-    return __builtin_popcountll(n);
-
-#   else
-    int count = 0;
-    while (n) {
-        count++;
-        n &= (n - 1);
-    }
-    return count;
-#   endif
-}
-
-static __always_inline int popcount32(u32 n)
-{
-#   if __has_builtin(__builtin_popcount)
-    return __builtin_popcount(n);
-
-#   else
-    int count = 0;
-    while (n) {
-        count++;
-        n &= (n - 1);
-    }
-    return count;
-#   endif
-}
-
-/* count trailing zeroes : 00101000 -> 3
- *                              ^^^
- */
-static __always_inline int ctz64(u64 n)
-{
-#   if __has_builtin(__builtin_ctzll)
-    return __builtin_ctzll(n);
-
-#   elif __has_builtin(__builtin_clzll)
-    return __WORDSIZE - (__builtin_clzll(n & -n) + 1);
-
-#   else
-    return popcount64((n & -n) - 1);
-#   endif
-}
-
-static __always_inline int ctz32(u32 n)
-{
-#   if __has_builtin(__builtin_ctz)
-    return __builtin_ctz(n);
-
-#   elif __has_builtin(__builtin_clz)
-    return __WORDSIZE - (__builtin_clz(n & -n) + 1);
-
-#   else
-    return popcount32((n & -n) - 1);
-#   endif
-}
-
-/* clz - count leading zeroes : 00101000 -> 2
- *                              ^^
- */
-static __always_inline int clz64(u64 n)
-{
-#   if __has_builtin(__builtin_clzll)
-    return __builtin_clzll(n);
-
-#   else
-    u64 r, q;
-
-    r = (n > 0xFFFFFFFF) << 5; n >>= r;
-    q = (n > 0xFFFF)     << 4; n >>= q; r |= q;
-    q = (n > 0xFF  )     << 3; n >>= q; r |= q;
-    q = (n > 0xF   )     << 2; n >>= q; r |= q;
-    q = (n > 0x3   )     << 1; n >>= q; r |= q;
-    r |= (n >> 1);
-    return 64 - r - 1;
-#   endif
-}
-
-static __always_inline int clz32(u32 n)
-{
-#   if __has_builtin(__builtin_clz)
-    return __builtin_clz(n);
-
-#   else
-    u32 r, q;
-
-    r = (n > 0xFFFF)     << 4; n >>= r;
-    q = (n > 0xFF  )     << 3; n >>= q; r |= q;
-    q = (n > 0xF   )     << 2; n >>= q; r |= q;
-    q = (n > 0x3   )     << 1; n >>= q; r |= q;
-    r |= (n >> 1);
-    return 32 - r - 1;
-#   endif
-}
-
-/* fls - return one plus msb : 00101000 -> 6
- *                               ^
- */
-static __always_inline int fls64(u64 n)
-{
-    if (!n)
-        return 0;
-    return 64 - clz64(n);
-}
-
-static __always_inline int fls32(u32 n)
-{
-    if (!n)
-        return 0;
-    return 32 - clz32(n);
-}
-
-/* ffs - return one plus lsb index:  00101000 -> 4
- *                                       ^
- */
-static __always_inline uint ffs64(u64 n)
-{
-#   if __has_builtin(__builtin_ffsll)
-    return __builtin_ffsll(n);
-
-#   elif __has_builtin(__builtin_ctzll)
-    if (n == 0)
-        return (0);
-    return __builtin_ctzll(n) + 1;
-
-#   else
-    return popcount64(n ^ ~-n);
-#   endif
-}
-
-static __always_inline uint ffs32(u32 n)
-{
-#   if __has_builtin(__builtin_ffs)
-    return __builtin_ffs(n);
-
-#   elif __has_builtin(__builtin_ctz)
-    if (n == 0)
-        return (0);
-    return __builtin_ctz(n) + 1;
-
-#   else
-    return popcount32(n ^ ~-n);
-#   endif
-}
-
-/* rolXX/rorXX are taken from kernel's <linux/bitops.h> are are:
- * SPDX-License-Identifier: GPL-2.0
- */
-
-/**
- * rol64 - rotate a 64-bit value left
- * @word: value to rotate
- * @shift: bits to roll
- */
-static inline u64 rol64(u64 word, unsigned int shift)
-{
-        return (word << (shift & 63)) | (word >> ((-shift) & 63));
-}
-
-/**
- * ror64 - rotate a 64-bit value right
- * @word: value to rotate
- * @shift: bits to roll
- */
-static inline u64 ror64(u64 word, unsigned int shift)
-{
-        return (word >> (shift & 63)) | (word << ((-shift) & 63));
-}
-
-/**
- * rol32 - rotate a 32-bit value left
- * @word: value to rotate
- * @shift: bits to roll
- */
-static inline u32 rol32(u32 word, unsigned int shift)
-{
-        return (word << (shift & 31)) | (word >> ((-shift) & 31));
-}
-
-/**
- * ror32 - rotate a 32-bit value right
- * @word: value to rotate
- * @shift: bits to roll
- */
-static inline u32 ror32(u32 word, unsigned int shift)
-{
-        return (word >> (shift & 31)) | (word << ((-shift) & 31));
-}
-
-/**
- * rol16 - rotate a 16-bit value left
- * @word: value to rotate
- * @shift: bits to roll
- */
-static inline u16 rol16(u16 word, unsigned int shift)
-{
-        return (word << (shift & 15)) | (word >> ((-shift) & 15));
-}
-
-/**
- * ror16 - rotate a 16-bit value right
- * @word: value to rotate
- * @shift: bits to roll
- */
-static inline u16 ror16(u16 word, unsigned int shift)
-{
-        return (word >> (shift & 15)) | (word << ((-shift) & 15));
-}
-
-/**
- * rol8 - rotate an 8-bit value left
- * @word: value to rotate
- * @shift: bits to roll
- */
-static inline u8 rol8(u8 word, unsigned int shift)
-{
-        return (word << (shift & 7)) | (word >> ((-shift) & 7));
-}
-
-/**
- * ror8 - rotate an 8-bit value right
- * @word: value to rotate
- * @shift: bits to roll
- */
-static inline u8 ror8(u8 word, unsigned int shift)
-{
-        return (word >> (shift & 7)) | (word << ((-shift) & 7));
-}
-
-/**
- * __ilog2 - non-constant log of base 2 calculators
- * - the arch may override these in asm/bitops.h if they can be implemented
- *   more efficiently than using fls() and fls64()
- * - the arch is not required to handle n==0 if implementing the fallback
- */
-static __always_inline __attribute__((const))
-int __ilog2_u64(u64 n)
-{
-        return fls64(n) - 1;
-}
-
-static __always_inline __attribute__((const))
-int __ilog2_u32(u32 n)
-{
-        return fls32(n) - 1;
-}
-
-/**
- * is_power_of_2() - check if a value is a power of two
- * @n: the value to check
- *
- * Determine whether some value is a power of two, where zero is
- * *not* considered a power of two.
- * Return: true if @n is a power of 2, otherwise false.
- */
-static inline __attribute__((const))
-bool is_power_of_2(unsigned long n)
-{
-        return (n != 0 && ((n & (n - 1)) == 0));
-}
-
-/**
- * __roundup_pow_of_two() - round up to nearest power of two
- * @n: value to round up
- */
-static inline __attribute__((const))
-u64 __roundup_pow_of_two(u64 n)
-{
-        return 1UL << fls64(n - 1);
-}
-
-/**
- * __rounddown_pow_of_two() - round down to nearest power of two
- * @n: value to round down
- */
-static inline __attribute__((const)) u64 __rounddown_pow_of_two(u64 n)
-{
-        return 1UL << (fls64(n) - 1);
-}
-
-/**
- * ilog2 - log base 2 of 32-bit or a 64-bit unsigned value
- * @n: parameter
- *
- * constant-capable log of base 2 calculation
- * - this can be used to initialise global variables from constant data, hence
- * the massive ternary operator construction
- *
- * selects the appropriately-sized optimised version depending on sizeof(n)
- */
-#define ilog2(n)                        \
-(                                       \
-        __builtin_constant_p(n) ?       \
-        ((n) < 2 ? 0 :                  \
-         63 - __builtin_clzll(n)) :     \
-        (sizeof(n) <= 4) ?              \
-        __ilog2_u32(n) :                \
-        __ilog2_u64(n)                  \
- )
-
-/**
- * roundup_pow_of_two - round the given value up to nearest power of two
- * @n: parameter
- *
- * round the given value up to the nearest power of two
- * - the result is undefined when n == 0
- * - this can be used to initialise global variables from constant data
- */
-#define roundup_pow_of_two(n)                   \
-(                                               \
-        __builtin_constant_p(n) ? (             \
-                ((n) == 1) ? 1 :                \
-                (1UL << (ilog2((n) - 1) + 1))   \
-                                   ) :          \
-        __roundup_pow_of_two(n)                 \
- )
-
-/**
- * rounddown_pow_of_two - round the given value down to nearest power of two
- * @n: parameter
- *
- * round the given value down to the nearest power of two
- * - the result is undefined when n == 0
- * - this can be used to initialise global variables from constant data
- */
-#define rounddown_pow_of_two(n)                 \
-(                                               \
-        __builtin_constant_p(n) ? (             \
-                (1UL << ilog2(n))) :            \
-        __rounddown_pow_of_two(n)               \
- )
-
-static inline __attribute_const__ int __order_base_2(unsigned long n)
-{
-        return n > 1 ? ilog2(n - 1) + 1 : 0;
-}
-
-/**
- * order_base_2 - calculate the (rounded up) base 2 order of the argument
- * @n: parameter
- *
- * The first few values calculated by this routine:
- *  ob2(0) = 0
- *  ob2(1) = 0
- *  ob2(2) = 1
- *  ob2(3) = 2
- *  ob2(4) = 2
- *  ob2(5) = 3
- *  ... and so on.
- */
-#define order_base_2(n)                         \
-(                                               \
-        __builtin_constant_p(n) ? (             \
-            ((n) == 0 || (n) == 1) ?            \
-            0 :                                 \
-            ilog2((n) - 1) + 1) :               \
-        __order_base_2(n)                       \
-)
-
-static inline __attribute__((const)) int __bits_per(unsigned long n)
-{
-        if (n < 2)
-            return 1;
-        if (is_power_of_2(n))
-            return order_base_2(n) + 1;
-        return order_base_2(n);
-}
-
-/**
- * bits_per - calculate the number of bits required for the argument
- * @n: parameter
- *
- * This is constant-capable and can be used for compile time
- * initializations, e.g bitfields.
- *
- * The first few values calculated by this routine:
- * bf(0) = 1
- * bf(1) = 1
- * bf(2) = 2
- * bf(3) = 2
- * bf(4) = 3
- * ... and so on.
- */
-#define bits_per(n)                             \
-(                                               \
-        __builtin_constant_p(n) ? (             \
-            ((n) == 0 || (n) == 1) ?            \
-            1 :                                 \
-            ilog2(n) + 1 :                      \
-            __bits_per(n)                       \
-)
-
-/**
- * bit_for_each - iterate over an u64/u32 bits
- * @pos:        an int used as current bit
- * @tmp:        a temp u64/u32 used as temporary storage
- * @ul:         the u64/u32 to loop over
- *
- * Usage:
- * u64 u=139, _t;     //  u=b10001011
- * int cur;
- * bit_for_each64(cur, _t, u) {
- *     printf("%d\n", cur);
- * }
- * This will display the position of each bit set in ul: 1, 2, 4, 8
- *
- * I should probably re-think the implementation...
- */
-#define bit_for_each64(pos, tmp, ul)                                  \
-    for (tmp = ul, pos = ctz64(tmp); tmp; tmp ^= 1UL << pos, pos = ctz64(tmp))
-
-#define bit_for_each32(pos, tmp, ul)                                  \
-    for (tmp = ul, pos = ctz32(tmp); tmp; tmp ^= 1U << pos, pos = ctz32(tmp))
-
-/** or would it be more useful (counting bits from zero instead of 1) ?
- */
-#define bit_for_each64_1(pos, tmp, ul)                                    \
-    for (tmp = ul, pos = ffs64(tmp); tmp; tmp &= (tmp - 1),  pos = ffs64(tmp))
-
-#define bit_for_each32_1(pos, tmp, ul)                                    \
-    for (tmp = ul, pos = ffs32(tmp); tmp; tmp &= (tmp - 1),  pos = ffs32(tmp))
-
-#endif  /* _BITS_H */

include/br.h

@@ -1,6 +1,6 @@
 /* br.h - misc macros.
  *
- * Copyright (C) 2021-2022 Bruno Raoult ("br")
+ * Copyright (C) 2021-2024 Bruno Raoult ("br")
  * Licensed under the GNU General Public License v3.0 or later.
  * Some rights reserved. See COPYING.
  *

include/bug.h

@@ -20,9 +20,6 @@
  * can somehow continue operating, perhaps with reduced functionality,
  * it's probably not BUG-worthy.
  *
- * If you're tempted to BUG(), think again:  is completely giving up
- * really the *only* solution?  There are usually better options, where
- * users don't need to reboot ASAP and can mostly shut down cleanly.
  */
 #define BUG() do {                                                                      \
         fprintf(stderr, "BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __func__); \
@@ -32,9 +29,8 @@
 #define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while (0)
 
 /*
- * WARN(), WARN_ON(), WARN_ON_ONCE, and so on can be used to report
+ * WARN(), WARN_ON(), WARN_ON_ONCE, and so on can be used to report significant
- * significant kernel issues that need prompt attention if they should ever
+ * issues that need prompt attention if they should ever appear at runtime.
- * 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
@@ -50,6 +46,7 @@
 #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)

include/debug.h

@@ -1,6 +1,6 @@
 /* debug.h - debug/log management.
  *
- * Copyright (C) 2021-2023 Bruno Raoult ("br")
+ * Copyright (C) 2021-2024 Bruno Raoult ("br")
  * Licensed under the GNU General Public License v3.0 or later.
  * Some rights reserved. See COPYING.
  *
@@ -16,7 +16,6 @@
 
 #include <stdio.h>
 #include <stdbool.h>
-#include <stdint.h>
 
 #include <br.h>
 
@@ -27,12 +26,64 @@
 
 #ifdef DEBUG_DEBUG
 
-void debug_init(int level, FILE *stream, bool flush);
+/**
+ * debug_level_set - get debug level.
+ * @level: integer debug level.
+ *
+ * @Return: void.
+ */
 void debug_level_set(int level);
+
+/**
+ * debug_level_get - get debug level.
+ *
+ * @Return: current level debug (integer).
+ */
 int debug_level_get(void);
+
+/**
+ * debug_stream_set - set debug output stream.
+ * @stream: (FILE *) output stream
+ *
+ * @Return: void.
+ */
 void debug_stream_set(FILE *stream);
-long long debug_timer_elapsed(void);
+
+/**
+ * debug_flush_set - set debug flush option.
+ * @flush: boolean, if true, flush after each output.
+ *
+ * @Return: void.
+ */
 void debug_flush_set(bool flush);
+
+/**
+ * debug_init - init debug module.
+ * @level: debug level (integer).
+ * @stream: (FILE *) output stream
+ * @flush: boolean, if true, flush after each output.
+ *
+ * @Return: void.
+ */
+void debug_init(int level, FILE *stream, bool flush);
+
+/**
+ * debug_timer_elapsed - get current elapsed debug timer value.
+ *
+ * @Return: long long, timer elapsed.
+ */
+long long debug_timer_elapsed(void);
+
+/**
+ * debug - log function.
+ * @level: log level
+ * @timestamp: boolean, print timestamp if true
+ * @indent: indent level (2 spaces each)
+ * @src: source file/func name (or NULL)
+ * @line: line number
+ *
+ * @Return: void.
+ */
 void _printf debug(int level, bool timestamp,
                    int indent, const char *src,
                    int line, const char *fmt, ...);

include/hash.h

@@ -9,8 +9,9 @@
    (C) 2002 Nadia Yvette Chambers, IBM */
 
 #include <asm/bitsperlong.h>
-#include "bits.h"
+
 #include "br.h"
+#include "bitops.h"
 
 /*
  * The "GOLDEN_RATIO_PRIME" is used in ifs/btrfs/brtfs_inode.h and

include/list_sort.h

@@ -7,8 +7,6 @@
 #ifndef _BR_LIST_SORT_H
 #define _BR_LIST_SORT_H
 
-//#include <linux/types.h>
-
 struct list_head;
 
 typedef int __attribute__((nonnull(2,3))) (*list_cmp_func_t)(void *,

include/pjwhash-inline.h

@@ -1,6 +1,6 @@
 /* pjwhash-inline.h - PJW hash function, inline version.
  *
- * Copyright (C) 2021-2022 Bruno Raoult ("br")
+ * Copyright (C) 2021-2024 Bruno Raoult ("br")
  * Licensed under the GNU General Public License v3.0 or later.
  * Some rights reserved. See COPYING.
  *
@@ -14,7 +14,7 @@
 #ifndef _PJWHASH_INLINE_H
 #define _PJWHASH_INLINE_H
 
-#include "bits.h"
+#include "br.h"
 
 #define THREE_QUARTERS ((int) ((BITS_PER_INT * 3) / 4))
 #define ONE_EIGHTH     ((int) (BITS_PER_INT / 8))

include/pjwhash.h

@@ -1,6 +1,6 @@
 /* pjwhash.h - PJW hash function, extern version.
  *
- * Copyright (C) 2021-2022 Bruno Raoult ("br")
+ * Copyright (C) 2021-2024 Bruno Raoult ("br")
  * Licensed under the GNU General Public License v3.0 or later.
  * Some rights reserved. See COPYING.
  *
@@ -13,7 +13,7 @@
 #ifndef _PJWHASH_H
 #define _PJWHASH_H
 
-#include "bits.h"
+#include "br.h"
 
 /**
  * unsigned int pjwhash - PJW hash function

include/pool.h

@@ -1,6 +1,6 @@
 /* pool.h - A simple memory pool manager.
  *
- * Copyright (C) 2021-2022 Bruno Raoult ("br")
+ * Copyright (C) 2021-2024 Bruno Raoult ("br")
  * Licensed under the GNU General Public License v3.0 or later.
  * Some rights reserved. See COPYING.
  *
@@ -16,8 +16,9 @@
 
 #include <stdint.h>
 #include <stddef.h>
+
+#include "br.h"
 #include "list.h"
-#include "bits.h"
 
 #define POOL_NAME_LENGTH (16)                     /* max name length including trailing \0 */
 

include/struct-group.h

@@ -1,6 +1,6 @@
 /* struct-group.h - mirrored structure macros.
  *
- * Copyright (C) 2021-2022 Bruno Raoult ("br")
+ * Copyright (C) 2021-2024 Bruno Raoult ("br")
  * Licensed under the GNU General Public License v3.0 or later.
  * Some rights reserved. See COPYING.
  *
@@ -33,10 +33,10 @@
  * as both having struct attributes appended.
  */
 #define __struct_group(TAG, NAME, ATTRS, MEMBERS...) \
-	union { \
+    union {                                          \
-		struct { MEMBERS } ATTRS; \
+        struct { MEMBERS } ATTRS;                    \
-		struct TAG { MEMBERS } ATTRS NAME; \
+        struct TAG { MEMBERS } ATTRS NAME;           \
-	}
+    }
 
 /**
  * DECLARE_FLEX_ARRAY() - Declare a flexible array usable in a union
@@ -48,11 +48,11 @@
  * struct, it needs to be wrapped in an anonymous struct with at least 1
  * named member, but that member can be empty.
  */
-#define DECLARE_FLEX_ARRAY(TYPE, NAME)	\
+#define DECLARE_FLEX_ARRAY(TYPE, NAME)	     \
-	struct { \
+    struct {                                 \
-		struct { } __empty_ ## NAME; \
+        struct { } __empty_ ## NAME;         \
-		TYPE NAME[]; \
+        TYPE NAME[];                         \
-	}
+    }
 
 /**
  * struct_group() - Wrap a set of declarations in a mirrored struct
@@ -67,7 +67,7 @@
  * struct members.
  */
 #define struct_group(NAME, MEMBERS...)	\
-	__struct_group(/* no tag */, NAME, /* no attrs */, MEMBERS)
+    __struct_group(/* no tag */, NAME, /* no attrs */, MEMBERS)
 
 /**
  * struct_group_attr() - Create a struct_group() with trailing attributes
@@ -83,7 +83,7 @@
  * struct members. Includes structure attributes argument.
  */
 #define struct_group_attr(NAME, ATTRS, MEMBERS...) \
-	__struct_group(/* no tag */, NAME, ATTRS, MEMBERS)
+    __struct_group(/* no tag */, NAME, ATTRS, MEMBERS)
 
 /**
  * struct_group_tagged() - Create a struct_group with a reusable tag
@@ -100,6 +100,6 @@
  * so the specified layout can be reused later.
  */
 #define struct_group_tagged(TAG, NAME, MEMBERS...) \
-	__struct_group(TAG, NAME, /* no attrs */, MEMBERS)
+    __struct_group(TAG, NAME, /* no attrs */, MEMBERS)
 
 #endif  /* _STRUCT_GROUP_H */

scripts/env.sh

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+#
+# env.sh - set environment for brchess developer.
+#
+# Copyright (C) 2023 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>
+#
+# USAGE: source env.sh [arg]
+#
+# This file will actually be sourced if it was never sourced in current bash
+# environment.
+
+if [[ ! -v _BRLIB_ENV_ ]]; then
+    export _BRLIB_ENV_=1 BRLIB_ROOT LD_LIBRARY_PATH
+    BRLIB_SCRIPTDIR=$(realpath -L "$(dirname "${BASH_SOURCE[0]}")")
+    BRLIB_ROOT=$(realpath -L "$(dirname "${BASH_SOURCE[0]}")/..")
+    BRLIB_LIBDIR="$BRLIB_ROOT/lib"
+    BRLIB_BINDIR="$BRLIB_ROOT/bin"
+    LD_LIBRARY_PATH="${BRLIB_LIBDIR}${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}"
+    PATH="$PATH:$BRLIB_BINDIR:$BRLIB_SCRIPTDIR"
+    #printf "R=%s L=%s LD=%s\n" "$BRLIB_ROOT" "$BRLIB_DIR" "$LD_LIBRARY_PATH"
+    unset BRLIB_LIBDIR BRLIB_BINDIR BRLIB_SCRIPTDIR
+    printf "brlib environment complete.\n"
+fi

src/bitops.c

@@ -1,6 +1,6 @@
-/* bits.c - information about bitops implementation.
+/* bitops.c - information about bitops implementation.
  *
- * Copyright (C) 2021-2022 Bruno Raoult ("br")
+ * Copyright (C) 2021-2024 Bruno Raoult ("br")
  * Licensed under the GNU General Public License v3.0 or later.
  * Some rights reserved. See COPYING.
  *
@@ -11,7 +11,7 @@
  *
  */
 
-#include "bits.h"
+#include "bitops.h"
 #include "debug.h"
 
 void print_bitops_impl(void)

src/debug.c

@@ -1,6 +1,7 @@
+
 /* debug.c - debug/log management
  *
- * Copyright (C) 2021-2023 Bruno Raoult ("br")
+ * Copyright (C) 2021-2024 Bruno Raoult ("br")
  * Licensed under the GNU General Public License v3.0 or later.
  * Some rights reserved. See COPYING.
  *
@@ -26,10 +27,6 @@ static int level = 0;                             /* output log when < level */
 static int flush = false;                         /* force flush after logs */
 static FILE *stream = NULL;                       /* stream to use */
 
-/**
- * debug_level_set() - set debug level.
- * @_level: debug level (integer).
- */
 void debug_level_set(int _level)
 {
     level = _level;
@@ -38,10 +35,6 @@ void debug_level_set(int _level)
 #   endif
 }
 
-/**
- * debug_level_get() - get debug level.
- * @return: current level debug (integer).
- */
 int debug_level_get(void)
 {
     return level;
@@ -87,14 +80,6 @@ long long debug_timer_elapsed(void)
     return (timer.tv_sec * NANOSEC + timer.tv_nsec) - timer_start;
 }
 
-/**
- * debug() - log function
- * @lev: log level
- * @timestamp: boolean, print timestamp if true
- * @indent: indent level (2 spaces each)
- * @src: source file/func name (or NULL)
- * @line: line number
- */
 void debug(int lev, bool timestamp, int indent, const char *src,
            int line, const char *fmt, ...)
 {

src/list_sort.c

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

src/pjwhash.c

@@ -1,6 +1,6 @@
 /* pjwhash.c - PJW hash function.
  *
- * Copyright (C) 2021-2022 Bruno Raoult ("br")
+ * Copyright (C) 2021-2024 Bruno Raoult ("br")
  * Licensed under the GNU General Public License v3.0 or later.
  * Some rights reserved. See COPYING.
  *
@@ -13,8 +13,5 @@
 
 #define _pjw_inline extern
 
-//#include "bits.h"
-//extern unsigned int  pjwhash (const void* key, uint length);
-
 #include "pjwhash.h"
 #include "pjwhash-inline.h"

src/pool.c

@@ -1,6 +1,6 @@
 /* pool.c - A simple pool manager.
  *
- * Copyright (C) 2021-2022 Bruno Raoult ("br")
+ * Copyright (C) 2021-2024 Bruno Raoult ("br")
  * Licensed under the GNU General Public License v3.0 or later.
  * Some rights reserved. See COPYING.
  *
@@ -17,10 +17,10 @@
 #include <stdlib.h>
 #include <errno.h>
 
+#include "br.h"
 #include "list.h"
 #include "pool.h"
 #include "debug.h"
-#include "bits.h"
 
 void pool_stats(pool_t *pool)
 {

test/bitops-test.c

@@ -0,0 +1,196 @@
+/* bits.c - bitops testing.
+ *
+ * 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>
+ *
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+
+#include "br.h"
+#include "bitops.h"
+// #include "cutest/CuTest.h"
+
+static void test_popcount()
+{
+    u32 t32[] = { 0x0,   0x88000101,           0xffffffff           };
+    u64 t64[] = { 0x0ll, 0x8880000000000101LL, 0xffffffffffffffffll };
+
+    for (uint i = 0; i < ARRAY_SIZE(t32); ++i) {
+        printf("popcount32 (%#x): ", t32[i]);
+#       ifdef ___popcount32_native
+        printf("native:%d ", __popcount32_native(t32[i]));
+#       else
+        printf("native:XXX ");
+#       endif
+        printf("emulated:%d ", __popcount_emulated(t32[i]));
+        printf("\n");
+    }
+        printf("\n");
+    for (uint i = 0; i < ARRAY_SIZE(t64); ++i) {
+        printf("popcount64 (%#lx): ", t64[i]);
+#       ifdef ___popcount64_native
+        printf("native:%d ", __popcount64_native(t64[i]));
+#       else
+        printf("native:XXX ");
+#       endif
+        printf("emulated:%d ", __popcount_emulated(t64[i]));
+        printf("\n");
+    }
+    printf("\n");
+}
+
+static void test_ctz()
+{
+    u32 t32[] = {
+        0x88800101,
+        0xffffffff,
+        0x800,
+        0x80000000,
+        0x00800000
+    };
+    u64 t64[] = {
+        0x8880000000000101LL,
+        0xffffffffffffffffll,
+        0x800ll,
+        0x8000000000000000LL,
+        0x0080000000000000LL};
+
+    for (uint i = 0; i < ARRAY_SIZE(t32); ++i) {
+        printf("ctz32 (%#x): ", t32[i]);
+#       ifdef __ctz32_native
+        printf("native:%d ", __ctz32_native(t32[i]));
+#       else
+        printf("native:XXX ");
+#       endif
+        printf("emulated1:%d ", __ctz32_emulated(t32[i]));
+        printf("emulated2:%d ", __ctz32_emulated2(t32[i]));
+        //printf("emulated3:%d ", __ctz32_emulated3(t32[i]));
+        //printf("emulated4:%d ", __ctz32_emulated4(t32[i]));
+        printf("\n");
+    }
+    printf("\n");
+    for (uint i = 0; i < ARRAY_SIZE(t64); ++i) {
+        printf("ctz64 (%#lx): ", t64[i]);
+#       ifdef __ctz64_native
+        printf("native:%d ", __ctz64_native(t64[i]));
+#       else
+        printf("native:XXX ");
+#       endif
+        printf("emulated1:%d ", __ctz64_emulated(t64[i]));
+        printf("emulated2:%d ", __ctz64_emulated2(t64[i]));
+        //printf("emulated3:%d ", __ctz64_emulated3(t64[i]));
+        //printf("emulated4:%d ", __ctz64_emulated4(t64[i]));
+        printf("\n");
+    }
+    printf("\n");
+}
+
+static void test_clz()
+{
+    u32 t32[] = {
+        0x88800101,
+        0xffffffff,
+        0x800,
+        0x80000000,
+        0x00800000
+    };
+    u64 t64[] = {
+        0x8880000000000101LL,
+        0xffffffffffffffffll,
+        0x800ll,
+        0x8000000000000000LL,
+        0x0080000000000000LL};
+
+    for (uint i = 0; i < ARRAY_SIZE(t32); ++i) {
+        printf("clz32 (%#x): ", t32[i]);
+#       ifdef __clz32_native
+        printf("native:%d ", __clz32_native(t32[i]));
+#       else
+        printf("native:XXX ");
+#       endif
+        printf("emulated1:%d ", __clz32_emulated(t32[i]));
+        //printf("emulated2:%d ", __clz32_emulated2(t32[i]));
+        //printf("emulated3:%d ", __ctz32_emulated3(t32[i]));
+        //printf("emulated4:%d ", __ctz32_emulated4(t32[i]));
+        printf("\n");
+    }
+    printf("\n");
+    for (uint i = 0; i < ARRAY_SIZE(t64); ++i) {
+        printf("clz64 (%#lx): ", t64[i]);
+#       ifdef __clz64_native
+        printf("native:%d ", __clz64_native(t64[i]));
+#       else
+        printf("native:XXX ");
+#       endif
+        printf("emulated1:%d ", __clz64_emulated(t64[i]));
+        //printf("emulated2:%d ", __ctz64_emulated2(t64[i]));
+        //printf("emulated3:%d ", __ctz64_emulated3(t64[i]));
+        //printf("emulated4:%d ", __ctz64_emulated4(t64[i]));
+        printf("\n");
+    }
+    printf("\n");
+}
+
+static void test_ffs()
+{
+    u32 t32[] = {
+        0x88800101,
+        0xffffffff,
+        0x800,
+        0x80000000,
+        0x00800000
+    };
+    u64 t64[] = {
+        0x8880000000000101LL,
+        0xffffffffffffffffll,
+        0x800ll,
+        0x8000000000000000LL,
+        0x0080000000000000LL};
+
+    for (uint i = 0; i < ARRAY_SIZE(t32); ++i) {
+        printf("ffs32 (%#x): ", t32[i]);
+#       ifdef __ffs32_native
+        printf("native:%d ", __ffs32_native(t32[i]));
+#       else
+        printf("native:XXX ");
+#       endif
+        printf("popcount:%d ", __ffs32_popcount(t32[i]));
+        printf("ctz:%d ", __ffs32_ctz(t32[i]));
+        printf("emulated:%d ", __ffs32_emulated(t32[i]));
+        //printf("emulated4:%d ", __ctz32_emulated4(t32[i]));
+        printf("\n");
+    }
+    printf("\n");
+    for (uint i = 0; i < ARRAY_SIZE(t64); ++i) {
+        printf("ffs64 (%#lx): ", t64[i]);
+#       ifdef __ffs64_native
+        printf("native:%d ", __ffs64_native(t64[i]));
+#       else
+        printf("native:XXX ");
+#       endif
+        printf("popcount:%d ", __ffs64_popcount(t64[i]));
+        printf("ctz:%d ", __ffs64_ctz(t64[i]));
+        printf("emulated:%d ", __ffs64_emulated(t64[i]));
+        //printf("emulated4:%d ", __ctz64_emulated4(t64[i]));
+        printf("\n");
+    }
+    printf("\n");
+    printf("\n");
+}
+
+int main()
+{
+    test_popcount();
+    test_ctz();
+    test_clz();
+    test_ffs();
+    exit(0);
+}

test/pool-test.c

@@ -1,6 +1,9 @@
 #include <stdio.h>
-#include "bits.h"
+#include <stdlib.h>
+
+#include "br.h"
 #include "pool.h"
+#include "debug.h"
 
 struct d {
     u16 data1;
@@ -19,7 +22,7 @@ int main(int ac, char**av)
     char ccur='z';
     struct d *elt;
 
-    debug_init(3);
+    debug_init(3, stderr, true);
     log_f(1, "%s: sizeof(d)=%lu sizeof(*d)=%lu off=%lu\n", *av, sizeof(elt),
           sizeof(*elt), offsetof(struct d, list));