bug.h revamp, easier to use

- int types definitions moved to br.h
- bits_implementation() -> print_bitops_impl()
- 64 bitops use ...ll builtins instead of ...l
- add lsb and msb macros
- bit_for_each -> bit_for_each_1 (count from 1)
- bit_for_each_2 -> bit_for_each (count from 0)

.dir-locals.el

@@ -0,0 +1,4 @@
+;; emacs per-directory settings
+((nil . ((compile-command . (concat "make -C "
+                                    (vc-root-dir)
+                                    " -k -j2")))))

.gitignore

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

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "test/cutest"]
+	path = test/cutest
+	url = ../cutest.git

Makefile

@@ -0,0 +1,345 @@
+# brlib Makefile - GNU make only
+#
+# 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>
+#
+
+SHELL     := /bin/bash
+CC        := gcc
+LD        := ld
+BEAR      := bear
+TOUCH     := touch
+RM        := rm
+MKDIR     := mkdir -p
+RMDIR     := rmdir
+
+SRCDIR    := ./src
+INCDIR    := ./include
+OBJDIR    := ./obj
+LIBDIR    := ./lib
+BINDIR    := ./bin
+DEPDIR    := ./dep
+TESTDIR   := ./test
+
+SRC       := $(wildcard $(SRCDIR)/*.c)                      # brlib sources
+SRC_FN    := $(notdir $(SRC))                               # source basename
+OBJ       := $(addprefix $(OBJDIR)/,$(SRC_FN:.c=.o))
+
+LIB       := br_$(shell uname -m)                           # library name
+SLIB      := $(addsuffix .a, $(LIBDIR)/lib$(LIB))           # static lib
+DLIB      := $(addsuffix .so, $(LIBDIR)/lib$(LIB))          # dynamic lib
+
+DEP_FN    := $(SRC_FN) $(LIBSRC_FN)
+DEP       := $(addprefix $(DEPDIR)/,$(DEP_FN:.c=.d))
+
+TEST      := $(wildcard $(TESTDIR)/*.c)
+TEST_FN   := $(notdir $(TEST))
+BIN       := $(addprefix $(BINDIR)/,$(TEST_FN:.c=))
+
+CCLSCMDS  := compile_commands.json
+
+##################################### Check for compiler and requested build
+BUILDS    := release dev perf debug
+# last compilation build
+BUILDFILE := .lastbuild
+lastbuild := $(file < $(BUILDFILE))
+$(info brlib last:$(lastbuild))
+# default to gcc
+CC        ?= cc
+ifeq ($(CC),cc)
+        CC = gcc
+endif
+
+# if no build specified, use last one
+ifeq ($(build),)
+        build := $(lastbuild)
+endif
+# if build is still undefined, set a default
+ifeq ($(build),)
+        build := release
+endif
+
+$(info brlib build=$(build))
+
+# check for valid build
+ifeq ($(filter $(build),$(BUILDS)),)
+        $(error Error: Unknown build=`$(build)`. Possible builds are: $(BUILDS))
+endif
+
+# if new build, rewrite BUILDFILE
+ifneq ($(build),$(lastbuild))
+        $(info New build:`$(build)` (was:$(lastbuild)))
+        $(file >$(BUILDFILE),$(build))
+endif
+##################################### pre-processor flags
+override CPPFLAGS  += -I $(INCDIR)
+
+ifeq ($(BUILD),release)
+        CPPFLAGS  += -DNDEBUG                               # assert (unused)
+        CPPFLAGS  += -DBUG_ON=0                          CPPFLAGS  += -DWARN_ON=0                 else # ifeq ($(BUILD),dev)
+        #CPPFLAGS  += -DDEBUG                            #CPPFLAGS  += -DDEBUG_DEBUG_C                    CPPFLAGS  += -DDEBUG_DEBUG                       CPPFLAGS  += -DDEBUG_POOL                        CPPFLAGS  += -DBUG_ON=1                          CPPFLAGS  += -DWARN_ON=1                            # warn_on in bug.h
+endif
+
+# remove extraneous spaces (due to spaces before comments)
+CPPFLAGS  := $(strip $(CPPFLAGS))
+
+##################################### compiler flags
+CFLAGS    := -std=gnu11
+
+CFLAGS    += -Wall
+CFLAGS    += -Wextra
+CFLAGS    += -march=native
+CFLAGS    += -Wmissing-declarations
+CFLAGS    += -Wno-unused-result
+# TODO: specific to dynamic
+CFLAGS    += -fPIC
+
+### dev OR release
+ifeq ($(BUILD),release)
+        CFLAGS    += -O3
+        CFLAGS    += -funroll-loops
+        CFLAGS    += -flto
+else ifeq ($(BUILD),dev)
+        CFLAGS    += -Og
+        CFLAGS    += -g
+        CFLAGS    += -ginline-points                   # inlined funcs debug info
+        # for gprof
+        #CFLAGS    += -pg
+        # Next one may be useful for valgrind (some invalid instructions)
+        # CFLAGS   += -mno-tbm
+else ifeq ($(BUILD),perf)
+        CFLAGS    += -O3
+        CFLAGS    += -g                                # symbols (gdb, perf, etc.)
+        CFLAGS    += -ginline-points                   # inlined funcs debug info
+        CFLAGS    += -funroll-loops
+else ifeq ($(BUILD),debug)
+        CFLAGS    += -O0
+        CFLAGS    += -g                                # symbols (gdb, perf, etc.)
+        # for gprof
+        #CFLAGS += -pg
+        # Next one may be useful for valgrind (when invalid instructions)
+        #CFLAGS += -mno-tbm
+endif
+
+CFLAGS    := $(strip $(CFLAGS))
+
+##################################### archiver/linker/dependency flags
+ARFLAGS   := rcs
+LDFLAGS   := -L$(LIBDIR)
+LIBS      := -l$(LIB)
+DEPFLAGS   = -MMD -MP -MF $(DEPDIR)/$*.d
+
+ifeq ($(BUILD),release)
+        LDFLAGS   += -flto
+endif
+
+##################################### General targets
+.PHONY: all libs lib-static lib-dynamic compile test emacs ccls bear clean \
+        cleanall cleanallall
+
+# default: build libraries
+all: libs
+
+# libraries
+libs: lib-static lib-dynamic
+lib-static: $(SLIB)
+lib-dynamic: $(DLIB)
+
+# build objects
+compile: $(OBJ)
+
+# build test binaries
+test: $(BIN)
+
+# setup emacs projectile/ccls
+emacs: $(PRJROOT) $(EMACSLSP)
+
+# update compile-commands.json
+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.
+# $(1): the directory
+# $(2): the list of files to delete
+# $(3): The string to include in action output - "cleaning X files."
+# see: https://stackoverflow.com/questions/6783243/functions-in-makefiles
+#
+# Don't use wildcard like "$(DIR)/*.o", so we can control mismatches between
+# list and actual files in directory.
+# See rmdir below.
+define rmfiles
+	@#echo "rmfiles=+$(1)+"
+	$(eval $@_EXIST = $(wildcard $(1)))
+	@#echo "existfile=+${$@_EXIST}+"
+	@if [[ -n "${$@_EXIST}" ]]; then         \
+		echo "cleaning $(2) files." ;    \
+		$(RM) ${$@_EXIST} ;              \
+	fi
+endef
+
+# rmdir - deletes a directory if it exists.
+# $(1): the directory
+# $(2): The string to include in action output - "removing X dir."
+#
+# Don't use $(RM) -rf, to control unexpected dep files.
+# See rmfile above.
+define rmdir
+	@#echo "rmdir +$(1)+"
+	$(eval $@_EXIST = $(wildcard $(1)))
+	@#echo "existdir=+${$@_EXIST}+"
+	@if [[ -n "${$@_EXIST}" ]]; then         \
+		echo "removing $(2) dir." ;      \
+		$(RMDIR) ${$@_EXIST} ;           \
+	fi
+endef
+
+##################################### dirs creation
+.PHONY: alldirs
+
+ALLDIRS   := $(DEPDIR) $(OBJDIR) $(LIBDIR) $(BINDIR)
+
+alldirs: $(ALLDIRS)
+
+# Here, we have something like:
+# a: a
+# a will be built if (1) older than a, or (2) does not exist. Here only (2).
+$(ALLDIRS): $@
+	@echo creating $@ directory.
+	@$(MKDIR) $@
+
+##################################### Dependencies files
+.PHONY: cleandep cleandepdir
+
+-include $(wildcard $(DEP))
+
+# Don't use $(DEPDIR)/*.d, to control mismatches between dep and src files.
+# See second rule below.
+cleandep:
+	$(call rmfiles,$(DEP),depend)
+	@#echo cleaning dependency files.
+	@#$(RM) -f $(DEP)
+
+cleandepdir:
+	$(call rmdir,$(DEPDIR),depend)
+	@#[ -d $(DEPDIR) ] && echo cleaning depend files && $(RM) -f $(DEP) || true
+
+##################################### objects
+.PHONY: cleanobj cleanobjdir
+
+cleanobj:
+	$(call rmfiles,$(OBJ),brlib object)
+
+cleanobjdir:
+	$(call rmdir,$(OBJDIR),brlib objects)
+
+# $(OBJDIR)/%.o: $(BUILDFILE)
+$(OBJDIR)/%.o: $(SRCDIR)/%.c $(BUILDFILE) | $(OBJDIR) $(DEPDIR)
+	@echo compiling $< "->" $@.
+	$(CC) -c $(DEPFLAGS) $(CPPFLAGS) $(CFLAGS) $< -o $@
+
+##################################### brlib libraries
+.PHONY: cleanlib cleanlibdir
+
+cleanlib:
+	$(call rmfiles,$(DLIB) $(SLIB),library)
+
+cleanlibdir:
+	$(call rmdir,$(LIBDIR),libraries)
+
+#$(DLIB): CFLAGS += -fPIC
+$(DLIB): LDFLAGS += -shared
+$(DLIB): $(OBJ) | $(LIBDIR)
+	@echo "building shared library ($@)."
+	@$(CC) $(CFLAGS) $(LDFLAGS) $^ -o $@
+
+$(SLIB): $(OBJ) | $(LIBDIR)
+	@echo "building static library ($@)."
+	@$(AR) $(ARFLAGS) $@ $? > /dev/null
+
+##################################### testing
+.PHONY: cleanbin cleanbindir
+
+CUTESTSRC  := $(TESTDIR)/cutest/CuTest.c
+
+cleanbin:
+	$(call rmfiles,$(BIN),binary)
+
+cleanbindir:
+	$(call rmdir,$(BINDIR),binaries)
+
+$(BINDIR)/%: $(TESTDIR)/%.c $(SLIB) $(DLIB) | $(BINDIR)
+	$(CC) $(CPPFLAGS) $(CFLAGS) $< $(CUTESTSRC) $(LDFLAGS) $(LIBS) -o $@
+
+##################################### pre-processed (.i) and assembler (.s) output
+%.i: %.c
+	@echo generating $@
+	@$(CC) -E $(CPPFLAGS) $(CFLAGS) $< -o $@
+
+%.s: %.c
+	@echo generating $@
+	@$(CC) -S -fverbose-asm $(CPPFLAGS) $(CFLAGS) $< -o $@
+
+##################################### Emacs & LSP (ccls)
+.PHONY: cleanemacs cleanccls
+
+#EMACSLSP   := .dir-locals.el
+CCLSFILES  := .projectile .ccls .ccls-root
+CCLSCACHE  := .ccls-cache
+
+cleanemacs:
+	$(call rmfiles, $(PRJROOT) $(EMACSLSP), Emacs/ccls);
+
+$(CCLSFILES):
+	printf "creating Emacs dot-files.\n"
+	@$(TOUCH) $@
+
+cleanccls:
+	$(call rmfiles, $(CCLSFILES), ccls);
+
+# generate compile_commands.json.
+# TODO: add includes and Makefile dependencies.
+# also, if cclsfile is newer than sources, no need to clean objects file
+# (and to run bear).
+# maybe run cleanobj cleanlibobj in commands ?
+$(CCLSCMDS): cleanobj $(SRC) | $(CCLSROOT)
+	@echo "Generating ccls compile commands file ($@)."
+	@$(BEAR) -- $(MAKE) test
+
+##################################### valgrind (mem check)
+.PHONY: memcheck
+
+VALGRIND      := valgrind
+VALGRINDFLAGS := --leak-check=full --show-leak-kinds=all
+VALGRINDFLAGS += --track-origins=yes --sigill-diagnostics=yes
+VALGRINDFLAGS += --quiet --show-error-list=yes
+VALGRINDFLAGS += --log-file=valgrind.out
+# We need to suppress libreadline leaks here. See :
+# https://stackoverflow.com/questions/72840015
+VALGRINDFLAGS += --suppressions=etc/libreadline.supp
+
+memcheck: targets
+	@$(VALGRIND) $(VALGRINDFLAGS) $(BINDIR)/brchess
+
+##################################### Makefile debug
+.PHONY: showflags wft
+
+showflags:
+	@echo CFLAGS: "$(CFLAGS)"
+	@echo CPPFLAGS: $(CPPFLAGS)
+	@echo DEPFLAGS: $(DEPFLAGS)
+	@echo LDFLAGS: $(LDFLAGS)
+
+wtf:
+	@printf "OBJDIR=%s\n\n" "$(OBJDIR)"
+	@printf "OBJ=%s\n\n" "$(OBJ)"

README.org

@@ -0,0 +1,43 @@
+#+title: brlib - A small personal C library
+#+OPTIONS: toc:nil
+#+OPTIONS: num:2
+
+** License
+~SPDX-License-Identifier: GPL-3.0-or-later <https://spdx.org/licenses/GPL-3.0-or-later.html>~~
+
+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:*
+
+**** _Cutest testing framework.__
+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 <https://spdx.org/licenses/Zlib.html>.
+
+** Installation:
+*** clone repository
+**** user...
+#+BEGIN_EXAMPLE
+$ git clone https://github.com/braoult/brlib.git
+or
+$ git clone https://git.raoult.com/bruno/brlib.git
+#+END_EXAMPLE
+
+**** OR ...developer
+#+BEGIN_EXAMPLE
+$ git clone git@git.raoult.com:bruno/brlib.git
+$ cd brlib
+$ git remote add github git@github.com:braoult/brlib.git
+$ git fetch --all
+#+END_EXAMPLE
+
+*Add CuTest submodule (optional)*
+#+BEGIN_EXAMPLE
+$ cd brlib
+$ git submodule init
+$ git submodule update
+#+END_EXAMPLE

c/Makefile

@@ -1,90 +0,0 @@
-# Tools Makefile
-#
-# Copyright (C) 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>
-#
-
-SHELL  := /bin/bash
-CC     := gcc
-
-CFLAGS += -std=gnu11
-CFLAGS += -O2
-CFLAGS += -g
-CFLAGS += -Wall
-CFLAGS += -Wextra
-CFLAGS += -march=native
-CFLAGS += -Wmissing-declarations
-CFLAGS += -Wno-unused-result
-
-# for gprof
-#CFLAGS += -pg
-
-# Next one may be useful for valgrind (some invalid instructions)
-# CFLAGS += -mno-tbm
-
-CFLAGS += -DDEBUG_DEBUG		# activate general debug (debug.c)
-CFLAGS += -DDEBUG_POOL		# memory pools management
-
-INCDIR    := ./include
-LIBDIR    := ./lib
-OBJDIR    := ./obj
-
-LIBNAME   := br_$(shell uname -m)
-LIB       := lib$(LIBNAME)
-SLIB      := $(LIBDIR)/$(LIB).a
-DLIB      := $(LIBDIR)/$(LIB).so
-LIBSRC    := $(wildcard *.c)
-LIBOBJ    := $(addprefix $(OBJDIR)/,$(patsubst %.c,%.o,$(LIBSRC)))
-LDFLAGS   := -L$(LIBDIR)
-LDLIB     := -l$(LIB)
-
-export LD_LIBRARY_PATH = $(LIBDIR)
-
-.PHONY: all libs clean dirs bear
-
-all: libs
-
-libs: dirs $(DLIB) $(SLIB)
-
-dirs: $(LIBDIR) $(OBJDIR)
-
-$(LIBDIR) $(OBJDIR):
-	@echo creating $@ directory.
-	@mkdir $@
-
-clean:
-	@echo deleting $(OBJDIR) and $(LIBDIR) directories.
-	@$(RM) -rf $(LIBDIR) $(OBJDIR)
-
-$(SLIB): $(LIBOBJ)
-	@echo building $@ static library.
-	@$(AR) $(ARFLAGS) -o $@ $^
-
-$(DLIB): CFLAGS += -fPIC
-$(DLIB): LDFLAGS += -shared
-$(DLIB): $(LIBOBJ)
-	@echo building $@ shared library.
-	@$(CC) $(LDFLAGS) $^ -o $@
-
-.c:
-	@echo compiling $<
-	@$(CC) $(CFLAGS) $(LDFLAGS) -I $(INCDIR) $< $(LDLIB) -o $@
-
-#.c.o:
-$(OBJDIR)/%.o: %.c
-	@echo compiling $<.
-	@$(CC) -c $(CFLAGS) $(LDFLAGS) -I $(INCDIR) -o $@ $<
-
-.c.s:
-	@echo generating $@
-	@$(CC) -S -fverbose-asm $(CFLAGS) -I $(INCDIR) $< -o $@
-
-bear: clean
-	@echo building ccls language server compilation database
-	@bear -- make

c/bits.c

@@ -1,91 +0,0 @@
-/* bits.c - information about bitops implementation.
- *
- * 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>
- *
- */
-
-#include "bits.h"
-#include "debug.h"
-
-/**
- * bits_implementation - display bitops implementation.
- *
- * For basic bitops (popcount, ctz, etc...), print the implementation
- * (builtin, emulated).
- */
-void bits_implementation(void)
-{
-    log(0, "bitops implementation: ");
-
-    log(0, "popcount64: ");
-#   if __has_builtin(__builtin_popcountl)
-    log(0, "builtin, ");
-#   else
-    log(0, "emulated, ");
-#   endif
-
-    log(0, "popcount32: ");
-#   if __has_builtin(__builtin_popcount)
-    log(0, "builtin, ");
-#   else
-    log(0, "emulated, ");
-#   endif
-
-    log(0, "ctz64: ");
-#   if __has_builtin(__builtin_ctzl)
-    log(0, "builtin, ");
-#   elif __has_builtin(__builtin_clzl)
-    log(0, "builtin (clzl), ");
-#   else
-    log(0, "emulated, ");
-#   endif
-
-    log(0, "ctz32: ");
-#   if __has_builtin(__builtin_ctz)
-    log(0, "builtin, ");
-#   elif __has_builtin(__builtin_clz)
-    log(0, "builtin (clz), ");
-#   else
-    log(0, "emulated, ");
-#   endif
-
-    log(0, "clz64: ");
-#   if __has_builtin(__builtin_clzl)
-    log(0, "builtin, ");
-#   else
-    log(0, "emulated, ");
-#   endif
-
-    log(0, "clz32: ");
-#   if __has_builtin(__builtin_clz)
-    log(0, "builtin, ");
-#   else
-    log(0, "emulated, ");
-#   endif
-
-    log(0, "ffs64: ");
-#   if __has_builtin(__builtin_ffsl)
-    log(0, "builtin, ");
-#   elif __has_builtin(__builtin_ctzl)
-    log(0, "builtin (ctzl), ");
-#   else
-    log(0, "emulated, ");
-#   endif
-
-    log(0, "ffs32: ");
-#   if __has_builtin(__builtin_ffs)
-    log(0, "builtin, ");
-#   elif __has_builtin(__builtin_ctz)
-    log(0, "builtin (ctzl), ");
-#   else
-    log(0, "emulated, ");
-#   endif
-    log(0, "\n");
-}

c/brlib/include/bits.h

@@ -1,499 +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 <stdint.h>
-#include <stdbool.h>
-#include <bits/wordsize.h>                        /* defines __WORDSIZE: 32 or 64 */
-
-void bits_implementation(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
- */
-
-/* fixed-size types
- */
-typedef int64_t  s64;
-typedef int32_t  s32;
-typedef int16_t  s16;
-typedef int8_t   s8;
-
-typedef uint64_t u64;
-typedef uint32_t u32;
-typedef uint16_t u16;
-typedef uint8_t  u8;
-
-/* convenience types
- */
-typedef long long int llong;
-typedef unsigned long long int ullong;
-typedef unsigned long int ulong;
-typedef unsigned int uint;
-typedef unsigned short ushort;
-typedef unsigned char uchar;
-/* char is a special case, as it can be signed or unsigned
- */
-typedef signed char schar;
-
-/* define common types sizes
- */
-#define BITS_PER_CHAR 8
-
-#ifndef BITS_PER_SHORT
-#define BITS_PER_SHORT (BITS_PER_CHAR * sizeof (short))
-#endif
-#ifndef BITS_PER_INT
-#define BITS_PER_INT   (BITS_PER_CHAR * sizeof (int))
-#endif
-#ifndef BITS_PER_LONG
-#define BITS_PER_LONG  (BITS_PER_CHAR * sizeof (long))
-#endif
-#ifndef BITS_PER_LLONG
-#define BITS_PER_LLONG (BITS_PER_CHAR * sizeof (long long))
-#endif
-
-/* count set bits:  10101000 -> 3
- *                  ^ ^ ^
- */
-static __always_inline int popcount64(u64 n)
-{
-#   if __has_builtin(__builtin_popcountl)
-    return __builtin_popcountl(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_ctzl)
-    return __builtin_ctzl(n);
-
-#   elif __has_builtin(__builtin_clzl)
-    return __WORDSIZE - (__builtin_clzl(n & -n) + 1);
-
-#   else
-    return popcount64((n & -n) - 1);
-#   endif
-}
-
-static __always_inline int ctz32(u32 n)
-{
-#   if __has_builtin(__builtin_ctz)
-    return __builtin_ctzl(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_clzl)
-    return __builtin_clzl(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 - find last set : 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);
-}
-
-/* find first set :  00101000 -> 4
- *                       ^
- */
-static __always_inline uint ffs64(u64 n)
-{
-#   if __has_builtin(__builtin_ffsl)
-    return __builtin_ffsl(n);
-
-#   elif __has_builtin(__builtin_ctzl)
-    if (n == 0)
-        return (0);
-    return __builtin_ctzl(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 = ffs64(tmp); tmp; tmp &= (tmp - 1),  pos = ffs64(tmp))
-
-#define bit_for_each32(pos, tmp, ul)                                    \
-    for (tmp = ul, pos = ffs32(tmp); tmp; tmp &= (tmp - 1),  pos = ffs32(tmp))
-
-/** or would it be more useful (counting bits from zero instead of 1) ?
- */
-#define bit_for_each64_2(pos, tmp, ul)                                  \
-    for (tmp = ul, pos = ctz64(tmp); tmp; tmp ^= 1UL << pos, pos = ctz64(tmp))
-
-#define bit_for_each32_2(pos, tmp, ul)                                  \
-    for (tmp = ul, pos = ctz32(tmp); tmp; tmp ^= 1U << pos, pos = ctz32(tmp))
-
-#endif  /* _BITS_H */

c/brlib/include/bug.h

@@ -1,71 +0,0 @@
-/* SPDX-License-Identifier: GPL-2.0 */
-#ifndef _BR_BUG_H
-#define _BR_BUG_H
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <stdarg.h>
-#include "likely.h"
-#include "debug.h"
-
-/* BUG functions inspired by Linux kernel's <asm/bug.h>
- */
-
-#define panic() exit(0xff)
-
-/*
- * Don't use BUG() or BUG_ON() unless there's really no way out; one
- * 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.
- *
- * 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__); \
-        panic();                                                                        \
-    } while (0)
-
-#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
- * significant kernel 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 */

c/brlib/include/debug.h

@@ -1,99 +0,0 @@
-/* debug.h - debug/log management.
- *
- * 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 DEBUG_H
-#define DEBUG_H
-
-#include <stdbool.h>
-#include <stdint.h>
-
-#include <bits.h>
-
-#define _unused __attribute__((__unused__))
-#define _printf __attribute__ ((format (printf, 6, 7)))
-
-#ifdef DEBUG_DEBUG
-void debug_init(u32 level);
-void debug_level_set(u32 level);
-u32  debug_level_get(void);
-void _printf debug(u32 level, bool timestamp,
-                   u32 indent, const char *src,
-                   u32 line, const char *fmt, ...);
-#else  /* DEBUG_DEBUG */
-static inline void debug_init(_unused u32 level) {}
-static inline void debug_level_set(_unused u32 level) {}
-static inline void _printf debug(_unused u32 level, _unused bool timestamp,
-                                 _unused u32 indent, _unused const char *src,
-                                 _unused u32 line, _unused const char *fmt, ...) {}
-#endif  /* DEBUG_DEBUG */
-#undef _unused
-#undef _printf
-
-/**
- * log - simple log (no function name, no indent, no timestamp)
- * @level:      log level
- * @fmt:        printf format string
- * @args:       subsequent arguments to printf
- */
-#define log(level, fmt, args...) \
-    debug((level), false, 0, NULL, 0, fmt, ##args)
-
-/**
- * log_i - log with indent (no function name, no timestamp)
- * @level:      log level
- * @fmt:        printf format string
- * @args:       subsequent arguments to printf
- *
- * Output example:
- * >>>>val=2
- */
-#define log_i(level, fmt, args...) \
-    debug((level), false, (level), NULL, 0, fmt, ##args)
-
-/**
- * log_f - log with function name (no indent name, no timestamp)
- * @level:      log level
- * @fmt:        printf format string
- * @args:       subsequent arguments to printf
- *
- * Output example:
- * [function] val=2
- */
-#define log_f(level, fmt, args...) \
-    debug((level), false, 0, __func__, 0, fmt, ##args)
-
-/**
- * log_if - log with function name and line number (no indent name, no timestamp)
- * @level:      log level
- * @fmt:        printf format string
- * @args:       subsequent arguments to printf
- *
- * Output example:
- * >>>> [function:15] val=2
- */
-#define log_if(level, fmt, args...) \
-    debug((level), false, (level), __func__, __LINE__, fmt, ##args)
-
-/**
- * log_it - log with function name, line number, indent, and timestamp
- * @level:      log level
- * @fmt:        printf format string
- * @args:       subsequent arguments to printf
- *
- * Output example:
- * >>>> [function:15] val=2
- */
-#define log_it(level, fmt, args...) \
-    debug((level), true, (level), __func__, __LINE__, fmt, ##args)
-
-#endif /* DEBUG_H */

c/brlib/src/debug.c

@@ -1,111 +0,0 @@
-/* debug.c - debug/log management
- *
- * 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>
- *
- */
-
-#include <stdio.h>
-#include <stdarg.h>
-#include <time.h>
-
-#ifndef DEBUG_DEBUG
-#define DEBUG_DEBUG
-#endif
-
-#include "bits.h"
-#include "debug.h"
-
-#define NANOSEC  1000000000                       /* nano sec in sec */
-#define MILLISEC 1000000                          /* milli sec in sec */
-
-static long long timer_start;                     /* in nanosecond */
-static u32 debug_level=0;
-
-void debug_level_set(u32 level)
-{
-    debug_level = level;
-
-    log(1, "debug level set to %u\n", level);
-}
-
-void debug_init(u32 level)
-{
-    struct timespec timer;
-
-    debug_level_set(level);
-    if (!clock_gettime(CLOCK_MONOTONIC, &timer)) {
-        timer_start = timer.tv_sec * NANOSEC + timer.tv_nsec;
-    }
-    else {
-        timer_start = 0;
-    }
-    log(0, "timer started.\n");
-}
-
-inline static long long timer_elapsed()
-{
-    struct timespec timer;
-
-    clock_gettime(CLOCK_MONOTONIC, &timer);
-    return (timer.tv_sec * NANOSEC + timer.tv_nsec) - timer_start;
-}
-
-/* void debug - log function
- * @timestamp : boolean
- * @indent    : indent level (2 spaces each)
- * @src       : source file/func name (or NULL)
- * @line      : line number
- */
-void debug(u32 level, bool timestamp, u32 indent, const char *src,
-           u32 line, const char *fmt, ...)
-{
-    if (level > debug_level)
-        return;
-
-    va_list ap;
-
-    if (indent)
-        printf("%*s", 2*(indent-1), "");
-
-    if (timestamp) {
-        long long diff = timer_elapsed();
-        printf("%lld.%03lld ", diff/NANOSEC, (diff/1000000)%1000);
-        printf("%010lld ", diff);
-    }
-
-    if (src) {
-        if (line)
-            printf("[%s:%u] ", src, line);
-        else
-            printf("[%s] ", src);
-    }
-    va_start(ap, fmt);
-    vprintf(fmt, ap);
-    va_end(ap);
-}
-
-#ifdef BIN_debug
-#include <unistd.h>
-
-int main()
-{
-    int foo=1;
-    debug_init(5);
-
-    log(0, "log0=%d\n", foo++);
-    log(1, "log1=%d\n", foo++);
-    log(2, "log2=%d\n", foo++);
-    log_i(2, "log_i 2=%d\n", foo++);
-    log_i(5, "log_i 5=%d\n", foo++);
-    log_i(6, "log_i 6=%d\n", foo++);
-    log_it(4, "log_it 4=%d\n", foo++);
-    log_f(1, "log_f 5=%d\n", foo++);
-}
-#endif

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

@@ -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 "brlib.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 "brlib.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-emulated/generic-ilog2.h

@@ -0,0 +1,60 @@
+/* generic-ilog2.h - generic ilog2 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_ILOG2_H_
+#define _GENERIC_ILOG2_H_
+
+#include "brlib.h"
+
+/*
+ * See https://stackoverflow.com/a/11398748/3079831
+ */
+static const int __ilog2_32_table[32] = {
+    0,  9,  1, 10, 13, 21,  2, 29,
+    11, 14, 16, 18, 22, 25,  3, 30,
+    8, 12, 20, 28, 15, 17, 24,  7,
+    19, 27, 23,  6, 26,  5,  4, 31
+};
+
+static const int __ilog2_64_table[64] = {
+    63,  0, 58,  1, 59, 47, 53,  2,
+    60, 39, 48, 27, 54, 33, 42,  3,
+    61, 51, 37, 40, 49, 18, 28, 20,
+    55, 30, 34, 11, 43, 14, 22,  4,
+    62, 57, 46, 52, 38, 26, 32, 41,
+    50, 36, 17, 19, 29, 10, 13, 21,
+    56, 45, 25, 31, 35, 16,  9, 12,
+    44, 24, 15,  8, 23,  7,  6,  5
+};
+
+static __always_inline __const int __ilog2_32_emulated (u32 n)
+{
+    n |= n >> 1;
+    n |= n >> 2;
+    n |= n >> 4;
+    n |= n >> 8;
+    n |= n >> 16;
+    return __ilog2_32_table[(n*0x07C4ACDD) >> 27];
+}
+
+static __always_inline __const int __ilog2_64_emulated (u64 n)
+{
+    n |= n >> 1;
+    n |= n >> 2;
+    n |= n >> 4;
+    n |= n >> 8;
+    n |= n >> 16;
+    n |= n >> 32;
+    return __ilog2_64_table[((n - (n >> 1))*0x07EDD5E59A4E28C2LL) >> 58];
+}
+
+#endif /* _GENERIC_ILOG2_H_ */

include/bitops.h

@@ -0,0 +1,281 @@
+/* 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 "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
+#endif
+
+/* 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
+#if __has_builtin(__builtin_bswap32)
+#   define HAS_BSWAP
+#endif
+
+/**
+ * print_bitops_impl() - print bitops implementation.
+ *
+ * For basic bitops (popcount, ctz, etc...), print the implementation
+ * (builtin, emulated, ...).
+ */
+void print_bitops_impl(void);
+
+/* no plan to support 32bits for now...
+ * #if __WORDSIZE != 64
+ * #error "Only 64 bits word size supported."
+ * #endif
+ */
+
+/**
+ * lsb, msb: 0-indexed 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
+ * @n: 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
+ * @n: 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
+ *
+ * @n: 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: 00101010 -> 2
+ * @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_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))
+
+/**
+ * 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.
+ *
+ * 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)
+
+/*
+ * rol32, rot64 - rotate left
+ * @num: unsigned 8, 16, 32 or 64 bits integer
+ * @n: bits to roll
+ * See: https://stackoverflow.com/a/31488147/3079831
+ */
+#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_32, ilog2_64 - log base 2
+ * @n: unsigned 32 or 64 bits integer.
+ *
+ * Undefine value if n = 0.
+ */
+#define ilog2_32(n) (msb32(n))
+#define ilog2_64(n) (msb64(n))
+
+/**
+ * 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
+ * @u:    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, u)                  \
+    for (tmp = u, 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, u)              \
+    for (tmp = u, 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/brlib.h

@@ -1,6 +1,6 @@
-/* br.h - misc macros.
+/* brlib.h - misc types/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.
  *
@@ -15,11 +15,57 @@
  * 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 */
 
 #include "struct-group.h"
 
+/* fixed-size types
+ */
+typedef int64_t  s64;
+typedef int32_t  s32;
+typedef int16_t  s16;
+typedef int8_t   s8;
+
+typedef uint64_t u64;
+typedef uint32_t u32;
+typedef uint16_t u16;
+typedef uint8_t  u8;
+
+/* convenience types
+ */
+typedef long long          llong;
+typedef unsigned long long ullong;
+typedef unsigned long int  ulong;
+typedef unsigned int       uint;
+typedef unsigned short     ushort;
+typedef unsigned char      uchar;
+/* char is a special case, as it can be signed or unsigned
+ */
+typedef signed char schar;
+
+/* define common types sizes
+ */
+#define BITS_PER_CHAR 8
+
+#ifndef BITS_PER_SHORT
+#define BITS_PER_SHORT (BITS_PER_CHAR * sizeof (short))
+#endif
+#ifndef BITS_PER_INT
+#define BITS_PER_INT   (BITS_PER_CHAR * sizeof (int))
+#endif
+#ifndef BITS_PER_LONG
+#define BITS_PER_LONG  (BITS_PER_CHAR * sizeof (long))
+#endif
+#ifndef BITS_PER_LLONG
+#define BITS_PER_LLONG (BITS_PER_CHAR * sizeof (long long))
+#endif
+
 /* Indirect stringification.  Doing two levels allows the parameter to be a
  * macro itself.  For example, compile with -DFOO=bar, __stringify(FOO)
  * converts to "bar".
@@ -43,6 +89,7 @@
  */
 #define __unused             __attribute__((__unused__))
 #define __used               __attribute__((__used__))
+#define __const              __attribute__((__const__))
 
 /* see https://lkml.org/lkml/2018/3/20/845 for explanation of this monster
  */
@@ -221,4 +268,4 @@
 	({ signed type __x = (x); __x < 0 ? -__x : __x; }), other)
 
 
-#endif  /* _BR_H */
+#endif  /* _BRLIB_H */

include/bug.h

@@ -0,0 +1,61 @@
+/* bug.h - bug_on/warn_on/warn 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 BUG_H
+#define BUG_H
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <stdbool.h>
+#include <stdarg.h>
+
+#define bug_on_always(expr) do {                                      \
+        if (expr) {                                                   \
+            fprintf(stderr,                                           \
+                    "** BUG ON %s[%s:%d]: assertion '%s' failed.\n",  \
+                    __func__, __FILE__,__LINE__, #expr);                    \
+            abort();                                                  \
+            /* not reached */                                         \
+        }                                                             \
+    } while (0)
+
+#define warn(expr, args...) ({                                        \
+        int _ret = !!(expr);                                          \
+        if (_ret)                                                     \
+            fprintf(stderr, ##args);                                  \
+        _ret;                                                         \
+    })
+
+#define warn_on_always(expr) ({                                       \
+            warn(expr,                                                \
+                 "** WARN ON %s[%s:%d]: assertion '%s' failed.\n",    \
+                 __func__, __FILE__,__LINE__, #expr);                       \
+        })
+
+#ifdef BUG_ON
+
+#define bug_on(expr)          bug_on_always(expr)
+
+#define warn_on(expr)         warn_on_always(expr)
+#define warn_on_or_eval(expr) warn_on(expr)
+
+#else
+
+#define bug_on(expr)
+
+#define warn_on(expr)
+#define warn_on_or_eval(expr) (expr)
+
+#endif  /* BUG_ON */
+
+#endif /* BUG_H */

include/debug.h

@@ -0,0 +1,166 @@
+/* debug.h - debug/log management.
+ *
+ * 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 DEBUG_H
+#define DEBUG_H
+
+#include <stdio.h>
+#include <stdbool.h>
+
+#include "brlib.h"
+
+#define NANOSEC  1000000000                       /* nano sec in sec */
+#define MILLISEC 1000000                          /* milli sec in sec */
+
+#define _printf __attribute__ ((format (printf, 6, 7)))
+
+#ifdef DEBUG_DEBUG
+
+/**
+ * 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);
+
+/**
+ * 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, ...);
+
+#else  /* DEBUG_DEBUG */
+
+static inline void debug_init(__unused int level,
+                              __unused FILE *stream,
+                              __unused bool flush) {}
+static inline void debug_level_set(__unused int level) {}
+static inline int debug_level_get(void) {return 0;}
+static inline void debug_stream_set(__unused FILE *stream) {}
+static inline long long debug_timer_elapsed(void) {return 0LL;}
+static inline void debug_flush_set(__unused bool level) {}
+static inline void _printf debug(__unused int level, __unused bool timestamp,
+                                 __unused int indent, __unused const char *src,
+                                 __unused int line, __unused const char *fmt, ...) {}
+
+#endif  /* DEBUG_DEBUG */
+
+#undef _printf
+
+/**
+ * log - simple log (no function name, no indent, no timestamp)
+ * @level:      log level
+ * @fmt:        printf format string
+ * @args:       subsequent arguments to printf
+ */
+#define log(level, fmt, args...) \
+    debug((level), false, 0, NULL, 0, fmt, ##args)
+
+/**
+ * log_i - log with indent (no function name, no timestamp)
+ * @level:      log level
+ * @fmt:        printf format string
+ * @args:       subsequent arguments to printf
+ *
+ * Output example:
+ * >>>>val=2
+ */
+#define log_i(level, fmt, args...) \
+    debug((level), false, (level), NULL, 0, fmt, ##args)
+
+/**
+ * log_f - log with function name (no indent name, no timestamp)
+ * @level:      log level
+ * @fmt:        printf format string
+ * @args:       subsequent arguments to printf
+ *
+ * Output example:
+ * [function] val=2
+ */
+#define log_f(level, fmt, args...) \
+    debug((level), false, 0, __func__, 0, fmt, ##args)
+
+/**
+ * log_if - log with function name and line number (no indent name, no timestamp)
+ * @level:      log level
+ * @fmt:        printf format string
+ * @args:       subsequent arguments to printf
+ *
+ * Output example:
+ * >>>> [function:15] val=2
+ */
+#define log_if(level, fmt, args...) \
+    debug((level), false, (level), __func__, __LINE__, fmt, ##args)
+
+/**
+ * log_it - log with function name, line number, indent, and timestamp
+ * @level:      log level
+ * @fmt:        printf format string
+ * @args:       subsequent arguments to printf
+ *
+ * Output example:
+ * >>>> [function:15] val=2
+ */
+#define log_it(level, fmt, args...) \
+    debug((level), true, (level), __func__, __LINE__, fmt, ##args)
+
+#endif /* DEBUG_H */

include/hash.h

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

include/list_sort.h

@@ -0,0 +1,18 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+
+/*
+ * Taken from linux kernel: lib/list_sort.c
+ */
+
+#ifndef _BR_LIST_SORT_H
+#define _BR_LIST_SORT_H
+
+struct list_head;
+
+typedef int __attribute__((nonnull(2,3))) (*list_cmp_func_t)(void *,
+		const struct list_head *, const struct list_head *);
+
+__attribute__((nonnull(2,3)))
+void list_sort(void *priv, struct list_head *head, list_cmp_func_t cmp);
+
+#endif  /* _BR_LIST_SORT */

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 "brlib.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 "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

@@ -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 "brlib.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,32 @@
+#!/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_ROOT=$(realpath -L "$(dirname "${BASH_SOURCE[0]}")/..")
+
+    BRLIB_SCRIPTDIR="$BRLIB_ROOT/scripts"
+    BRLIB_BINDIR="$BRLIB_ROOT/bin"
+    PATH="$PATH:$BRLIB_BINDIR:$BRLIB_SCRIPTDIR"
+
+    BRLIB_LIBDIR="$BRLIB_ROOT/lib"
+    LD_LIBRARY_PATH="${BRLIB_LIBDIR}${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}"
+    #printf "R=%s L=%s LD=%s\n" "$BRLIB_ROOT" "$BRLIB_DIR" "$LD_LIBRARY_PATH"
+    unset BRLIB_SCRIPTDIR BRLIB_BINDIR BRLIB_LIBDIR
+    printf "brlib environment complete.\n"
+fi

scripts/submodules-upd.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+git submodule update --remote --merge

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,16 +11,10 @@
  *
  */
 
-#include "bits.h"
+#include "bitops.h"
 #include "debug.h"
 
-/**
+void print_bitops_impl(void)
- * bits_implementation - display bitops implementation.
- *
- * For basic bitops (popcount, ctz, etc...), print the implementation
- * (builtin, emulated).
- */
-void bits_implementation(void)
 {
     log(0, "bitops implementation: ");
 

src/debug.c

@@ -0,0 +1,111 @@
+
+/* debug.c - debug/log management
+ *
+ * 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>
+ *
+ */
+
+#include <stdio.h>
+#include <stdarg.h>
+#include <time.h>
+
+#ifndef DEBUG_DEBUG
+#define DEBUG_DEBUG
+#endif
+
+#include "debug.h"
+
+static long long timer_start;                     /* in nanosecond */
+static int level = 0;                             /* output log when < level */
+static int flush = false;                         /* force flush after logs */
+static FILE *stream = NULL;                       /* stream to use */
+
+void debug_level_set(int _level)
+{
+    level = _level;
+#   ifdef DEBUG_DEBUG_C
+    log(0, "debug level set to %u\n", level);
+#   endif
+}
+
+int debug_level_get(void)
+{
+    return level;
+}
+
+void debug_stream_set(FILE *_stream)
+{
+    stream = _stream;
+#   ifdef DEBUG_DEBUG_C
+    log(0, "stream set to %d\n", stream? fileno(stream): -1);
+#   endif
+}
+
+void debug_flush_set(bool _flush)
+{
+    flush = _flush;
+#   ifdef DEBUG_DEBUG_C
+    log(0, "debug flush %s.\n", flush? "set": "unset");
+#   endif
+}
+
+void debug_init(int _level, FILE *_stream, bool _flush)
+{
+    struct timespec timer;
+
+    debug_stream_set(_stream);
+    debug_level_set(_level);
+    debug_flush_set(_flush);
+    if (!clock_gettime(CLOCK_MONOTONIC, &timer)) {
+        timer_start = timer.tv_sec * NANOSEC + timer.tv_nsec;
+    }
+    else {
+        timer_start = 0;
+    }
+    log(0, "timer started.\n");
+}
+
+long long debug_timer_elapsed(void)
+{
+    struct timespec timer;
+
+    clock_gettime(CLOCK_MONOTONIC, &timer);
+    return (timer.tv_sec * NANOSEC + timer.tv_nsec) - timer_start;
+}
+
+void debug(int lev, bool timestamp, int indent, const char *src,
+           int line, const char *fmt, ...)
+{
+    if (!stream || lev > level)
+        return;
+
+    va_list ap;
+
+    if (indent)
+        fprintf(stream, "%*s", 2*(indent-1), "");
+
+    if (timestamp) {
+        long long diff = debug_timer_elapsed();
+        fprintf(stream, "%lld.%03lld ", diff/NANOSEC, (diff/1000000)%1000);
+        fprintf(stream, "%010lld ", diff);
+    }
+
+    if (src) {
+        if (line)
+            fprintf(stream, "[%s:%u] ", src, line);
+        else
+            fprintf(stream, "[%s] ", src);
+    }
+    va_start(ap, fmt);
+    vfprintf(stream, fmt, ap);
+    va_end(ap);
+    if (flush)
+        fflush(stream);
+}

src/list_sort.c

@@ -0,0 +1,253 @@
+// SPDX-License-Identifier: GPL-2.0
+
+/*
+ * Taken from linux kernel: lib/list_sort.c
+ */
+#include "brlib.h"
+#include "list_sort.h"
+#include "list.h"
+#include "likely.h"
+
+/*
+ * Returns a list organized in an intermediate format suited
+ * to chaining of merge() calls: null-terminated, no reserved or
+ * sentinel head node, "prev" links not maintained.
+ */
+__attribute__((nonnull(2,3,4)))
+static struct list_head *merge(void *priv, list_cmp_func_t cmp,
+				struct list_head *a, struct list_head *b)
+{
+	struct list_head *head, **tail = &head;
+
+	for (;;) {
+		/* if equal, take 'a' -- important for sort stability */
+		if (cmp(priv, a, b) <= 0) {
+			*tail = a;
+			tail = &a->next;
+			a = a->next;
+			if (!a) {
+				*tail = b;
+				break;
+			}
+		} else {
+			*tail = b;
+			tail = &b->next;
+			b = b->next;
+			if (!b) {
+				*tail = a;
+				break;
+			}
+		}
+	}
+	return head;
+}
+
+/*
+ * Combine final list merge with restoration of standard doubly-linked
+ * list structure.  This approach duplicates code from merge(), but
+ * runs faster than the tidier alternatives of either a separate final
+ * prev-link restoration pass, or maintaining the prev links
+ * throughout.
+ */
+__attribute__((nonnull(2,3,4,5)))
+static void merge_final(void *priv, list_cmp_func_t cmp, struct list_head *head,
+			struct list_head *a, struct list_head *b)
+{
+	struct list_head *tail = head;
+	u8 count = 0;
+
+	for (;;) {
+		/* if equal, take 'a' -- important for sort stability */
+		if (cmp(priv, a, b) <= 0) {
+			tail->next = a;
+			a->prev = tail;
+			tail = a;
+			a = a->next;
+			if (!a)
+				break;
+		} else {
+			tail->next = b;
+			b->prev = tail;
+			tail = b;
+			b = b->next;
+			if (!b) {
+				b = a;
+				break;
+			}
+		}
+	}
+
+	/* Finish linking remainder of list b on to tail */
+	tail->next = b;
+	do {
+		/*
+		 * If the merge is highly unbalanced (e.g. the input is
+		 * already sorted), this loop may run many iterations.
+		 * Continue callbacks to the client even though no
+		 * element comparison is needed, so the client's cmp()
+		 * routine can invoke cond_resched() periodically.
+		 */
+		if (unlikely(!++count))
+			cmp(priv, b, b);
+		b->prev = tail;
+		tail = b;
+		b = b->next;
+	} while (b);
+
+	/* And the final links to make a circular doubly-linked list */
+	tail->next = head;
+	head->prev = tail;
+}
+
+/**
+ * list_sort - sort a list
+ * @priv: private data, opaque to list_sort(), passed to @cmp
+ * @head: the list to sort
+ * @cmp: the elements comparison function
+ *
+ * The comparison function @cmp must return > 0 if @a should sort after
+ * @b ("@a > @b" if you want an ascending sort), and <= 0 if @a should
+ * sort before @b *or* their original order should be preserved.  It is
+ * always called with the element that came first in the input in @a,
+ * and list_sort is a stable sort, so it is not necessary to distinguish
+ * the @a < @b and @a == @b cases.
+ *
+ * This is compatible with two styles of @cmp function:
+ * - The traditional style which returns <0 / =0 / >0, or
+ * - Returning a boolean 0/1.
+ * The latter offers a chance to save a few cycles in the comparison
+ * (which is used by e.g. plug_ctx_cmp() in block/blk-mq.c).
+ *
+ * A good way to write a multi-word comparison is::
+ *
+ *	if (a->high != b->high)
+ *		return a->high > b->high;
+ *	if (a->middle != b->middle)
+ *		return a->middle > b->middle;
+ *	return a->low > b->low;
+ *
+ *
+ * This mergesort is as eager as possible while always performing at least
+ * 2:1 balanced merges.  Given two pending sublists of size 2^k, they are
+ * merged to a size-2^(k+1) list as soon as we have 2^k following elements.
+ *
+ * Thus, it will avoid cache thrashing as long as 3*2^k elements can
+ * fit into the cache.  Not quite as good as a fully-eager bottom-up
+ * mergesort, but it does use 0.2*n fewer comparisons, so is faster in
+ * the common case that everything fits into L1.
+ *
+ *
+ * The merging is controlled by "count", the number of elements in the
+ * pending lists.  This is beautifully simple code, but rather subtle.
+ *
+ * Each time we increment "count", we set one bit (bit k) and clear
+ * bits k-1 .. 0.  Each time this happens (except the very first time
+ * for each bit, when count increments to 2^k), we merge two lists of
+ * size 2^k into one list of size 2^(k+1).
+ *
+ * This merge happens exactly when the count reaches an odd multiple of
+ * 2^k, which is when we have 2^k elements pending in smaller lists,
+ * so it's safe to merge away two lists of size 2^k.
+ *
+ * After this happens twice, we have created two lists of size 2^(k+1),
+ * which will be merged into a list of size 2^(k+2) before we create
+ * a third list of size 2^(k+1), so there are never more than two pending.
+ *
+ * The number of pending lists of size 2^k is determined by the
+ * state of bit k of "count" plus two extra pieces of information:
+ *
+ * - The state of bit k-1 (when k == 0, consider bit -1 always set), and
+ * - Whether the higher-order bits are zero or non-zero (i.e.
+ *   is count >= 2^(k+1)).
+ *
+ * There are six states we distinguish.  "x" represents some arbitrary
+ * bits, and "y" represents some arbitrary non-zero bits:
+ * 0:  00x: 0 pending of size 2^k;           x pending of sizes < 2^k
+ * 1:  01x: 0 pending of size 2^k; 2^(k-1) + x pending of sizes < 2^k
+ * 2: x10x: 0 pending of size 2^k; 2^k     + x pending of sizes < 2^k
+ * 3: x11x: 1 pending of size 2^k; 2^(k-1) + x pending of sizes < 2^k
+ * 4: y00x: 1 pending of size 2^k; 2^k     + x pending of sizes < 2^k
+ * 5: y01x: 2 pending of size 2^k; 2^(k-1) + x pending of sizes < 2^k
+ * (merge and loop back to state 2)
+ *
+ * We gain lists of size 2^k in the 2->3 and 4->5 transitions (because
+ * bit k-1 is set while the more significant bits are non-zero) and
+ * merge them away in the 5->2 transition.  Note in particular that just
+ * before the 5->2 transition, all lower-order bits are 11 (state 3),
+ * so there is one list of each smaller size.
+ *
+ * When we reach the end of the input, we merge all the pending
+ * lists, from smallest to largest.  If you work through cases 2 to
+ * 5 above, you can see that the number of elements we merge with a list
+ * of size 2^k varies from 2^(k-1) (cases 3 and 5 when x == 0) to
+ * 2^(k+1) - 1 (second merge of case 5 when x == 2^(k-1) - 1).
+ */
+__attribute__((nonnull(2,3)))
+void list_sort(void *priv, struct list_head *head, list_cmp_func_t cmp)
+{
+	struct list_head *list = head->next, *pending = NULL;
+	size_t count = 0;	/* Count of pending */
+
+	if (list == head->prev)	/* Zero or one elements */
+		return;
+
+	/* Convert to a null-terminated singly-linked list. */
+	head->prev->next = NULL;
+
+	/*
+	 * Data structure invariants:
+	 * - All lists are singly linked and null-terminated; prev
+	 *   pointers are not maintained.
+	 * - pending is a prev-linked "list of lists" of sorted
+	 *   sublists awaiting further merging.
+	 * - Each of the sorted sublists is power-of-two in size.
+	 * - Sublists are sorted by size and age, smallest & newest at front.
+	 * - There are zero to two sublists of each size.
+	 * - A pair of pending sublists are merged as soon as the number
+	 *   of following pending elements equals their size (i.e.
+	 *   each time count reaches an odd multiple of that size).
+	 *   That ensures each later final merge will be at worst 2:1.
+	 * - Each round consists of:
+	 *   - Merging the two sublists selected by the highest bit
+	 *     which flips when count is incremented, and
+	 *   - Adding an element from the input as a size-1 sublist.
+	 */
+	do {
+		size_t bits;
+		struct list_head **tail = &pending;
+
+		/* Find the least-significant clear bit in count */
+		for (bits = count; bits & 1; bits >>= 1)
+			tail = &(*tail)->prev;
+		/* Do the indicated merge */
+		if (likely(bits)) {
+			struct list_head *a = *tail, *b = a->prev;
+
+			a = merge(priv, cmp, b, a);
+			/* Install the merged result in place of the inputs */
+			a->prev = b->prev;
+			*tail = a;
+		}
+
+		/* Move one element from input list to pending */
+		list->prev = pending;
+		pending = list;
+		list = list->next;
+		pending->next = NULL;
+		count++;
+	} while (list);
+
+	/* End of input; merge together all the pending lists. */
+	list = pending;
+	pending = pending->prev;
+	for (;;) {
+		struct list_head *next = pending->prev;
+
+		if (!next)
+			break;
+		list = merge(priv, cmp, pending, list);
+		pending = next;
+	}
+	/* The final merge, rebuilding prev links */
+	merge_final(priv, cmp, head, pending, list);
+}

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/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

@@ -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 "brlib.h"
 #include "list.h"
 #include "pool.h"
 #include "debug.h"
-#include "bits.h"
 
 void pool_stats(pool_t *pool)
 {
@@ -161,59 +161,3 @@ void pool_destroy(pool_t *pool)
 #   endif
     free(pool);
 }
-
-#ifdef BIN_pool
-struct d {
-    u16 data1;
-    char c;
-    struct list_head list;
-};
-
-static LIST_HEAD (head);
-
-int main(int ac, char**av)
-{
-    pool_t *pool;
-    int total;
-    int action=0;
-    u16 icur=0;
-    char ccur='z';
-    struct d *elt;
-
-    debug_init(3);
-    log_f(1, "%s: sizeof(d)=%lu sizeof(*d)=%lu off=%lu\n", *av, sizeof(elt),
-          sizeof(*elt), offsetof(struct d, list));
-
-    if ((pool = pool_create("dummy", 3, sizeof(*elt)))) {
-        pool_stats(pool);
-        for (int cur=1; cur<ac; ++cur) {
-            total = atoi(av[cur]);
-            if (action == 0) {                    /* add elt to list */
-                log_f(2, "adding %d elements\n", total);
-                for (int i = 0; i < total; ++i) {
-                    elt = pool_get(pool);
-                    elt->data1 = icur++;
-                    elt->c = ccur--;
-                    list_add(&elt->list, &head);
-                }
-                pool_stats(pool);
-                action = 1;
-            } else {                              /* remove one elt from list */
-                log_f(2, "deleting %d elements\n", total);
-                for (int i = 0; i < total; ++i) {
-                    if (!list_empty(&head)) {
-                        elt = list_last_entry(&head, struct d, list);
-                        printf("elt=[%d, %c]\n", elt->data1, elt->c);
-                        list_del(&elt->list);
-                        pool_add(pool, elt);
-                    }
-                }
-                pool_stats(pool);
-                action = 0;
-            }
-        }
-    }
-    pool_stats(pool);
-    pool_destroy(pool);
-}
-#endif

test/bitops-test.c

@@ -0,0 +1,364 @@
+/* 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 "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;
+    int ffs;
+    int ffz;
+    int fls;
+    int ilog2;
+    struct {
+        int size;
+        uchar bfe[32];
+    };
+} test32_1[] = {
+    { 0x00000000, 0x00000000, 0, 32, 32,  0, 1,  0,  0, /* sometimes undefined */
+      { 0, { 0 } } },
+    { 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, 0x01000000,  1,   0, 31,  1, 2,  1,  0,
+      { 1, { 0 } } },
+    { 0x80000000, 0x00000080,  1,  31,  0, 32, 1, 32, 31,
+      { 1, { 31 } } },
+    { 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, 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 } } },
+};
+
+static const struct test64_1 {
+    u64 t64;                                      /* input */
+    u64 bswap;
+    int popc;                                     /* some values may be undefined */
+    int ctz;
+    int clz;
+    int ffs;
+    int ffz;
+    int fls;
+    int ilog2;
+    struct {
+        int size;
+        uchar bfe[64];
+    };
+} test64_1[] = {
+    { 0x0000000000000000, 0x0000000000000000,  0, 64, 64,  0, 1,  0,  0,
+      { 0, { 0 } } },
+    { 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, 0x0100000001000000,  2,  0, 31,  1, 2, 33, 32,
+      { 2, { 0, 32 } } },
+    { 0x8000000000000000, 0x0000000000000080,  1, 63,  0, 64, 1, 64, 63,
+      { 1, { 63 } } },
+    { 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, 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,
+            32, 33, 34, 36, 37, 38, 39, 41, 42, 43, 45,
+            46, 47, 49, 50, 51, 53, 54, 55, 56, 57, 58 } } },
+};
+
+static void cutest_popcount(CuTest *tc)
+{
+    for (uint i = 0; i < ARRAY_SIZE(test32_1); ++i) {
+        int res = popcount32(test32_1[i].t32);
+        CuAssertIntEquals(tc, test32_1[i].popc, res);
+    }
+    for (uint i = 0; i < ARRAY_SIZE(test64_1); ++i) {
+        int res = popcount64(test64_1[i].t64);
+        CuAssertIntEquals(tc, test64_1[i].popc, res);
+    }
+}
+
+static void cutest_ctz(CuTest *tc)
+{
+    for (uint i = 0; i < ARRAY_SIZE(test32_1); ++i) {
+        int res = ctz32(test32_1[i].t32);
+        CuAssertIntEquals(tc, test32_1[i].ctz, res);
+    }
+    for (uint i = 0; i < ARRAY_SIZE(test64_1); ++i) {
+        int res = ctz64(test64_1[i].t64);
+        //printf("t=%#llx r=%d e=%d\n", test64_1[i].t64, res, test64_1[i].ctz);
+        CuAssertIntEquals(tc, test64_1[i].ctz, res);
+    }
+}
+
+static void cutest_clz(CuTest *tc)
+{
+    for (uint i = 0; i < ARRAY_SIZE(test32_1); ++i) {
+        int res = clz32(test32_1[i].t32);
+        //printf("clz t=%#x r=%d e=%d\n", test32_1[i].t32, res, test32_1[i].clz);
+        CuAssertIntEquals(tc, test32_1[i].clz, res);
+    }
+    for (uint i = 0; i < ARRAY_SIZE(test64_1); ++i) {
+        int res = clz64(test64_1[i].t64);
+        //printf("clz t=%#llx r=%d e=%d\n", test64_1[i].t64, res, test64_1[i].clz);
+        CuAssertIntEquals(tc, test64_1[i].clz, res);
+    }
+}
+
+static void cutest_ffs(CuTest *tc)
+{
+    for (uint i = 0; i < ARRAY_SIZE(test32_1); ++i) {
+        int res = ffs32(test32_1[i].t32);
+        CuAssertIntEquals(tc, test32_1[i].ffs, res);
+    }
+    for (uint i = 0; i < ARRAY_SIZE(test64_1); ++i) {
+        int res = ffs64(test64_1[i].t64);
+        //printf("ffs64 t=%#llx r=%d e=%d\n", test64_1[i].t64, res, test64_1[i].ffs);
+        CuAssertIntEquals(tc, test64_1[i].ffs, res);
+    }
+}
+
+static void cutest_ffz(CuTest *tc)
+{
+    for (uint i = 0; i < ARRAY_SIZE(test32_1); ++i) {
+        int res = ffz32(test32_1[i].t32);
+        //printf("ffz32 t=%#x r=%d e=%d\n", test32_1[i].t32, res, test32_1[i].ffz);
+        CuAssertIntEquals(tc, test32_1[i].ffz, res);
+    }
+    for (uint i = 0; i < ARRAY_SIZE(test64_1); ++i) {
+        int res = ffz64(test64_1[i].t64);
+        //printf("ffz64 t=%#llx r=%d e=%d\n", test64_1[i].t64, res, test64_1[i].ffz);
+        CuAssertIntEquals(tc, test64_1[i].ffz, res);
+    }
+}
+
+static void cutest_fls(CuTest *tc)
+{
+    for (uint i = 0; i < ARRAY_SIZE(test32_1); ++i) {
+        int res = fls32(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].fls, res);
+    }
+    for (uint i = 0; i < ARRAY_SIZE(test64_1); ++i) {
+        int res = fls64(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].fls, res);
+    }
+}
+
+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) {
+        if (!test32_1[i].t32) {
+            //printf("ilog2_32 t=%#x skipped\n", test32_1[i].t32);
+            continue;
+        }
+        int res = ilog2_32(test32_1[i].t32);
+        //printf("ilog2_32_n t=%#x r=%d e=%d\n", test32_1[i].t32,
+        //       res, test32_1[i].ilog2);
+        CuAssertIntEquals(tc, test32_1[i].ilog2, res);
+    }
+    for (uint i = 0; i < ARRAY_SIZE(test64_1); ++i) {
+        if (!test64_1[i].t64) {
+            //printf("ilog2_32 t=%#llx skipped\n", test64_1[i].t64);
+            continue;
+        }
+        int res = ilog2_64(test64_1[i].t64);
+        //printf("ilog2_64_n t=%#llx r=%d e=%d\n", test64_1[i].t64,
+        //       res, test64_1[i].ilog2);
+        CuAssertIntEquals(tc, test64_1[i].ilog2, res);
+    }
+}
+
+static void cutest_bfe(CuTest *tc)
+{
+    char s[64];
+
+    for (uint i = 0; i < ARRAY_SIZE(test32_1); ++i) {
+        u32 tmp;
+        int cur, nb = 0;
+        char bfe_ffs[32];
+
+        /* create bit_for_each32_ffs values */
+        for (int j = 0; j < test32_1[i].size; ++j)
+            bfe_ffs[j] = test32_1[i].bfe[j] + 1;
+
+        bit_for_each32(cur, tmp, test32_1[i].t32) {
+            s[nb++] = cur;
+        }
+        CuAssertIntEquals(tc, test32_1[i].size, nb);
+        CuAssertMemEquals(tc, test32_1[i].bfe, s, test32_1[i].size);
+        nb = 0;
+        bit_for_each32_ffs(cur, tmp, test32_1[i].t32) {
+            s[nb++] = cur;
+        }
+        CuAssertMemEquals(tc, bfe_ffs, s, test32_1[i].size);
+    }
+
+    for (uint i = 0; i < ARRAY_SIZE(test64_1); ++i) {
+        u64 tmp;
+        int cur, nb = 0;
+        char bfe_ffs[64];
+
+        /* create bit_for_each64_ffs values */
+        for (int j = 0; j < test64_1[i].size; ++j)
+            bfe_ffs[j] = test64_1[i].bfe[j] + 1;
+
+        bit_for_each64(cur, tmp, test64_1[i].t64) {
+            s[nb++] = cur;
+        }
+        //printf("\n64 nb=%d size=%d\n", nb, test64_1[i].size);
+        CuAssertIntEquals(tc, test64_1[i].size, nb);
+        CuAssertMemEquals(tc, test64_1[i].bfe, s, test64_1[i].size);
+        nb = 0;
+        bit_for_each64_ffs(cur, tmp, test64_1[i].t64) {
+            s[nb++] = cur;
+        }
+        CuAssertMemEquals(tc, bfe_ffs, s, test64_1[i].size);
+    }
+}
+
+struct test32_2 {
+    u32 t32;                                      /* input */
+    u32 arg;
+    u32 rol;
+    u32 ror;
+    struct {
+        int size;
+        uchar bfe[32];
+    };
+} test32_2[] = {
+    { 0x00000000, 0,  0, 0,
+      {  0, { 0 }  } },
+    { 0x00000000, 1,  0, 0,
+      {  0, { 0 }  } },
+    { 0x10000001, 2,  0x40000004, 0x44000000,
+      {  2, { 0, 28 } } },
+    { 0x80000008, 3,  0x00000044, 0x10000001,
+      {  2, { 3, 31 } } },
+    { 0x71800718, 8,  0x80071871, 0x18718007,
+      { 10, { 3, 4, 8, 9, 10, 23, 24, 28, 29, 30 } } },
+    { 0x07eeeef7, 4,  0x7eeeef70, 0x707eeeef,
+      { 22, { 0, 1, 2, 4, 5, 6, 7, 9, 10,
+            11, 13, 14, 15, 17, 18, 19,
+            21, 22, 23, 24, 25, 26 } } },
+};
+
+struct test64_2 {
+    u64 t64;                                      /* input */
+    u32 arg;
+    u64 rol;
+    u64 ror;
+} test64_2[] = {
+    { 0x0000000000000000, 0,  0, 0 },
+    { 0x0000000000000000, 1,  0, 0 },
+    { 0x1000000110000001, 2,  0x4000000440000004, 0x4400000044000000 },
+    { 0x8000000880000008, 3,  0x0000004400000044, 0x1000000110000001 },
+    { 0x7180071871800718, 8,  0x8007187180071871, 0x1871800718718007 },
+    { 0x07eeeef707eeeef7, 4,  0x7eeeef707eeeef70, 0x707eeeef707eeeef }
+};
+
+static void cutest_rol(CuTest *tc)
+{
+    for (uint i = 0; i < ARRAY_SIZE(test32_2); ++i) {
+        u32 res = rol32(test32_2[i].t32, test32_2[i].arg);
+        //printf("rol32 t=%#x a=%u r=%#08x e=%#08x\n", test32_2[i].t32,
+        //       test32_2[i].arg, res, test32_2[i].rol);
+        CuAssertU32Equals(tc, test32_2[i].rol, res);
+    }
+    for (uint i = 0; i < ARRAY_SIZE(test64_2); ++i) {
+        u64 res = rol64(test64_2[i].t64, test64_2[i].arg);
+        //printf("rol64 t=%#llx a=%u r=%#08llx e=%#08llx\n", test64_2[i].t64,
+        //       test64_2[i].arg, res, test64_2[i].rol);
+        CuAssertU64Equals(tc, test64_2[i].rol, res);
+    }
+}
+
+static void cutest_ror(CuTest *tc)
+{
+    for (uint i = 0; i < ARRAY_SIZE(test32_2); ++i) {
+        u32 res = ror32(test32_2[i].t32, test32_2[i].arg);
+        //printf("ror32 t=%#x a=%u r=%#08x e=%#08x\n", test32_2[i].t32,
+        //       test32_2[i].arg, res, test32_2[i].ror);
+        CuAssertU32Equals(tc, test32_2[i].ror, res);
+    }
+    for (uint i = 0; i < ARRAY_SIZE(test64_2); ++i) {
+        u64 res = ror64(test64_2[i].t64, test64_2[i].arg);
+        //printf("ror64 t=%#0llx a=%u r=%#08llx e=%#08llx\n", test64_2[i].t64,
+        //       test64_2[i].arg, res, test64_2[i].ror);
+        CuAssertU64Equals(tc, test64_2[i].ror, res);
+    }
+}
+
+static CuSuite *bitops_GetSuite()
+{
+    CuSuite* suite = CuSuiteNew();
+    SUITE_ADD_TEST(suite, cutest_popcount);
+    SUITE_ADD_TEST(suite, cutest_ctz);
+    SUITE_ADD_TEST(suite, cutest_clz);
+    SUITE_ADD_TEST(suite, cutest_ffs);
+    SUITE_ADD_TEST(suite, cutest_ffz);
+    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);
+    return suite;
+}
+
+static void RunAllTests(void)
+{
+    CuString *output = CuStringNew();
+    CuSuite* suite = CuSuiteNew();
+    CuSuiteAddSuite(suite, bitops_GetSuite());
+
+    CuSuiteRun(suite);
+    CuSuiteSummary(suite, output);
+    CuSuiteDetails(suite, output);
+    printf("%s\n", output->buffer);
+}
+
+int main()
+{
+    RunAllTests();
+    exit(0);
+}

test/pool-test.c

@@ -0,0 +1,60 @@
+#include <stdio.h>
+#include <stdlib.h>
+
+#include "brlib.h"
+#include "pool.h"
+#include "debug.h"
+
+struct d {
+    u16 data1;
+    char c;
+    struct list_head list;
+};
+
+static LIST_HEAD (head);
+
+int main(int ac, char**av)
+{
+    pool_t *pool;
+    int total;
+    int action=0;
+    u16 icur=0;
+    char ccur='z';
+    struct d *elt;
+
+    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));
+
+    if ((pool = pool_create("dummy", 3, sizeof(*elt)))) {
+        pool_stats(pool);
+        for (int cur=1; cur<ac; ++cur) {
+            total = atoi(av[cur]);
+            if (action == 0) {                    /* add elt to list */
+                log_f(2, "adding %d elements\n", total);
+                for (int i = 0; i < total; ++i) {
+                    elt = pool_get(pool);
+                    elt->data1 = icur++;
+                    elt->c = ccur--;
+                    list_add(&elt->list, &head);
+                }
+                pool_stats(pool);
+                action = 1;
+            } else {                              /* remove one elt from list */
+                log_f(2, "deleting %d elements\n", total);
+                for (int i = 0; i < total; ++i) {
+                    if (!list_empty(&head)) {
+                        elt = list_last_entry(&head, struct d, list);
+                        printf("elt=[%d, %c]\n", elt->data1, elt->c);
+                        list_del(&elt->list);
+                        pool_add(pool, elt);
+                    }
+                }
+                pool_stats(pool);
+                action = 0;
+            }
+        }
+    }
+    pool_stats(pool);
+    pool_destroy(pool);
+}

test/test/tst-debug.c

@@ -0,0 +1,17 @@
+#include <unistd.h>
+#include "debug.h"
+
+int main()
+{
+    int foo=1;
+    debug_init(5);
+
+    log(0, "log0=%d\n", foo++);
+    log(1, "log1=%d\n", foo++);
+    log(2, "log2=%d\n", foo++);
+    log_i(2, "log_i 2=%d\n", foo++);
+    log_i(5, "log_i 5=%d\n", foo++);
+    log_i(6, "log_i 6=%d\n", foo++);
+    log_it(4, "log_it 4=%d\n", foo++);
+    log_f(1, "log_f 5=%d\n", foo++);
+}