brlib Makefile

- new options:
  -l, --list-dictionaries: list dictionaries
  -n, --no-similar-chars:  avoid similar chars (0O/1l etc..)
- remove dead code

.gitignore

@@ -0,0 +1,11 @@
+.ccls*
+/*.c
+/*.sh
+/COPYING.*
+/license-*
+/LICENSE.*
+/test/
+/todo/
+/c/lib/
+/c/obj/
+compile_commands.json

bash/README.md

@@ -0,0 +1,11 @@
+### Some GNU/Linux tools, for fun...
+
+
+#### bash
+
+- [**trans.sh**](trans.sh): a [linguee.com](https://linguee.com) based command-line translator.
+- [**sync.sh**](sync.sh): a rsync/ssh backup tool.
+    - [**sync-conf-example.sh**](share/sync/sync-conf-example.sh): configuration example.
+- [**dup-live-disk.sh**](dup-live-disk.sh): duplicate (possibly live) disk partitions.
+- [**gen-password.sh**](gen-password.sh): a password generator
+    - [**share/gen-password**](share/gen-password): [diceware](https://en.wikipedia.org/wiki/Diceware)-like word lists.

bash/dup-live-disk.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 #
 # dup-live-disk.sh - duplicate (possibly live) system partitions
 #
@@ -147,16 +147,17 @@
 # command line
 SCRIPT="$0"
 CMD="${0##*/}"
+export LC_ALL=C
 
 # valid filesystems
 # shellcheck disable=2034
 VALIDFS=(ext3 ext4 btrfs vfat reiserfs xfs zfs)
 
-function man {
+man() {
     sed -n '/^#%MAN_BEGIN%/,/^#%MAN_END%$/{//!s/^#[ ]\{0,1\}//p}' "$SCRIPT" | more
 }
 
-function usage {
+usage() {
     cat <<_EOF
 Usage: $CMD [OPTIONS] [SRC] DST
 Duplicate SRC (or live system) disk partitions to DST disk partitions.
@@ -190,7 +191,7 @@ _EOF
 # -l, -s: long, or short prefix (default: none). Last one is used.
 # -t: timestamp
 # -n: no newline
-function log {
+log() {
     local timestr="" prefix="" opt=y newline=y
     while [[ $opt = y ]]; do
         case $1 in
@@ -211,7 +212,7 @@ function log {
 }
 
 # prints out and run (maybe) a command.
-function echorun_maybe {
+echorun_maybe() {
     if [[ "$DRYRUN" == 'yes' ]]; then
         log "dry-run: %s" "$*"
     else
@@ -246,7 +247,7 @@ yesno() {
 }
 
 # mariadb start/stop
-function mariadb_maybe_stop {
+mariadb_maybe_stop() {
     [[ $MARIADBSTOPPED == yes ]] && return 0
     if systemctl is-active --quiet mysql; then
         if [[ $MARIADB == ask ]]; then
@@ -268,7 +269,7 @@ function mariadb_maybe_stop {
     fi
 }
 
-function mariadb_maybe_start {
+mariadb_maybe_start() {
     if [[ $MARIADB == yes && $MARIADBSTOPPED == yes ]]; then
         #log -n "restarting mariadb/mysql... "
         echorun_maybe systemctl start mariadb
@@ -277,14 +278,14 @@ function mariadb_maybe_start {
     fi
 }
 
-function error_handler {
+error_handler() {
     local ERROR=$2
     log "FATAL: Error line $1, exit code $2. Aborting."
     exit "$ERROR"
 }
 trap 'error_handler $LINENO $?' ERR SIGHUP SIGINT SIGTERM
 
-function exit_handler {
+exit_handler() {
     local mnt
 
     # log "exit handler (at line $1)"
@@ -302,7 +303,11 @@ function exit_handler {
 }
 trap 'exit_handler $LINENO' EXIT
 
-function check_block_device {
+# check_block_device - check a file system device
+# $1: device description
+# $2: more ('w' for writable)
+# $3: device
+check_block_device() {
     local devtype="$1"
     local mode="$2"
     local dev="$3"
@@ -323,7 +328,7 @@ function check_block_device {
 }
 
 # check that /etc/fstab.DESTLABEL exists in SRC disk.
-function check_fstab {
+check_fstab() {
     local etc="${AUTOFS_DIR}/$SRCROOTLABEL/etc"
     local fstab="fstab.$DSTROOTLABEL"
     #if [[ "$FSTAB" != no ]]; then
@@ -336,7 +341,7 @@ function check_fstab {
     return 0
 }
 
-function fix_fstab {
+fix_fstab() {
     local fstab="${AUTOFS_DIR}/$DSTROOTLABEL/etc/fstab"
 
     #[[ ! -f "$fstab" ]] && log "Warning: DST fstab will be wrong !" && FSTAB=no
@@ -352,7 +357,7 @@ function fix_fstab {
 }
 
 # check if $1 is in array $2 ($2 is by reference)
-function in_array {
+in_array() {
     local elt=$1 i
     local -n arr=$2
     for ((i=0; i<${#arr[@]}; ++i)); do
@@ -365,7 +370,7 @@ function in_array {
 SRC=""
 DST=""
 SRCROOT=""
-ROOTPARTNUM=""
+SRCROOTPARTNUM=""
 AUTOFS_DIR=/mnt
 
 DRYRUN=no                                         # dry-run
@@ -454,9 +459,9 @@ while true; do
             shift
             ;;
         '-r'|'--root')
-            ROOTPARTNUM="$2"
-            if ! [[ "$ROOTPARTNUM" =~ ^[[:digit:]]+$ ]]; then
-                log "$CMD: $ROOTPARTNUM must be a partition number."
+            SRCROOTPARTNUM="$2"
+            if ! [[ "$SRCROOTPARTNUM" =~ ^[[:digit:]]+$ ]]; then
+                log "$CMD: $SRCROOTPARTNUM must be a partition number."
                 exit 1
             fi
             shift
@@ -485,25 +490,25 @@ fi
 
 case "$#" in
     1)
-        if [[ -n "$ROOTPARTNUM" ]]; then
+        if [[ -n "$SRCROOTPARTNUM" ]]; then
             log "$CMD: cannot have --root option for live system."
             log "Use '$CMD --help' or '$CMD --man' for help."
             exit 1
         fi
         # guess root partition disk name
         SRCROOT=$(findmnt -no SOURCE -M /)
-        ROOTPARTNUM=${SRCROOT: -1}
+        SRCROOTPARTNUM=${SRCROOT: -1}
         SRC="/dev/"$(lsblk -no pkname "$SRCROOT")
         DST="/dev/$1"
         ;;
     2)
-        if [[ -z "$ROOTPARTNUM" ]]; then
+        if [[ -z "$SRCROOTPARTNUM" ]]; then
             log "$CMD: missing --root option for non live system."
             log "Use '$CMD --help' or '$CMD --man' for help."
             exit 1
         fi
         SRC="/dev/$1"
-        SRCROOT="$SRC$ROOTPARTNUM"
+        SRCROOT="$SRC$SRCROOTPARTNUM"
         DST="/dev/$2"
         ;;
     0)
@@ -527,7 +532,8 @@ check_block_device "destination disk" w "$DST"
 check_block_device "source root partition" r "$SRCROOT"
 
 SRCROOTLABEL=$(lsblk -no label "$SRCROOT")
-ROOTLABEL=${SRCROOTLABEL:0:-1}
+# strip out last character
+ROOTLABEL=${SRCROOTLABEL%%?}
 
 # find out all partitions labels on SRC disk...
 # shellcheck disable=SC2207
@@ -550,16 +556,21 @@ for ((i=0; i<${#SRCLABELS[@]}; ++i)); do
     unset TMP TMPDEV TMPFS
 done
 
-DSTROOT="$DST$ROOTPARTNUM"
-check_block_device "destination root partition" w "$DSTROOT"
-DSTROOTLABEL=$(lsblk -no label "$DSTROOT")
-DSTCHAR=${DSTROOTLABEL: -1}
+# find out DST root partition
+# shellcheck disable=SC2207
+declare -a TMP_DSTLABELS=($(lsblk -lno  LABEL "$DST"))
 
-# check DSTROOTLABEL is compatible with ROOTLABEL
-if [[ "$DSTROOTLABEL" != "$ROOTLABEL$DSTCHAR" ]]; then
-    log "%s: Fatal: %s != %s%s." "$CMD" "$DSTROOTLABEL" "$ROOTLABEL" "$DSTCHAR"
-    exit 1
-fi
+for maybe_root in "${TMP_DSTLABELS[@]}"; do
+    log "rootlabel=%s maybe=%s" "$ROOTLABEL" "$maybe_root"
+    if [[ $maybe_root =~ ^${ROOTLABEL}.$ ]]; then
+        log "Found destination root label: $maybe_root"
+        DSTROOTLABEL=$maybe_root
+        DSTCHAR=${DSTROOTLABEL: -1}
+        DSTROOT=$(findfs LABEL="$DSTROOTLABEL")
+        check_block_device "destination root partition" w "$DSTROOT"
+        break
+    fi
+done
 
 declare -a DSTLABELS DSTDEVS DSTFS DST_VALID_FS
 # Do the same for corresponding DST partitions labels, device, and fstype
@@ -586,26 +597,29 @@ for ((i=0; i<${#LABELS[@]}; ++i)); do
     unset TMP TMPDEV TMPFS
 done
 
-for ((i=0; i<${#LABELS[@]}; ++i)); do
-    log -n "%s %s " "${SRCDEVS[$i]}" "${DSTDEVS[$i]}"
-    log -n "%s %s " "${SRCLABELS[$i]}" "${DSTLABELS[$i]}"
-    log -n "%s %s "  "${SRCFS[$i]}" "${DSTFS[$i]}"
-    log -n "%s %s "  "${SRC_VALID_FS[$i]}" "${DST_VALID_FS[$i]}"
-    [[ "$DSTROOTLABEL" == "${DSTLABELS[$i]}" ]] && log "*"
-    echo
-done | column -N DEV1,DEV2,LABEL1,LABEL2,FS1,FS2,SVALID\?,DVALID\?,ROOT -t -o " | "
+{
+    printf "DEV1 DEV2 LABEL1 LABEL2 FS1 FS2 SVALID\? DVALID\? ROOT\n"
+    for ((i=0; i<${#LABELS[@]}; ++i)); do
+        log -n "%s %s " "${SRCDEVS[$i]}" "${DSTDEVS[$i]}"
+        log -n "%s %s " "${SRCLABELS[$i]}" "${DSTLABELS[$i]}"
+        log -n "%s %s "  "${SRCFS[$i]}" "${DSTFS[$i]}"
+        log -n "%s %s "  "${SRC_VALID_FS[$i]}" "${DST_VALID_FS[$i]}"
+        [[ "$DSTROOTLABEL" == "${DSTLABELS[$i]}" ]] && log "*"
+        echo
+    done
+} | column -t
 
 check_fstab || exit 1
 
-RSYNCOPTS="-axH --delete --delete-excluded"
 FILTER=--filter="dir-merge .rsync-disk-copy"
+declare -a RSYNCOPTS=(-axH "$FILTER" --delete --delete-excluded)
 # copy loop
 for ((i=0; i<${#LABELS[@]}; ++i)); do
     if [[ "${SRC_VALID_FS[$i]}" != y ]] || [[ "${DST_VALID_FS[$i]}" != y ]]; then
         log "skipping label %s" "${LABELS[$i]}"
         continue
     fi
-    SRCPART="${AUTOFS_DIR}/${SRCLABELS[$i]}/"
+    SRCPART="$AUTOFS_DIR/${SRCLABELS[$i]}/"
     DSTPART="$AUTOFS_DIR/${DSTLABELS[$i]}"
 
     #log -n "%s -> %s : " "$SRCPART" "$DSTPART"
@@ -616,8 +630,14 @@ for ((i=0; i<${#LABELS[@]}; ++i)); do
     fi
     if [[ "$copy" == yes ]]; then
         mariadb_maybe_stop
+        status=0
         # shellcheck disable=SC2086
-        echorun_maybe rsync "$FILTER" ${RSYNCOPTS} "$SRCPART" "$DSTPART"
+        echorun_maybe rsync "${RSYNCOPTS[@]}" "$SRCPART" "$DSTPART" || status=$?
+        if (( status != 24 && status != 0 )); then
+            log -s "rsync error %d" "$status"
+            exit 1
+        fi
+
         if [[ "$DSTROOTLABEL" == "${DSTLABELS[$i]}" ]]; then
             ROOTCOPIED=yes
             fix_fstab

bash/free-sms-keys.txt

@@ -0,0 +1,2 @@
+bruno:01234567:abcdeABCDE1234
+bodiccea:76543210:xyztXYZT123456

bash/gen-password.sh

@@ -0,0 +1,738 @@
+#!/usr/bin/env bash
+#
+# gen-passwd.sh - a simple password generator.
+#
+# (C) Bruno Raoult ("br"), 2022
+# 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>
+#
+#%MAN_BEGIN%
+# NAME
+#       gen-passwwd.sh - a simple password generator.
+#
+# SYNOPSIS
+#       gen-passwd.sh [OPTIONS] TYPE [LENGTH]
+#
+# DESCRIPTION
+#       Generate a random TYPE password with length LENGTH.
+#       Available types are :
+#       dice
+#          A list of digits in range [1-6]. Default length is 5. The purpose of
+#          this is only to help choosing a word in a diceware word list.
+#       mac
+#          A "xx-xx-xx-xx-xx-xx" type address, where 'x' are hexadecimal digits
+#          (ranges 0-9 and a-h).
+#          Length is the number of "bytes" (groups of 2 hexadecimal digits), and
+#          defaults to 6. The default ":" delimiter can be changed with "-s"
+#          option.
+#          This is the default option.
+#       passphrase
+#          Generate words from a diceware-like dictionary. Length is the number
+#          of words ans defaults to 6.
+#       pincode
+#          A numeric password. default LENGTH is 4, with no separator.
+#       string
+#          Password will be a string taken from different character ranges.
+#          By default, alphabetic characters and digits. See -x option for
+#          different character sets.
+#
+# OPTIONS
+#       -c, --copy
+#          Copy password to clipboard.
+#
+#       -C, --capitalize
+#          For 'passphrase' and 'mac' type only.
+#          Passphrase: Capitalize words (first letter of each word). Recommended
+#          if separator is set to null-string (--separator=0).
+#          Mac: use capital hexadecimal digits.
+#
+#       -d, --dictionary=FILE
+#          Use FILE as wordlist file. Default is en-5.
+#          FILE will be searched in these directories : root, current directory,
+#          and /usr/local/share/br-tools/gen-password directory.
+#
+#       -g, --gui
+#          Will use a GUI (yad based) to propose the password. This GUI
+#          simply displays the password, allows to copy it to clipboard,
+#          and to re-generate a new password.
+#
+#       -h, --help
+#          Display usage and exit.
+#
+#       -l, --list-dictionaries
+#          Display the list of available dictionaries, with names suitable for
+#          the "-d" option.
+#
+#       -m, --man
+#          Print a man-like help and exit.
+#
+#       -n, --no-similar-chars
+#          For "string" type only, this option removes similar characters which
+#          could be difficult to differenciate: 0-O, 1-l, 8-B, [], ø-Ø, ~--, ...
+#
+#       -s, --separator=CHAR
+#          CHAR is used as separator when TYPE allows it. Use "0" to remove
+#          separators.
+#
+#       -v, --verbose
+#          Print messages on what is being done.
+#
+#       -x, --extended=RANGE
+#          Specify the ranges of string type. Default is "a:1:a1", as lower case
+#          alphabetic characters (a-z) and digits (0-9), with at least one letter
+#          and one digit. RANGE  is a string composed of:
+#          a: lower case alphabetic characters (a-z)
+#          A: upper case alphabetic characters (A-Z)
+#          e: extra European characters (e.g. À, É, é, Ï, ï, Ø, ø...)
+#          1: digits (0-9)
+#          x: extended characters set 1: #$%&@^`~.,:;{[()]}
+#          y: extended characters set 2: "'\/|_-<>*+!?=
+#          k: japanese hiragana: あいうえおかき...
+#          When a RANGED character is followed by a ':' exactly one character of
+#          this range will appear in generated password: If we want two or more
+#          digits, the syntax would be '-x1:1:1'.
+#
+# TODO
+#       Add different languages wordlists.
+#       Replace hiragana with half-width katakana ?
+#       Add usage examples
+#
+# AUTHOR
+#       Bruno Raoult.
+#
+# SEE ALSO
+#       Pages on Diceware/words lists :
+#       EFF: https://www.eff.org/dice
+#       diceware: https://theworld.com/~reinhold/diceware.html
+#
+#%MAN_END%
+
+SCRIPT="$0"                                       # full path to script
+CMDNAME=${0##*/}                                  # script name
+SHELLVERSION=$(( BASH_VERSINFO[0] * 10 + BASH_VERSINFO[1] ))
+
+export LC_CTYPE="C.UTF-8"                         # to handle non ascii chars
+
+# character sets
+declare -A pw_charsets=(
+    [a]="abcdefghijklmnopqrstuvwxyz"
+    [A]="ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+    [1]="0123456789"
+    [e]="âêîôûáéíóúàèìòùäëïöüãõñçøÂÊÎÔÛÁÉÍÓÚÀÈÌÒÙÄËÏÖÜÃÕÑÇØ¡¿"
+    [x]='#$%&@^`~.,:;{[()]}'
+    [y]=\''"\/|_-<>*+!?='
+    [k]="あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへほまみむめもやゆよらりるれろわをん"
+)
+
+# default type, length, separator
+declare pw_type="mac"
+declare pw_length=6
+declare pw_sep=":"
+declare pw_cap=""
+declare pw_dict=""
+declare pw_copy=""
+declare pw_gui=""
+declare pw_verbose=""
+declare pw_no_similar=""
+declare pw_charset="a:A:1:aA1"
+
+declare -A pw_commands=()
+declare -a pw_command=()
+
+usage() {
+    printf "usage: %s [-s CHAR][-d DICT][-x CHARSET][-Ccgmv] [TYPE] [LENGTH]\n" "$CMDNAME"
+    printf  "Use '%s --man' for more help\n" "$CMDNAME"
+    return 0
+}
+
+man() {
+    sed -n '/^#%MAN_BEGIN%/,/^#%MAN_END%$/{//!s/^#[ ]\{0,1\}//p}' "$SCRIPT" | more
+}
+
+# log() - log messages on stderr
+# parameters:
+# -l, -s: long, or short prefix (default: none). Last one is used.
+# -t: timestamp
+# -n: no newline
+# This function accepts either a string, either a format string followed
+# by arguments :
+#   log -s "%s" "foo"
+#   log -s "foo"
+log() {
+    local timestr="" prefix="" newline=y todo OPTIND
+    [[ -z $pw_verbose ]] && return 0
+    while getopts lsnt todo; do
+        case $todo in
+            l) prefix=$(printf "*%.s" {1..30})
+               ;;
+            s) prefix=$(printf "*%.s" {1..5})
+               ;;
+            n) newline=n
+               ;;
+            t) timestr=$(date "+%F %T%z ")
+               ;;
+            *)
+               ;;
+        esac
+    done
+    shift $((OPTIND - 1))
+    [[ $prefix != "" ]] && printf "%s " "$prefix" >&2
+    [[ $timestr != "" ]] && printf "%s" "$timestr" >&2
+    # shellcheck disable=SC2059
+    printf "$@" >&2
+    [[ $newline = y ]] && printf "\n" >&2
+    return 0
+}
+
+# check_dict() - check for dictionary file
+# $1: the dictionary filename (variable reference).
+#
+# @return: 0 on success, $1 will contain full path to dictionary.
+# @return: 1 if not found
+# @return: 2 if format is wrong
+check_dict() {
+    local -n dict="$1"
+    local tmp_dir tmp_dict tmp_key tmp_dummy
+
+    if [[ -n "$dict" ]]; then
+        for tmp_dir in / ./ /usr/local/share/br-tools/gen-password/; do
+            tmp_dict="$tmp_dir$dict.txt"
+            log -n "checking for %s dictionary... " "$tmp_dict"
+            if [[ -f "$tmp_dict" ]]; then
+                log -n "found, "
+                # shellcheck disable=SC2034
+                read -r tmp_key tmp_dummy < "$tmp_dict"
+                if ! [[ $tmp_key =~ ^[1-6]+$ ]]; then
+                    log "wrong format [%s]" "$tmp_key"
+                    return 2
+                fi
+                log "key length=%d" "${#tmp_key}"
+                dict="$tmp_dict"
+                return 0
+            else
+                log "not found."
+            fi
+        done
+        printf "cannot find '%s' dictionary file\n" "$dict"
+        exit 1
+    fi
+    return 0
+}
+
+# list_dict() - list available dictionaries.
+#
+# @return: 0 on success
+# @return: 1 on error
+list_dict() {
+    local datadir="/usr/local/share/br-tools/gen-password" file fn fn2 key dummy
+    local -a output
+    local -i res=1 cur=0 i
+
+    if [[ -d "$datadir" ]]; then
+        printf -v output[0] "#\tlen\tName"
+        for file in "$datadir"/*.txt; do
+            fn=${file##*/}
+            fn=${fn%.txt}
+            # shellcheck disable=SC2034
+            fn2="$fn"
+            if check_dict fn2; then
+                (( cur++ ))
+                # shellcheck disable=SC2034
+                read -r key dummy < "$file"
+                printf -v output[cur-1] "%d\t%d\t%s" "$cur" "${#key}" "$fn"
+            fi
+        done
+        if ((cur > 0)); then
+            printf "#\tlen\tName\n"
+            for (( i = 0; i < cur; ++i )); do
+                printf "%s\n" "${output[i]}"
+            done
+            return 0
+        fi
+    fi
+    printf "No dictionaries found.\n"
+    return 1
+}
+
+# sanitize() - sanitize string for HTML characters
+# $1: string to cleanup
+#
+# @return: 0, $1 will contain the sanitized string
+sanitize() {
+    local str="$1"
+
+    str=${str//&/&amp;}
+    str=${str//</&lt;}
+    str=${str//>/&gt;}
+    str=${str//'"'/&quot;}
+    log "sanitized string: '%s' -> '%s'" "$1" "$str"
+    printf -- "%str" "$str"
+}
+
+# srandom() - use RANDOM to simulate SRANDOM
+# $1: Reference of variable to hold result
+#
+# Note: RANDOM is 15 bits, SRANDOM is 32 bits.
+#
+# @return: 0, $1 will contain the 32 bits random number
+srandom() {
+    local -n _ret=$1
+
+    (( _ret = RANDOM << 17 | RANDOM << 2 | RANDOM & 3 ))
+}
+
+# rnd() - get a random number integer
+# $1: An integer, the modulo value
+#
+# @return: 0, output a string with the random integer on stdout.
+#
+# This function uses SRANDOM for bash >= 5.1 and srandom() function
+# above for lower versions.
+rnd() {
+    local mod=$1 ret
+
+    if (( SHELLVERSION >= 51 )); then
+        # shellcheck disable=SC2153
+        (( ret = SRANDOM ))
+    else
+        srandom ret
+    fi
+    printf "%d" "$(( ret % mod ))"
+}
+
+# shuffle() - shuffle  a string
+# $1: The string to shuffle
+#
+# The string is shuffled using the Fisher–Yates shuffle method :
+# https://en.wikipedia.org/wiki/Fisher%E2%80%93Yates_shuffle
+#
+# @return: 0,  output the shuffled string to stdout.
+shuffle() {
+    local _str="$1"
+    local _res=""
+    local -i _i _len=${#_str} _cur=0
+
+    for (( _i = _len ; _i > 0; --_i )); do
+        _cur=$(rnd "$_i")
+        _res+=${_str:$_cur:1}
+        _str="${_str:0:_cur}${_str:_cur+1}"
+    done
+    printf "%s" "$_res"
+    return  0
+}
+
+# rnd_hex() - get a random 2-digits hex number
+#
+# @return: 0, output a string with the random integer on stdout.
+rnd_hex() {
+    printf "%02x" "$(rnd 256)"
+}
+
+# rnd_dice() - get a 6 faces 1-6 random number
+#
+# @return: 0, output a string {1..6}
+rnd_dice() {
+    printf "%d" "$(( $(rnd 6) + 1 ))"
+}
+
+# rnd_digit() - get a digit random number
+#
+# @return: 0, output a string {0..9}
+rnd_digit() {
+    printf "%d" "$(( $(rnd 10) ))"
+}
+
+# rnd_word() - get a word from file
+# $1: The dice rolls
+# $2: The word list file ()
+#
+# @return: 0, output a string {0..9}
+rnd_word() {
+    local roll="$1" file="$2" word=""
+
+    word=$(sed -n "s/^${roll}[[:blank:]]\+//p" "$file")
+    printf "%s" "$word"
+}
+
+# rnd_charset() - get a random string from a charset
+# $1: A string with characters to choose from
+# $2: An integer, the length of returned string
+#
+# @return: 0, output a random string from charset $1, with length $2.
+rnd_charset() {
+    local charset="$1" ret=""
+    local -i len=$2 _i
+
+    #log "rnd_charset: %d from  '%s'" "$len" "$charset"
+    for ((_i=0; _i<len; ++_i)); do
+        ret+=${charset:$(rnd ${#charset}):1}
+    done
+
+    #log "rnd_charset: return '%s'" "$ret"
+    printf "%s" "$ret"
+}
+
+# pwd_dice() - get a random dice style string
+# $1: Integer, the number dice runs
+# $2: Separator
+#
+# @return: 0, output dice rolls
+pwd_dice() {
+    local -i i n="${1:-6}"
+    local sep="" _sep="${2}"
+    local str="" _str=""
+
+    for ((i = 0; i < n; ++i)); do
+        printf -v _str  "%s%s" "$sep" "$(rnd_dice)"
+        str+="$_str"
+        sep="$_sep"
+    done
+    printf "%s" "$str"
+    return 0
+}
+pw_commands["dice"]=pwd_dice
+
+# pwd_mac() - get a random MAC-address style string
+# $1: Integer, the number of hex values
+# $2: Separator
+# $3: Capitalize
+#
+# @return: 0, output a random MAC-address style string.
+pwd_pincode() {
+    local -i i n="${1:-6}"
+    local sep="" _sep="${2}" _cap="$3"
+    local str="" _str=""
+
+    for ((i = 0; i < n; ++i)); do
+        printf -v _str  "%s%s" "$sep" "$(rnd_digit)"
+        str+="$_str"
+        sep="$_sep"
+    done
+    [[ -n $_cap ]] && str=${str^^}
+    printf "%s" "$str"
+    return 0
+}
+pw_commands["pincode"]=pwd_pincode
+
+# pwd_mac() - get a random MAC-address style string
+# $1: Integer, the number of hex values (default: 6)
+# $2: Separator (default: "-")
+# $3: Capitalize (default: "")
+#
+# @return: 0, output a random MAC-address style string.
+pwd_mac() {
+    local -i i n="$1"
+    local sep="" _sep="${2}" _cap="$3"
+    local str="" _str=""
+
+    for ((i = 0; i < n; ++i)); do
+        str+="$sep$(rnd_hex)"
+        sep="$_sep"
+    done
+    [[ -n $_cap ]] && str=${str^^}
+    printf "%s" "$str"
+    return 0
+}
+pw_commands["mac"]=pwd_mac
+
+# pwd_passphrase() - get a list of words from a diceware-style file
+# $1: Integer, the number of words
+# $2: Separator
+# $3: Capitalize
+# $4: diceware file
+#
+# @return: 0, output a random MAC-address style string.
+pwd_passphrase() {
+    local -i i n="$1" _digits=0
+    local sep="" _sep="${2}" _cap="$3" _file="$4"
+    local str="" _str="" _key="" _dummy=""
+
+    # get the number of digits from 1st file line
+    read -r _key _dummy < "$_file"
+    _digits=${#_key}
+    log "passphrase setup: key 1=%s digits=%d" "$_key" "$_digits"
+
+    for ((i = 0; i < n; ++i)); do
+        _key=$(pwd_dice "$_digits" "")
+        _str=$(rnd_word "$_key" "$_file")
+        [[ -n $_cap ]] && _str=${_str^}
+        log "passphrase: key=%s str=%s" "$_key" "$_str"
+        str+="$sep$_str"
+        sep="$_sep"
+    done
+    printf "%s" "$str"
+    return 0
+}
+pw_commands["passphrase"]=pwd_passphrase
+
+# pwd_string() - generate a string from a charset
+# $1: Integer, the string length
+# $5: The charset definition (e.g. "a:1:")
+#
+# @return: 0, output a random string from $5 charset.
+pwd_string() {
+    local -i i n="$1"
+    local _charset="${5}" _allchars=""
+    local str="" _c="" _char=""
+
+    log "string setup: len=%d charset=[%s]" "$n" "$_charset"
+    # finds out mandatory characters and build final charset
+    log -n "mandatory chars:"
+    for (( i = 0; i < ${#_charset}; ++i )); do
+        _c="${_charset:i:1}"
+        if [[ ${_charset:i+1:1} == ":" ]]; then
+            _char=$(rnd_charset "${pw_charsets[$_c]}" 1)
+            log -n " [%s]" "$_char"
+            str+="$_char"
+            (( i++ ))
+        else
+            _allchars+=${pw_charsets[$_c]}
+        fi
+    done
+    log ""
+    if (( ${#str} < n && ${#_allchars} == 0 )); then
+        printf "Fatal: No charset to choose from ! Please check  '-x' option."
+        exit 1
+    fi
+
+    log -n "generating %d remaining chars:" "$((n-${#str}))"
+    for ((i = ${#str}; i < n; ++i)); do
+        _char=$(rnd_charset "$_allchars" 1)
+        log -n " [%s]" "$_char"
+        str+="$_char"
+    done
+    log ""
+    log "string before shuffle : %s" "$str"
+    str="$(shuffle "$str")"
+    log "string after shuffle : %s" "$str"
+    # cut string if too long (may happen if too many mandatory chars)
+    (( ${#str} > n)) && log  "truncating '%s' to '%s'" "$str" "${str:0:n}"
+    printf "%s" "${str:0:n}"
+    return 0
+}
+pw_commands["string"]=pwd_string
+
+# print command() - print a pwd_command parameters
+# $1: reference of pwd_command array
+#
+# @return: 0
+print_command() {
+    local -n arr="$1"
+    local -a label=("function" "length" "sep" "cap" "dict" "charset")
+    local -i i
+    for i in "${!arr[@]}"; do
+        log -s "%s=[%s]" "${label[$i]}" "${arr[$i]}"
+    done
+    return 0
+}
+
+# gui_passwd() - GUI for passwords
+# $1: reference pwd_command array
+#
+# @return: 0
+gui_passwd() {
+    local -a _command=("$@")
+    local passwd="" res=0 sane=""
+
+    while
+        passwd=$("${_command[@]}")
+        sane=$(sanitize "$passwd")
+        yad --title="Password Generator" --text-align=center --text="$sane" \
+            --borders=20 --button=gtk-copy:0 --button=gtk-refresh:1 \
+            --button=gtk-ok:252 --window-icon=dialog-password
+        res=$?
+        log "res=%d\n" "$res"
+        if (( res == 0 )); then
+            printf "%s" "$passwd" | xsel -bi
+        fi
+        ((res != 252))
+    do true;  done
+    return $res
+}
+
+parse_opts() {
+    # short and long options
+    local sopts="cCd:ghlmns:vx:"
+    local lopts="copy,capitalize,dictionary:,gui,help,list-dictionaries,man,no-similar-chars,separator:,verbose,extended:"
+    # set by options
+    local tmp="" tmp_length="" tmp_sep="" tmp_cap="" tmp_dict="" tmp_dir=""
+    local tmp_charset=""
+    local c2="" c3=""
+    local  -i  i
+
+    if ! tmp=$(getopt -o "$sopts" -l "$lopts" -n "$CMD" -- "$@"); then
+        log "Use '$CMD --help' or '$CMD --man' for help."
+        exit 1
+    fi
+
+    eval set -- "$tmp"
+
+    while true; do
+        case "$1" in
+            '-c'|'--copy')
+                pw_copy=y
+                ;;
+            '-C'|'--capitalize')
+                tmp_cap=y
+                ;;
+            '-d'|'--dictionary')
+                tmp_dict="$2"
+                shift
+                ;;
+            '-g'|'--gui')
+                if ! type -P "yad" > /dev/null; then
+                    printf "%s: Please install 'yad' package tu use 'g' option.\n" \
+                           "$CMDNAME"
+                fi
+                pw_gui="y"
+                ;;
+            '-h'|'--help')
+                usage
+                exit 0
+                ;;
+            '-l'|'--list-dictionaries')
+                list_dict
+                exit 0
+                ;;
+            '-m'|'--man')
+                man
+                exit 0
+                ;;
+            '-n'|'no-similar-chars')
+                pw_no_similar=y
+                ;;
+            '-s'|'--separator')
+                tmp_sep="$2"
+                shift
+                ;;
+            '-v'|'--verbose')
+                pw_verbose=y
+                ;;
+            '-x'|'--extended')
+                for (( i = 0; i < ${#2}; ++i)); do
+                    c2="${2:i:1}"
+                    case "$c2" in
+                        a|A|1|x|y|k|e)
+                            tmp_charset+="$c2"
+                            c3="${2:i+1:1}"
+                            if [[ "$c3" == ":" ]]; then
+                                tmp_charset+=":"
+                                (( i++ ))
+                            fi
+                            ;;
+
+                        *) printf "unknown character set '%s\n" "${2:$i:1}"
+                           usage
+                           exit 1
+                    esac
+                done
+                shift
+                ;;
+            '--')
+                shift
+                break
+                ;;
+            *)
+                usage
+                log 'Internal error!'
+                exit 1
+                ;;
+        esac
+        shift
+    done
+
+    # parse remaining arguments
+    if (($# > 0)); then                               # type
+        type=$1
+        case "$type" in
+            dice)
+                pw_type="dice"
+                tmp_length=5
+                [[ -z $tmp_sep ]] && tmp_sep=" "
+                ;;
+            mac)
+                pw_type="mac"
+                tmp_length=6
+                [[ -z $tmp_sep ]] && tmp_sep=":"
+                ;;
+            pincode)
+                pw_type="pincode"
+                tmp_length=4
+                [[ -z $tmp_sep ]] && tmp_sep="0"
+                ;;
+            passphrase)
+                pw_type="passphrase"
+                tmp_length=6
+                [[ -z $tmp_dict ]] && tmp_dict="en-5"
+                [[ -z $tmp_sep ]] && tmp_sep=" "
+                [[ -z $tmp_cap ]] && tmp_cap=""
+                ;;
+            string)
+                pw_type="string"
+                tmp_length=10
+                if [[ -n $pw_no_similar ]]; then
+                    pw_charsets[A]="ABCDEFGHIJKLMNPQRSTUVWXYZ"
+                    pw_charsets[a]="abcdefghijkmnopqrstuvwxyz"
+                    pw_charsets[1]="23456789"
+                    pw_charsets[e]="âêîôûáéíóúàèìòùñçÂÊÎÔÛÁÉÍÓÚÀÈÌÒÙÇ¡¿"
+                    pw_charsets[x]='#$%&@^`.,:;{()}'
+                    pw_charsets[y]='\/|_<>*+!?='
+                fi
+                if [[ -n $tmp_charset ]]; then
+                    pw_charset="$tmp_charset"
+                fi
+                ;;
+            *)
+                printf "%s: Unknown '%s' password type.\n" "$CMDNAME" "$type"
+                usage
+                exit 1
+        esac
+        shift
+    fi
+    if (($# > 0)); then                               # length
+        if ! [[ $1 =~ ^[0-9]+$ ]]; then
+            printf "%s: Bad '%s' length.\n" "$CMDNAME" "$1"
+            usage
+            exit 1
+        fi
+        tmp_length="$1"
+        shift
+    fi
+    [[ -n $tmp_length ]] && pw_length=$tmp_length
+    if ! (( pw_length )); then
+        printf "%s: Bad '%d' length.\n" "$CMDNAME" "$tmp_length"
+        usage
+        exit 1
+    fi
+    [[ -n $tmp_sep   ]] && pw_sep=$tmp_sep
+    [[ $pw_sep = "0" ]] && pw_sep=""
+    [[ -n $tmp_cap   ]] && pw_cap=$tmp_cap
+    [[ -n $tmp_dict  ]] && pw_dict=$tmp_dict
+
+    # look for dictionary file
+    check_dict pw_dict || exit 1
+}
+
+parse_opts "$@"
+
+pw_command=("${pw_commands[$pw_type]}" "$pw_length" "$pw_sep" "$pw_cap" "$pw_dict"
+           "$pw_charset")
+
+print_command pw_command
+
+if [[ -z $pw_gui ]]; then
+    passwd=$("${pw_command[@]}")
+    if [[ -n $pw_copy ]]; then
+        printf "%s" "$passwd" | xsel -bi
+    fi
+    printf "%s\n" "$passwd"
+else
+    gui_passwd "${pw_command[@]}"
+fi
+
+exit 0

bash/share/gen-password/README.md

@@ -0,0 +1,18 @@
+### Dictionaries for gen-password.sh
+
+#### English
+
+Lists taken from :
+[EFF word list](https://www.eff.org/fr/deeplinks/2016/07/new-wordlists-random-passphrases). I am unsure about licensing.
+
+* [Large list](eff_large_wordlist.txt): To use with 5 dices.
+* [Short list 1](eff_short_wordlist_1.txt): To use with 4 dices.
+* [Short list 2](eff_short_wordlist_2_0.txt): 4 dices, with some improvements.
+
+#### Français
+
+Listes prises sur [github.com/mbelivo/diceware-wordlists-fr](https://github.com/mbelivo/diceware-wordlists-fr). La licence est CC BY-NC-SA 3.0.
+
+* [Liste Longue](wordlist_fr_5d.txt): Pour 5 dés.
+* [Liste Courte 1](wordlist_fr_4d.txt): Pour 4 dés.
+* [Liste Courte 2](wordlist_fr_4d_2.txt): Pour 4 dés, avec quelques améliorations.

bash/share/gen-password/en-4-2.txt

@@ -0,0 +1 @@
+eff_short_wordlist_2_0.txt

bash/share/gen-password/en-4.txt

@@ -0,0 +1 @@
+eff_short_wordlist_1.txt

bash/share/gen-password/en-5.txt

@@ -0,0 +1 @@
+eff_large_wordlist.txt

bash/share/gen-password/fr-4-2.txt

@@ -0,0 +1 @@
+wordlist_fr_4d_2.txt

bash/share/gen-password/fr-4.txt

@@ -0,0 +1 @@
+wordlist_fr_4d.txt

bash/share/gen-password/fr-5.txt

@@ -0,0 +1 @@
+wordlist_fr_5d.txt

bash/share/sync/sync-conf-example.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 #
 # sync-conf-example.sh - a "sync.sh" configuration file example.
 #
@@ -18,13 +18,17 @@
 # The only mandatory ones are SOURCEDIR, SERVER, and DESTDIR.
 
 ###### source directory full path, destination server and path.
-###### SERVER could user@host, or "local" if local machine
+###### SERVER could be user@host, or "local" if local machine
 # SOURCEDIR=""
 # SERVER=""
 # DESTDIR=""
-SOURCEDIR=/example-srcdir
-SERVER=root@backuphost
-DESTDIR=/mnt/nas1/example-destdir
+export SOURCEDIR=/example-srcdir
+export SERVER=root@backuphost
+export DESTDIR=/mnt/nas1/example-destdir
+
+###### backups mount point on local machine.
+###### it is used by sync-view.sh only.
+export BACKUPDIR=/mnt/backup-example-srcdir
 
 ###### backups to keep
 # NYEARS=3
@@ -59,6 +63,14 @@ beforesync() {
         log -s "cannot get maria databases directory"
         exit 1
     fi
+
+    # dump users and permissions
+    log -n "dumping users and permissions... "
+    mysqldump --user=root --system=users > "$datadir/mariadb_users.sql"
+    log -n "compressing... "
+    gzip -f "$datadir/mariadb_users.sql"
+    log "done."
+
     rm -f "$datadir/$FILTERNAME"
     # shellcheck disable=2207
     if ! databases=( $(mysql -sN -u root -e "SHOW DATABASES;") ); then
@@ -96,7 +108,7 @@ aftersync() {
     log -s -t "calling user aftersync"
 }
 
-# For Emacs, shell-mode:
+# For Emacs, shell-script-mode:
 # Local Variables:
 # mode: shell-script
 # End:

bash/sms-free.sh

@@ -0,0 +1,324 @@
+#!/usr/bin/env bash
+#
+# sms-free.sh - send SMS to Free Mobile.
+#
+# (C) Bruno Raoult ("br"), 2022
+# 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>
+#
+#%MAN_BEGIN%
+# NAME
+#       sms-free.sh - Send SMS to Free Mobile account.
+#
+# SYNOPSIS
+#       sms-free.sh [OPTIONS] [-k KEYFILE] USER [MESSAGE]
+#       sms-free.sh [OPTIONS] [-l LOGIN:PASSWORD] [MESSAGE]
+#
+# DESCRIPTION
+#       Send a SMS to a Free Mobile (french mobile operator). This script will
+#       only work for phones numbers for which you have the "SMS key" (see FREE
+#       MOBILE SMS SETUP below). Therefore yourself, close relatives, and other
+#       people who trust you).
+#       MESSAGE is the text to be sent. If missing, it will be read from standard
+#       input.
+#
+# OPTIONS
+#       -d, --dry-run
+#          Will not send the SMS.
+#
+#       -h, --help
+#          Display usage and exit.
+#
+#       -l, --login=ACCOUNT:SMSKEY
+#          Do not use a KEYFILE, and provide directly the Free Mobile ACCOUNT
+#          and SMSKEY.
+#
+#       -k, --keyfile=KEYFILE
+#          Use KEYFILE instead of default ~/data/private/free-sms-keys.txt.
+#
+#       -m, --man
+#          Print a man-like help and exit.
+#
+#       -v, --verbose
+#          Print messages on what is being done.
+#
+# FREE MOBILE SMS SETUP
+#       You should first connect on https://mobile.free.fr/account/, and
+#       activate the option "Mes options / Notifications par SMS". You will be
+#       given a key.
+#
+# KEY FILE SYNTAX
+#       The key file contains lines of the form:
+#            id:login:password
+#       id
+#          A mnemonic for the user (firstname, etc...), it should be unique.
+#       login
+#          A valid Free Mobile account number (usually 8 digits).
+#       key
+#          The SMS key associated with the Free Mobile login (usually a 14
+#          alphanumeric string).
+#
+#       Example:
+#       bruno:01234567:abcdeABCDE1234
+#       bodiccea:76543210:xyztXYZT123456
+#
+# AUTHOR
+#       Bruno Raoult.
+#%MAN_END%
+#
+# PERSONAL NOTES/TODO
+#       In example above, "%20" can be replaced by "+"
+#          See: https://www.w3.org/TR/html4/interact/forms.html#h-17.13.4.1
+#       utf8 characters look supported (tested on French accentuated characters,
+#          Japanese kana and kanji, and Chinese)
+#
+# FREE MOBILE DOCUMENTATION
+#
+#        L'envoi du SMS se fait en appelant le lien suivant :
+#
+#        https://smsapi.free-mobile.fr/sendmsg
+#        avec les paramètres suivants :
+#
+#            user : votre login
+#            pass : votre clé d'identification générée automatiquement par notre
+#                   service
+#            msg  : le contenu du SMS encodé sous forme d'url (Percent-encoding)
+#
+#        Exemple : Envoyer le message "Hello World !" sur votre mobile :
+#
+#        https://smsapi.free-mobile.fr/sendmsg?user=12345678&pass=abcABC12345678&msg=Hello%20World%20!
+#
+#        Vous pouvez également, si vous le préférez, envoyer les paramètres en POST.
+#        Dans ce cas, le contenu du message n'a pas besoin d'être encodé.
+#        Le code de retour HTTP indique le succès ou non de l'opération :
+#
+#            200 : Le SMS a été envoyé sur votre mobile.
+#            400 : Un des paramètres obligatoires est manquant.
+#            402 : Trop de SMS ont été envoyés en trop peu de temps.
+#            403 : Le service n'est pas activé sur l'espace abonné, ou login / clé
+#                  incorrect.
+#            500 : Erreur côté serveur. Veuillez réessayer ultérieurement.
+
+#set -x
+script="$0"                                       # full path to script
+cmdname=${0##*/}                                  # script name
+export LC_CTYPE="C.UTF-8"                         # to handle non ascii chars
+
+declare sms_keyfile=~/data/private/free-sms-keys.txt
+declare sms_verbose=""
+declare sms_credentials=""
+declare sms_dryrun=""
+declare sms_message=""
+declare sms_url="https://smsapi.free-mobile.fr/sendmsg"
+declare -A sms_status=(
+    [-]="Unknown error"
+    [200]="OK"
+    [400]="Missing parameter"
+    [402]="Too many SMS sent in short time"
+    [403]="Service non activated or incorrect credentials"
+    [500]="Server error"
+)
+
+usage() {
+    printf "usage: %s [-hmv] [-k KEYFILE] USER [MESSAGE]\n" "$cmdname"
+    printf "       %s [-hmv] [-l LOGIN:PASSWORD] [MESSAGE]\n" "$cmdname"
+    printf  "Use '%s --man' for more help\n" "$cmdname"
+    return 0
+}
+
+man() {
+    sed -n '/^#%MAN_BEGIN%/,/^#%MAN_END%$/{//!s/^#[ ]\{0,1\}//p}' "$script" | more
+}
+
+# log() - log messages on stderr
+# parameters:
+# -l, -s: long, or short prefix (default: none). Last one is used.
+# -t: timestamp
+# -n: no newline
+# This function accepts either a string, either a format string followed
+# by arguments :
+#   log -s "%s" "foo"
+#   log -s "foo"
+log() {
+    local timestr="" prefix="" newline=y todo OPTIND
+    [[ -z $sms_verbose ]] && return 0
+    while getopts lsnt todo; do
+        case $todo in
+            l) prefix=$(printf "*%.s" {1..30})
+               ;;
+            s) prefix=$(printf "*%.s" {1..5})
+               ;;
+            n) newline=n
+               ;;
+            t) timestr=$(date "+%F %T%z ")
+               ;;
+            *)
+               ;;
+        esac
+    done
+    shift $((OPTIND - 1))
+    [[ $prefix != "" ]] && printf "%s " "$prefix" >&2
+    [[ $timestr != "" ]] && printf "%s" "$timestr" >&2
+    # shellcheck disable=SC2059
+    printf "$@" >&2
+    [[ $newline = y ]] && printf "\n" >&2
+    return 0
+}
+
+# echorun() - logs and run (maybe) a command.
+# $1: reference of variable which will get the output of command
+# $2..$n: command to log and run
+echorun() {
+    local -n _out="$1"
+    shift
+    [[ -n $sms_dryrun ]] && log -n "dry-run: "
+    log "%s" "$*"
+    [[ -z $sms_dryrun ]] && _out=$("$@")
+    return $?
+}
+
+# get_credentials() - get credentials from keyfile
+# $1: reference of variable which will contain credentials
+# $2: keyfile
+# $3: user to find
+#
+# @return: 0 on success
+# @return: 1 on file not present or not readable
+# @return: 2 if user not found
+get_credentials() {
+    local -n _cred=$1
+    local _keyfile="$2" _user="$3" _name=""
+
+    log "get_credentials: ref=%s user=%s keyfile=%s" "$!_cred" "$_user" "$_keyfile"
+    if [[ ! -r "$_keyfile" ]]; then
+        printf "%s: cannot read keyfile %s\n" "$cmdname" "$_keyfile"
+        return 2
+    fi
+    while IFS=: read -r _name _cred; do
+        log -n "key: name=[%s] creds=[%s]... " "$_name" "$_cred"
+        [[ $_name = "$_user" ]] && log "match." && return 0
+        log "skipping."
+    done  < "$_keyfile"
+    printf "%s: cannot find credentials for user '%s'\n" "$cmdname" "$_user"
+    return 2
+}
+
+parse_opts() {
+    # short and long options
+    local sopts="dhk:l:mv"
+    local lopts="dry-run,help,keyfile:,login:,man,verbose"
+
+    if ! tmp=$(getopt -o "$sopts" -l "$lopts" -n "$cmdname" -- "$@"); then
+        log "Use '%s --help' or '%s --man' for help." "$cmdname" "$cmdname"
+        exit 1
+    fi
+
+    eval set -- "$tmp"
+
+    while true; do
+        case "$1" in
+            '-d'|'--dry-run')
+                sms_dryrun=y
+                ;;
+            '-h'|'--help')
+                usage
+                exit 0
+                ;;
+            '-k'|'--keyfile')
+                sms_keyfile="$2"
+                shift
+                ;;
+            '-l'|'--login')
+                sms_credentials="$2"
+                log "sms_creds=%s" "$sms_credentials"
+                shift
+                ;;
+            '-m'|'--man')
+                man
+                exit 0
+                ;;
+            '-v'|'--verbose')
+                sms_verbose=y
+                ;;
+            '--')
+                shift
+                break
+                ;;
+            *)
+                usage
+                log 'Internal error!'
+                exit 1
+                ;;
+        esac
+        shift
+    done
+
+    # parse remaining arguments
+    case "$#" in
+        0)
+            # no user, no message: we need sms_credentials
+            if [[ -z $sms_credentials ]]; then
+                printf "%s: Missing credentials.\n" "$cmdname"
+                exit 1
+            fi
+            ;;
+        1|2)
+            # get credentials from KEYFILE
+            if [[ -z $sms_credentials ]]; then
+                get_credentials sms_credentials "$sms_keyfile" "$1" || exit 1
+                shift
+            else
+                # cannot have user and sms_credentials
+                (( $# == 2 )) && usage && exit 1
+            fi
+            if [[ $# == 1 ]]; then
+                sms_message="$1"
+            else
+                readarray sms_message
+                printf -v sms_message "%s" "${sms_message[@]}"
+                sms_message=${sms_message%$'\n'}          # remove trailing '\n'
+            fi
+            ;;
+        *)
+            usage
+            ;;
+    esac
+
+    log "credentials=%s" "$sms_credentials"
+    log "message=[%s]" "$sms_message"
+}
+
+# send-sms() - send SMS (GET method)
+send_sms() {
+    local _login=${sms_credentials%:*} _pass=${sms_credentials#*:} _res="" _str=""
+
+    log "send_sms(): login=%s pass=%s" "$_login" "$_pass"
+    echorun _res curl --silent --get --write-out '%{http_code}' \
+            --data "user=$_login" \
+            --data "pass=$_pass" \
+            --data-urlencode "msg=$sms_message" \
+            "$sms_url"
+    [[ -n $sms_dryrun ]] && _res=200
+    _str="${sms_status[$_res]:-${sms_status[-]}}"
+    log "send_sms(): curl status=%s (%s)" "$_res" "$_str"
+    if [[ $_res != 200 ]]; then
+        printf "%s: %s\n" "$cmdname" "$_str"
+    fi
+}
+
+parse_opts "$@"
+send_sms
+exit 0
+
+# Indent style for emacs
+# Local Variables:
+# sh-basic-offset: 4
+# sh-indentation: 4
+# indent-tabs-mode: nil
+# comment-column: 32
+# End:

bash/sync-view.sh

@@ -0,0 +1,391 @@
+#!/usr/bin/env bash
+#
+# sync-view.sh - view file versions in a sync.sh backup directory.
+#
+# (C) Bruno Raoult ("br"), 2007-2022
+# 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>
+#
+#%MAN_BEGIN%
+# NAME
+#       sync-view.sh - list file versions from rsync.sh backups.
+#
+# SYNOPSIS
+#       sync-view.sh [OPTIONS] TARGET
+#
+# DESCRIPTION
+#       List TARGET versions from a sync.sh backup directory.
+#
+# OPTIONS
+#       -1, --unique
+#          Skip duplicate files. This option do not apply if TARGET is a
+#          directory.
+#
+#       -a, --absolute-target
+#          Do not try to resolve TARGET path. By default, the script will try to
+#          guess TARGET absolute path. This is not possible if current system is
+#          different from the one from which the backup was made, or if some
+#          path component are missing or were changed.
+#          If this option is used, TARGET must be an absolute path as it was on
+#          backuped machine.
+#
+#       -b, --backupdir=DIR
+#          DIR is the local path where the backups can be found. It can be a
+#          network mount, or the destination directory if the backup was local.
+#          This option is mandatory.
+#
+#       -c, --config
+#          A sync.sh configuration file where the script could find variables
+#          SOURCEDIR (option '-r') and BACKUPDIR (option '-b').
+#          If this option is missing, the script will try to find a .syncrc file
+#          in DIR/daily-01 directory, where DIR is the local path of backups
+#          (option -b).
+#
+#       -d, --destdir
+#          Directory which will hold links to actual files. It will be created
+#          if non-existant. If this option is missing, a temporary directory will
+#          be created in /tmp.
+#
+#       -h, --help
+#          Display short help and exit.
+#
+#       -m, --man
+#          Display a "man-like" description and exit.
+#
+#       -r, --root=DIR
+#          DIR is the path of the backup source. If '-c' option is used, the
+#          variable SOURCEDIR will be used. By default '/'.
+#
+#       -v, --verbose
+#          Print messages on what is being done.
+#
+#       -x, --exclude=REGEX
+#          Filenames matching REGEX (with relative path to backup directory,
+#          as specified with '-b' option) will be excluded. This option can be
+#          useful
+#
+# EXAMPLES
+#       The next command will list all .bashrc versions for current user, from
+#       backups in /mnt/backup. yearly and monthly-03 to monthly-09 are
+#       excluded. Source directory (-r) of backups are taken from sync.sh
+#       configuration file named s.conf. A temporary directory will be created
+#       in /mnt to handle links to actual files.
+#       $ sync-view.sh -c s.conf -b /mnt/backup -x "^(yearly|monthly-0[3-9]).*$" ~/.bashrc
+#
+#       The simplest invocation: the versions of users' .bashrc will be retrieved
+#       in backups from /mnt/backup. A /mnt/backup/daily-01/.syncrc must exist.
+#       $ sync-view.sh -b /mnt/backup ~/.bashrc
+#
+#       Links to user's .bashrc backups will be put in /tmp/test. Files are in
+#       /mnt/backup, which contains backups of /export directory. The /tmp/test
+#       directory will be created if necessary.
+#       $ sync-view.sh -r /export -b /mnt/backup -d /tmp/test ~/.bashrc
+#
+# AUTHOR
+#       Bruno Raoult.
+#
+#%MAN_END%
+
+# internal variables, cannot (and *should not*) be changed unless you
+# understand exactly what you do.
+SCRIPT="$0"                                       # full path to script
+CMDNAME=${0##*/}                                  # script name
+HOSTNAME="$(hostname)"
+
+ROOTDIR="/"                                       # root of backup source
+BACKUPDIR=""                                      # the local view of backup dirs
+TARGETDIR=""                                      # temp dir to hold links
+
+TARGET=""                                         # the file/dir to find
+RESOLVETARGET=y                                   # resolve TARGET
+UNIQUE=""                                         # omit duplicate files
+EXCLUDE=""                                        # regex for files to exclude
+VERBOSE=""                                        # -v option
+declare -A INODES                                 # inodes table (for -1 option)
+
+# error management
+set -o errexit
+#set -o xtrace
+
+usage() {
+    printf "usage: %s [-b BACKUPDIR][-c CONF][-d DSTDIR][-r ROOTDIR][-x EXCLUDE][-1ahmv] file\n" "$CMDNAME"
+    return 0
+}
+
+man() {
+    sed -n '/^#%MAN_BEGIN%/,/^#%MAN_END%$/{//!s/^#[ ]\{0,1\}//p}' "$SCRIPT" | more
+}
+
+# log function
+# parameters:
+# -l, -s: long, or short prefix (default: none). Last one is used.
+# -t: timestamp
+# -n: no newline
+# This function accepts either a string, either a format string followed
+# by arguments :
+#   log -s "%s" "foo"
+#   log -s "foo"
+log() {
+    local timestr="" prefix="" newline=y todo OPTIND
+    [[ -z $VERBOSE ]] && return 0
+    while getopts lsnt todo; do
+        case $todo in
+            l) prefix=$(printf "*%.s" {1..30})
+               ;;
+            s) prefix=$(printf "*%.s" {1..5})
+               ;;
+            n) newline=n
+               ;;
+            t) timestr=$(date "+%F %T%z ")
+               ;;
+            *)
+               ;;
+        esac
+    done
+    shift $((OPTIND - 1))
+    [[ $prefix != "" ]] && printf "%s " "$prefix"
+    [[ $timestr != "" ]] && printf "%s" "$timestr"
+    # shellcheck disable=SC2059
+    printf "$@"
+    [[ $newline = y ]] && printf "\n"
+    return 0
+}
+
+# filetype() - get file type
+#
+# $1: the file to check
+#
+# @return: 0, output a string with file type on stdout.
+filetype() {
+    local file="$1" type="unknown"
+    if [[ ! -e "$file" ]]; then
+        type="missing"
+    elif [[ -h "$file" ]]; then
+        type="symlink"
+    elif [[ -f "$file" ]]; then
+        type="file"
+    elif [[ -d "$file" ]]; then
+        type="directory"
+    elif [[ -p "$file" ]]; then
+        type="fifo"
+    elif [[ -b "$file" || -c "$file" ]]; then
+        type="device"
+    fi
+    printf "%s" "$type"
+    return 0
+}
+
+# command-line parsing / configuration file read.
+parse_opts() {
+    # short and long options
+    local sopts="1ab:c:d:hmr:vx:"
+    local lopts="unique,absolute-target,backupdir:,config:,destdir:,help,man,root:,verbose,exclude:"
+    local tmp tmp_destdir="" tmp_destdir="" tmp_rootdir="" tmp_config=""
+
+    if ! tmp=$(getopt -o "$sopts" -l "$lopts" -n "$CMD" -- "$@"); then
+        log "Use '$CMD --help' or '$CMD --man' for help."
+        exit 1
+    fi
+
+    eval set -- "$tmp"
+
+    while true; do
+        case "$1" in
+            -1|--unique)
+                UNIQUE=yes
+                ;;
+            '-a'|'--absolute-target')
+                RESOLVETARGET=""
+                ;;
+            '-b'|'--backupdir')
+                tmp_backupdir="$2"
+                shift
+                ;;
+            '-c'|'--config')
+                # The configuration file contains the variable SOURCEDIR, which will allow
+                # to find the relative path of TARGET in backup tree.
+                # it may also contain BACKUPDIR variable, which the local root of backup
+                # tree.
+                tmp_config="$2"
+                shift
+                ;;
+            '-d'|'--destdir')
+                tmp_destdir="$2"
+                shift
+                ;;
+            '-h'|'--help')
+                usage
+                exit 0
+                ;;
+            '-m'|'--man')
+                man
+                exit 0
+                ;;
+            '-r'|'--rootdir')
+                tmp_rootdir="$2"
+                shift
+                ;;
+            '-v'|'--verbose')
+                VERBOSE=yes
+                ;;
+            '-x'|'--exclude')
+                EXCLUDE="$2"
+                shift
+                ;;
+            '--')
+                shift
+                break
+                ;;
+            *)
+                usage
+                log 'Internal error!'
+                exit 1
+                ;;
+        esac
+        shift
+    done
+    # Now check remaining argument (searched file).
+    if (( $# != 1 )); then
+        usage
+        exit 1
+    fi
+    TARGET="$1"
+    [[ -z $RESOLVETARGET ]] || TARGET="$(realpath -L "$TARGET")"
+
+    # if $config is not set, look for .syncrc in BACKUPDIR
+    tmp_config=${tmp_config:-$tmp_backupdir/daily-01/.syncrc}
+    if [[ -z "$tmp_config" ]]; then
+        printf "%s: Missing configuration file.\n" "$CMDNAME"
+        exit 10
+    elif [[ ! -r "$tmp_config" ]]; then
+        printf "%s: Cannot open %s file. Exiting.\n" "$CMDNAME" "$tmp_config"
+        exit 9
+    fi
+
+    # shellcheck source=sync-conf-example.sh
+    source "$tmp_config"
+    [[ -n "$SOURCEDIR" ]] && ROOTDIR="$SOURCEDIR"
+
+    [[ -n "$tmp_backupdir" ]] && BACKUPDIR="$tmp_backupdir"
+    [[ -n "$tmp_destdir" ]] && TARGETDIR="$tmp_destdir"
+    [[ -n "$tmp_rootdir" ]] && ROOTDIR="$tmp_rootdir"
+    return 0
+}
+
+check_paths() {
+    local tmp
+
+    [[ -z "$BACKUPDIR" ]] && printf "%s: backup directory is not set.\n" "$CMDNAME" && \
+        ! usage
+    [[ -z "$ROOTDIR" ]] && printf "%s: source directory is not set.\n" "$CMDNAME" && \
+        ! usage
+    if [[ -n "$TARGETDIR" ]]; then
+        if [[ ! -e $TARGETDIR ]]; then
+            log "Creating destination directory %s." "$TARGETDIR"
+            mkdir "$TARGETDIR"
+        fi
+    else
+        tmp="$(basename "$TARGET")"
+        TARGETDIR="$(mktemp -d /tmp/"$tmp"-XXXXXXXX)"
+        log "%s target directory created." "$TARGETDIR"
+    fi
+    log "ROOTDIR=[%s]" "$ROOTDIR"
+    log "BACKUPDIR=[%s]" "$BACKUPDIR"
+    log "TARGETDIR=[%s]" "$TARGETDIR"
+    log "TARGET=[%s]" "$TARGET"
+    for var in BACKUPDIR TARGETDIR; do
+        [[ $var = ROOTDIR && -z $RESOLVETARGET ]] && continue
+        if [[ ! -d "${!var}" ]]; then
+            printf "%s is not a directory.\n" "$var"
+            exit 1
+        fi
+    done
+    if ! pushd "$TARGETDIR" > /dev/null; then
+        printf "cannot change to directory %s.\n" "$TARGETDIR"
+        exit 1
+    fi
+    # remove existing files
+    if [[ -n "$(ls -A .)" ]]; then
+        log "Cleaning existing directory %s." "$TARGETDIR"
+        for target in *; do
+            rm "$target"
+        done
+    fi
+    return 0
+}
+
+parse_opts "$@"
+check_paths
+
+# add missing directories
+declare -a DIRS
+DIRS=("$BACKUPDIR"/{dai,week,month,year}ly-[0-9][0-9])
+log "DIRS=%s" "${DIRS[*]}"
+
+for file in "${DIRS[@]}"; do
+    # src is file/dir in backup tree
+    _tmp=${TARGET#"$ROOTDIR"}
+    [[ $_tmp =~ ^/.*$ ]] || _tmp="/$_tmp"
+    src="$file$_tmp"
+    #printf "src=%s\n" "$src"
+    if [[ ! -e $src ]]; then
+        log "Skipping non-existing %s" "$src"
+        continue
+    fi
+    #ls -li "$src"
+
+    # last modification time in seconds since epoch
+    inode=$(stat --dereference --printf="%i" "$src")
+    date=$(stat --printf="%Y" "$src")
+    date_backup=$(stat --dereference --printf="%Y" "$file")
+    # target is daily-01, etc...
+    #target=$(date --date="@$date" "+%Y-%m-%d %H:%M")" - ${file#"$BACKUPDIR/"}"
+    target="${file#"$BACKUPDIR/"}"
+
+    #printf "target=[%s] src=[%s]\n" "$target" "$src"
+    if [[ -n $EXCLUDE && $target =~ $EXCLUDE ]]; then
+        log "Skipping %s\n" "$file"
+        continue
+    fi
+    if [[ -z $UNIQUE || ! -v INODES[$inode] ]]; then
+        log "Adding %s inode %s (%s)" "$file" "$inode" "$target"
+        ln -fs "$src" "$TARGETDIR/$target"
+    else
+        log "Skipping duplicate inode %s (%s)" "$inode" "$target"
+    fi
+    INODES[$inode]=${INODES[$inode]:-$date}
+    INODES[backup-$inode]=${INODES[backup-$inode]:-$date_backup}
+done
+
+if [[ -n "$(ls -A .)" ]]; then
+    printf "backup date      (backup)|last changed|inode|size|perms|type|path\n"
+    # for file in {dai,week,month,year}ly-[0-9][0-9]; do
+    for symlink in *; do
+        file=$(readlink "$symlink")
+        #printf "file=<%s> link=<%s>\n" "$file" "$symlink" >&2
+        inode=$(stat --printf="%i" "$file")
+        type=$(filetype "$file")
+        #links=$(stat --printf="%h" "$file")
+        date=$(date --date="@${INODES[$inode]}" "+%Y-%m-%d %H:%M")
+        backup_date=$(date --date="@${INODES[backup-$inode]}" "+%Y-%m-%d %H:%M")
+        size=$(stat --printf="%s" "$file")
+        perms=$(stat --printf="%A" "$file")
+        printf "%s (%s)|" "$backup_date" "$symlink"
+        printf "%s|" "$date"
+        #printf "%s|" "$links"
+        printf "%s|" "$inode"
+        printf "%s|" "$size"
+        printf "%s|" "$perms"
+        printf "%s|" "$type"
+        printf "%s\n" "$file"
+        # ls -lrt "$TARGETDIR"
+    done | sort -r
+fi | column -t -s\|
+
+printf "temporary files directory is: %s\n" "$PWD"
+exit 0

bash/sync.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 #
 # sync.sh - a backup utility using ssh/rsync facilities.
 #
@@ -16,12 +16,13 @@
 #       sync.sh - a backup utility using ssh/rsync facilities.
 #
 # SYNOPSIS
-#       sync.sh [-a PERIOD][-DflmnruvzZ] CONFIG
+#       sync.sh [OPTIONS] [SOURCE_DIR]
 #
 # DESCRIPTION
 #       Perform a backup to a local or remote destination, keeping different
 #       versions (daily, weekly, monthly, yearly). All options can be set in
-#       CONFIG file, which is mandatory.
+#       a mandatory configuration file, which is either SOURCE_DIR/.syncrc,
+#       either set with the '-c' option. See option '-c' below.
 #       The synchronization is make with rsync(1), and only files changed or
 #       modified are actually copied; files which are identical with previous
 #       backup are hard-linked to previous one.
@@ -42,6 +43,10 @@
 #          depending on the current day or date: daily backup every day,
 #          weekly every sunday, monthly every first day of month, and yearly
 #          every Jan 1st.
+#       -c CONFIG
+#          Use CONFIG as configuration file. See sync-conf-example.sh.
+#          If this option is used, the script will ignore SOURCE_DIR/.syncrc
+#          file.
 #       -D
 #          By default, this script re-routes all outputs (stdout and stderr)
 #          to a temporary file after basic initialization (mainly options
@@ -221,7 +226,8 @@ man() {
 }
 
 usage() {
-    printf "usage: %s [-a PERIOD][-DflmnruvzZ] config-file\n" "$CMDNAME"
+    printf "usage: %s [-a PERIOD][-c CONFIG][-DflmnruvzZ] [backup_directory]\n" \
+           "$CMDNAME"
     exit 8
 }
 
@@ -417,9 +423,11 @@ exit_handler() {
 ###############################################################################
 # command-line parsing / configuration file read.
 parse_opts() {
+    local _config="" _backup_dir=""
+
     OPTIND=0
     shopt -s extglob                # to parse "-a" option
-    while getopts a:DflmnruvzZ todo; do
+    while getopts a:c:DflmnruvzZ todo; do
         case "$todo" in
             a)
                 # we use US (Unit Separator, 0x1F, control-_) as separator
@@ -437,6 +445,13 @@ parse_opts() {
                     esac
                 done
                 ;;
+            c)
+                _config="$OPTARG"
+                if [[ ! -f "$_config" ]]; then
+                    printf "%s: invalid %s configuration file\n" "$CMDNAME" "$_config"
+                    usage
+                fi
+                ;;
             f)
                 FILTERLNK=y
                 ;;
@@ -470,20 +485,38 @@ parse_opts() {
                 ;;
         esac
     done
-    # Now check remaining argument (configuration file), which should be unique,
-    # and read the file.
+    # Now check remaining argument (backup directory)
     shift $((OPTIND - 1))
-    (( $# != 1 )) && usage
-    CONFIG="$1"
 
-    if [[ ! -r "$CONFIG" ]]; then
-        printf "%s: Cannot open $CONFIG file. Exiting.\n" "$CMDNAME"
+    (( $# > 1 )) && usage
+    if (( $# == 1 )); then
+        _backup_dir="$1"
+        if [[ ! -d $_backup_dir ]]; then
+            printf "%s: %s: not a directory\n" "$CMDNAME" "$_backup_dir"
+            usage
+        fi
+        [[ -f "$_backup_dir/.syncrc" ]] && _config=${_config:-"$_backup_dir/.syncrc"}
+    fi
+
+    # We do not know what to do...
+    [[ -z "$_config" ]] && usage
+
+    # see https://unix.stackexchange.com/questions/406216
+    CONFIG=$(realpath -sm "$_config")
+    if [[ -z "$CONFIG" ]]; then
+        printf "%s: Missing configuration file\n" "$CMDNAME"
+        exit 9
+    elif [[ ! -r "$CONFIG" ]]; then
+        printf "%s: Cannot open %s file\n" "$CMDNAME" "$CONFIG"
         exit 9
     fi
-    # shellcheck source=/dev/null
+    # shellcheck source=share/sync/sync-conf-example.sh
     source "$CONFIG"
 
-    LOCKDIR="/tmp/$CMDNAME-$HOSTNAME-${CONFIG##*/}.lock"
+    # _backup_dir takes precedence on SOURCEDIR (useless ?)
+    SOURCEDIR=${_backup_dir:-$SOURCEDIR}
+
+    LOCKDIR="/tmp/$CMDNAME-$HOSTNAME${SOURCEDIR////-}.lock"
 }
 
 parse_opts "$@"
@@ -529,13 +562,13 @@ TODO=()
 [[ $YEARLY  = y ]] && (( NYEARS  > 0 )) && TODO+=(yearly  "$NYEARS")
 
 log -l -t "Starting %s" "$CMDNAME"
-log "Bash version: %s.%s.%s" \
-    "${BASH_VERSINFO[0]}" "${BASH_VERSINFO[1]}" "${BASH_VERSINFO[2]}"
+log "Bash version: %s.%s.%s" "${BASH_VERSINFO[@]:0:3}"
 log "Hostname: %s" "$HOSTNAME"
 log "Operating System: %s on %s" "$(uname -sr)" "$(uname -m)"
 log "Config : %s\n" "$CONFIG"
 log "Src dir: %s" "$SOURCEDIR"
 log "Dst dir: %s" "$SERVER:$DESTDIR"
+log "Lock dir: %s" "$LOCKDIR"
 log "Actions: %s" "${TODO[*]}"
 if (( ${#RSYNCOPTS[@]} )); then
     log -n "Rsync additional options (%d): " "${#RSYNCOPTS[@]}"

c/Makefile

@@ -0,0 +1,59 @@
+# Tools Makefile
+#
+# 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>
+#
+
+SHELL     := /bin/bash
+CC        := gcc
+BEAR      := bear
+
+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
+
+CPPFLAGS += -DDEBUG_DEBUG		# activate general debug (debug.c)
+CPPFLAGS += -DDEBUG_POOL		# memory pools management
+
+INCDIR    := ./include
+LIBDIR    := ./lib
+OBJDIR    := ./obj
+BRLIBDIR  := ./brlib
+
+LIBNAME   := br_$(shell uname -m)
+#LIB       := lib$(LIBNAME)
+
+
+all: brlib
+
+#export LD_LIBRARY_PATH = $(LIBDIR)
+
+.PHONY: all brlib clean
+
+all: brlib
+
+brlib:
+	$(MAKE) -C $(BRLIBDIR)
+
+bear ccls:
+	@echo building ccls language server compilation database
+	$(MAKE) -C $(BRLIBDIR) ccls
+
+clean:
+	@echo cleaning brlib.
+	@$(MAKE) -C $(BRLIBDIR) clean

c/bits.h

@@ -1,178 +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>
-
-/* next include will define __WORDSIZE: 32 or 64
- */
-#include <bits/wordsize.h>
-
-#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 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;
-
-/* count trailing zeroes : 00101000 -> 3
- *                              ^^^
- */
-static inline int ctz64(u64 n)
-{
-#   if __has_builtin(__builtin_ctzl)
-#   ifdef DEBUG_BITS
-    log_f(1, "builtin ctzl.\n");
-#   endif
-    return __builtin_ctzl(n);
-
-#   elif __has_builtin(__builtin_clzl)
-#   ifdef DEBUG_BITS
-    log_f(1, "builtin clzl.\n");
-#   endif
-    return __WORDSIZE - (__builtin_clzl(n & -n) + 1);
-
-#   else
-#   ifdef DEBUG_BITS
-    log_f(1, "emulated.\n");
-#   endif
-    return popcount64((n & −n) − 1);
-#   endif
-}
-
-/* count leading zeroes : 00101000 -> 2
- *                        ^^
- */
-static inline int clz64(u64 n)
-{
-#   if __has_builtin(__builtin_clzl)
-#   ifdef DEBUG_BITS
-    log_f(1, "builtin.\n");
-#   endif
-    return __builtin_clzl(n);
-
-#   else
-#   ifdef DEBUG_BITS
-    log_f(1, "emulated.\n");
-#   endif
-    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 __WORDSIZE - r - 1;
-#   endif
-}
-
-/* find first set :  00101000 -> 4
- *                       ^
- */
-static inline uint ffs64(u64 n)
-{
-#   if __has_builtin(__builtin_ffsl)
-#   ifdef DEBUG_BITS
-    log_f(1, "builtin ffsl.\n");
-#   endif
-    return __builtin_ffsll(n);
-
-#   elif __has_builtin(__builtin_ctzl)
-#   ifdef DEBUG_BITS
-    log_f(1, "builtin ctzl.\n");
-#   endif
-    if (n == 0)
-        return (0);
-    return __builtin_ctzl(n) + 1;
-
-#   else
-#   ifdef DEBUG_BITS
-    log_f(1, "emulated.\n");
-#   endif
-    return popcount64(n ^ ~-n);
-#   endif
-}
-
-static inline int popcount64(u64 n)
-{
-#   if __has_builtin(__builtin_popcountl)
-#   ifdef DEBUG_BITS
-    log_f(1, "builtin.\n");
-#   endif
-    return __builtin_popcountl(n);
-
-#   else
-#   ifdef DEBUG_BITS
-    log_f(1, "emulated.\n");
-#   endif
-    int count = 0;
-    while (n) {
-        count++;
-        n &= (n - 1);
-    }
-    return count;
-#   endif
-}
-
-/** bit_for_each64 - iterate over an u64 bits
- * @pos:        an int used as current bit
- * @tmp:        a temp u64 used as temporary storage
- * @ul:         the u64 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))
-
-/** 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))
-
-#endif  /* BITS_H */

c/brlib/Makefile

@@ -0,0 +1,281 @@
+# brlib Makefile - GNU make only
+#
+# Copyright (C) 2021-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>
+#
+
+# important to know where exactly is project root dir
+ROOTDIR   := $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
+
+SHELL     := /bin/bash
+CC        := gcc
+LD        := ld
+BEAR      := bear
+TOUCH     := touch
+RM        := rm
+RMDIR     := rmdir
+
+SRCDIR    := ./src
+INCDIR    := ./include
+OBJDIR    := ./obj
+LIBDIR    := ./lib
+BINDIR    := ./bin
+DEPDIR    := ./dep
+
+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))
+
+##################################### emacs projectile/ccls
+PRJROOT   := .projectile
+CCLSROOT  := .ccls-root
+CCLSCMDS  := compile_commands.json
+
+##################################### pre-processor flags
+CPPFLAGS  := -I$(INCDIR)
+#CPPFLAGS  += -DDEBUG                                       # global
+CPPFLAGS  += -DDEBUG_DEBUG                                  # enable log() functions
+#CPPFLAGS  += -DDEBUG_DEBUG_C                               # log() funcs debug
+PPFLAGS   += -DDEBUG_DEBUG                                  # activate logs funcs
+CPPFLAGS  += -DDEBUG_POOL                                   # mem pools
+
+# remove extraneous spaces (due to spaces before comments)
+CPPFLAGS  := $(strip $(CPPFLAGS))
+
+##################################### compiler flags
+CFLAGS    := -std=gnu11
+CFLAGS    += -O2
+CFLAGS    += -g
+CFLAGS    += -Wall
+CFLAGS    += -Wextra
+CFLAGS    += -march=native
+CFLAGS    += -Wmissing-declarations
+CFLAGS    += -Wno-unused-result
+CFLAGS    += -fPIC
+# for gprof
+#CFLAGS    += -pg
+# Next one may be useful for valgrind (some invalid instructions)
+# CFLAGS   += -mno-tbm
+
+CFLAGS    := $(strip $(CFLAGS))
+
+##################################### archiver/linker/dependency flags
+ARFLAGS   := rcs
+LDFLAGS   := -L$(LIBDIR)
+DEPFLAGS   = -MMD -MP -MF $(DEPDIR)/$*.d
+
+##################################### General targets
+.PHONY: all compile clean cleanall
+
+all: libs
+
+compile: objs
+
+clean: cleandep cleanobj cleanlib cleanbin
+
+cleanall: clean cleandepdir cleanobjdir cleanlibdir cleanbindir
+
+# setup emacs projectile/ccls
+emacs: emacs-setup
+# update compile-commands.json
+ccls: $(CCLSCMDS)
+
+##################################### 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 -p $@
+
+##################################### 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: objs cleanobj cleanobjdir
+
+objs: $(OBJ)
+
+cleanobj:
+	$(call rmfiles,$(OBJ),brlib object)
+
+cleanobjdir:
+	$(call rmdir,$(OBJDIR),brlib objects)
+
+$(OBJDIR)/%.o: $(SRCDIR)/%.c | $(OBJDIR) $(DEPDIR)
+	@echo compiling $< "->" $@.
+	$(CC) -c $(DEPFLAGS) $(CPPFLAGS) $(CFLAGS) $< -o $@
+
+##################################### brlib libraries
+.PHONY: libs cleanlib cleanlibdir
+
+libs: $(DLIB) $(SLIB)
+
+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
+
+##################################### brchess binaries
+.PHONY: targets cleanbin cleanbindir
+
+targets: $(TARGET)
+
+cleanbin:
+	$(call rmfiles,$(TARGET),binary)
+
+cleanbindir:
+	$(call rmdir,$(BINDIR),binaries)
+
+##################################### 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 $@
+
+##################################### LSP (ccls)
+.PHONY: emacs-setup
+
+PRJROOT   := .projectile
+CCLSROOT  := .ccls-root
+CCLSFILE  := .ccls
+CCLSCMDS  := compile_commands.json
+
+emacs-setup: $(PRJROOT) $(CCLSROOT) $(CCLSCMDS)
+
+#$(CCLSFILE):
+#	@echo "creating CCLS's $@ project root file."
+#	echo '%compile_commands.json' > $@
+
+$(CCLSROOT) $(PRJROOT):
+	@if [[ $(@) = $(PRJROOT) ]] ;                           \
+	then                                                    \
+		echo "creating Emacs's projectile root file." ; \
+	else                                                    \
+		echo "creating Emacs's ccls root file." ;       \
+	fi
+	@$(TOUCH) $@
+
+# 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 compile
+
+#.PHONY: bear
+#bear: cleanobj cleanlibobj Makefile | $(CCLSROOT)
+#    @$(BEAR) -- make compile
+
+##################################### 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 "ROOTDIR=+%s+\n\n" "$(ROOTDIR)"
+	@printf "OBJDIR=%s\n\n" "$(OBJDIR)"
+	@printf "OBJ=%s\n\n" "$(OBJ)"

c/brlib/include/bits.h

@@ -0,0 +1,499 @@
+/* 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/br.h

@@ -0,0 +1,224 @@
+/* br.h - misc macros.
+ *
+ * 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>
+ *
+ * Some parts are taken from Linux's kernel <linux/kernel.h> and others, and are :
+ * SPDX-License-Identifier: GPL-2.0
+ *
+ * This header contains generic stuff.
+ */
+
+#ifndef _BR_H
+#define _BR_H
+
+#include "struct-group.h"
+
+/* Indirect stringification.  Doing two levels allows the parameter to be a
+ * macro itself.  For example, compile with -DFOO=bar, __stringify(FOO)
+ * converts to "bar".
+ */
+#define __stringify_1(x...)	#x
+#define __stringify(x...)	__stringify_1(x)
+
+/* generate a (maybe) unique id.
+ */
+#define ___PASTE(x, y)      x##y
+#define __PASTE(x, y)       ___PASTE(x, y)
+#define __UNIQUE_ID(prefix) __PASTE(__PASTE(__UNIQUE_ID_, prefix), __COUNTER__)
+
+/* unused/used parameters/functions
+ * https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-unused-function-attribute
+ * https://gcc.gnu.org/onlinedocs/gcc/Common-Type-Attributes.html#index-unused-type-attribute
+ * https://gcc.gnu.org/onlinedocs/gcc/Common-Variable-Attributes.html#index-unused-variable-attribute
+ * https://gcc.gnu.org/onlinedocs/gcc/Label-Attributes.html#index-unused-label-attribute
+ * https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-used-function-attribute
+ * https://gcc.gnu.org/onlinedocs/gcc/Common-Variable-Attributes.html#index-used-variable-attribute
+ */
+#define __unused             __attribute__((__unused__))
+#define __used               __attribute__((__used__))
+
+/* see https://lkml.org/lkml/2018/3/20/845 for explanation of this monster
+ */
+#define __is_constexpr(x) \
+	(sizeof(int) == sizeof(*(8 ? ((void *)((long)(x) * 0l)) : (int *)8)))
+
+/*
+ * min()/max()/clamp() macros must accomplish three things:
+ *
+ * - avoid multiple evaluations of the arguments (so side-effects like
+ *   "x++" happen only once) when non-constant.
+ * - perform strict type-checking (to generate warnings instead of
+ *   nasty runtime surprises). See the "unnecessary" pointer comparison
+ *   in __typecheck().
+ * - retain result as a constant expressions when called with only
+ *   constant expressions (to avoid tripping VLA warnings in stack
+ *   allocation usage).
+ */
+#define __typecheck(x, y) \
+	(!!(sizeof((typeof(x) *)1 == (typeof(y) *)1)))
+
+#define __no_side_effects(x, y) \
+		(__is_constexpr(x) && __is_constexpr(y))
+
+#define __safe_cmp(x, y) \
+		(__typecheck(x, y) && __no_side_effects(x, y))
+
+#define __cmp(x, y, op)	((x) op (y) ? (x) : (y))
+
+#define __cmp_once(x, y, unique_x, unique_y, op) ({	\
+		typeof(x) unique_x = (x);		\
+		typeof(y) unique_y = (y);		\
+		__cmp(unique_x, unique_y, op); })
+
+#define __careful_cmp(x, y, op) \
+	__builtin_choose_expr(__safe_cmp(x, y), \
+		__cmp(x, y, op), \
+		__cmp_once(x, y, __UNIQUE_ID(__x), __UNIQUE_ID(__y), op))
+
+#define __pure   __attribute__((__pure__))
+
+/**
+ * min - return minimum of two values of the same or compatible types
+ * @x: first value
+ * @y: second value
+ */
+#define min(x, y)	__careful_cmp(x, y, <)
+
+/**
+ * max - return maximum of two values of the same or compatible types
+ * @x: first value
+ * @y: second value
+ */
+#define max(x, y)	__careful_cmp(x, y, >)
+
+/**
+ * min3 - return minimum of three values
+ * @x: first value
+ * @y: second value
+ * @z: third value
+ */
+#define min3(x, y, z) min((typeof(x))min(x, y), z)
+
+/**
+ * max3 - return maximum of three values
+ * @x: first value
+ * @y: second value
+ * @z: third value
+ */
+#define max3(x, y, z) max((typeof(x))max(x, y), z)
+
+/**
+ * min_not_zero - return the minimum that is _not_ zero, unless both are zero
+ * @x: value1
+ * @y: value2
+ */
+#define min_not_zero(x, y) ({			\
+	typeof(x) __x = (x);			\
+	typeof(y) __y = (y);			\
+	__x == 0 ? __y : ((__y == 0) ? __x : min(__x, __y)); })
+
+/**
+ * clamp - return a value clamped to a given range with strict typechecking
+ * @val: current value
+ * @lo: lowest allowable value
+ * @hi: highest allowable value
+ *
+ * This macro does strict typechecking of @lo/@hi to make sure they are of the
+ * same type as @val.  See the unnecessary pointer comparisons.
+ */
+#define clamp(val, lo, hi) min((typeof(val))max(val, lo), hi)
+
+/*
+ * ..and if you can't take the strict
+ * types, you can specify one yourself.
+ *
+ * Or not use min/max/clamp at all, of course.
+ */
+
+/**
+ * min_t - return minimum of two values, using the specified type
+ * @type: data type to use
+ * @x: first value
+ * @y: second value
+ */
+#define min_t(type, x, y)	__careful_cmp((type)(x), (type)(y), <)
+
+/**
+ * max_t - return maximum of two values, using the specified type
+ * @type: data type to use
+ * @x: first value
+ * @y: second value
+ */
+#define max_t(type, x, y)	__careful_cmp((type)(x), (type)(y), >)
+
+/**
+ * clamp_t - return a value clamped to a given range using a given type
+ * @type: the type of variable to use
+ * @val: current value
+ * @lo: minimum allowable value
+ * @hi: maximum allowable value
+ *
+ * This macro does no typechecking and uses temporary variables of type
+ * @type to make all the comparisons.
+ */
+#define clamp_t(type, val, lo, hi) min_t(type, max_t(type, val, lo), hi)
+
+/**
+ * clamp_val - return a value clamped to a given range using val's type
+ * @val: current value
+ * @lo: minimum allowable value
+ * @hi: maximum allowable value
+ *
+ * This macro does no typechecking and uses temporary variables of whatever
+ * type the input argument @val is.  This is useful when @val is an unsigned
+ * type and @lo and @hi are literals that will otherwise be assigned a signed
+ * integer type.
+ */
+#define clamp_val(val, lo, hi) clamp_t(typeof(val), val, lo, hi)
+
+/**
+ * swap - swap values of @a and @b
+ * @a: first value
+ * @b: second value
+ */
+#define swap(a, b) \
+	do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
+
+/**
+ * ARRAY_SIZE - get the number of elements in array @arr
+ * @arr: array to be sized
+ */
+#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
+
+/**
+ * abs - return absolute value of an argument
+ * @x: the value.  If it is unsigned type, it is converted to signed type first.
+ *     char is treated as if it was signed (regardless of whether it really is)
+ *     but the macro's return type is preserved as char.
+ *
+ * Return: an absolute value of x.
+ */
+#define abs(x)	__abs_choose_expr(x, long long,				\
+		__abs_choose_expr(x, long,				\
+		__abs_choose_expr(x, int,				\
+		__abs_choose_expr(x, short,				\
+		__abs_choose_expr(x, char,				\
+		__builtin_choose_expr(					\
+			__builtin_types_compatible_p(typeof(x), char),	\
+			(char)({ signed char __x = (x); __x<0?-__x:__x; }), \
+			((void)0)))))))
+
+#define __abs_choose_expr(x, type, other) __builtin_choose_expr(	\
+	__builtin_types_compatible_p(typeof(x),   signed type) ||	\
+	__builtin_types_compatible_p(typeof(x), unsigned type),		\
+	({ signed type __x = (x); __x < 0 ? -__x : __x; }), other)
+
+
+#endif  /* _BR_H */

c/brlib/include/bug.h

@@ -0,0 +1,71 @@
+/* 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/container-of.h

@@ -0,0 +1,30 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+
+/* adaptation of Linux kernel's <linux/container_of.h>
+ */
+#ifndef _BR_CONTAINER_OF_H
+#define _BR_CONTAINER_OF_H
+
+/* Are two types/vars the same type (ignoring qualifiers)? */
+#define __same_type(a, b) __builtin_types_compatible_p(typeof(a), typeof(b))
+
+/**
+ * typeof_member -
+ */
+#define typeof_member(T, m)     typeof(((T*)0)->m)
+
+/**
+ * container_of - cast a member of a structure out to the containing structure
+ * @ptr:        the pointer to the member.
+ * @type:       the type of the container struct this is embedded in.
+ * @member:     the name of the member within the struct.
+ *
+ */
+#define container_of(ptr, type, member) ({                              \
+        void *__mptr = (void *)(ptr);                                   \
+        _Static_assert(__same_type(*(ptr), ((type *)0)->member) ||       \
+                      __same_type(*(ptr), void),                        \
+                      "pointer type mismatch in container_of()");       \
+        ((type *)(__mptr - offsetof(type, member))); })
+
+#endif /* BR_CONTAINER_OF_H */

c/brlib/include/debug.h

@@ -0,0 +1,115 @@
+/* debug.h - debug/log management.
+ *
+ * Copyright (C) 2021-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>
+ *
+ */
+
+#ifndef DEBUG_H
+#define DEBUG_H
+
+#include <stdio.h>
+#include <stdbool.h>
+#include <stdint.h>
+
+#include <br.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
+
+void debug_init(int level, FILE *stream, bool flush);
+void debug_level_set(int level);
+int debug_level_get(void);
+void debug_stream_set(FILE *stream);
+long long debug_timer_elapsed(void);
+void debug_flush_set(bool flush);
+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 */

c/brlib/include/hash.h

@@ -0,0 +1,172 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+
+#ifndef _BR_HASH_H
+#define _BR_HASH_H
+/* adaptation of Linux kernel's <linux/hash.h> and <linux/stringhash.h>
+ */
+
+/* Fast hashing routine for ints,  longs and pointers.
+   (C) 2002 Nadia Yvette Chambers, IBM */
+
+#include <asm/bitsperlong.h>
+#include "bits.h"
+#include "br.h"
+
+/*
+ * The "GOLDEN_RATIO_PRIME" is used in ifs/btrfs/brtfs_inode.h and
+ * fs/inode.c.  It's not actually prime any more (the previous primes
+ * were actively bad for hashing), but the name remains.
+ */
+#if __BITS_PER_LONG == 32
+#define GOLDEN_RATIO_PRIME GOLDEN_RATIO_32
+#define hash_long(val, bits) hash_32(val, bits)
+#elif __BITS_PER_LONG == 64
+#define hash_long(val, bits) hash_64(val, bits)
+#define GOLDEN_RATIO_PRIME GOLDEN_RATIO_64
+#else
+#error Wordsize not 32 or 64
+#endif
+
+/*
+ * This hash multiplies the input by a large odd number and takes the
+ * high bits.  Since multiplication propagates changes to the most
+ * significant end only, it is essential that the high bits of the
+ * product be used for the hash value.
+ *
+ * Chuck Lever verified the effectiveness of this technique:
+ * http://www.citi.umich.edu/techreports/reports/citi-tr-00-1.pdf
+ *
+ * Although a random odd number will do, it turns out that the golden
+ * ratio phi = (sqrt(5)-1)/2, or its negative, has particularly nice
+ * properties.  (See Knuth vol 3, section 6.4, exercise 9.)
+ *
+ * These are the negative, (1 - phi) = phi**2 = (3 - sqrt(5))/2,
+ * which is very slightly easier to multiply by and makes no
+ * difference to the hash distribution.
+ */
+#define GOLDEN_RATIO_32 0x61C88647
+#define GOLDEN_RATIO_64 0x61C8864680B583EBull
+
+/*
+ * The _generic versions exist only so lib/test_hash.c can compare
+ * the arch-optimized versions with the generic.
+ *
+ * Note that if you change these, any <asm/hash.h> that aren't updated
+ * to match need to have their HAVE_ARCH_* define values updated so the
+ * self-test will not false-positive.
+ */
+#ifndef HAVE_ARCH__HASH_32
+#define __hash_32 __hash_32_generic
+#endif
+static inline u32 __hash_32_generic(u32 val)
+{
+	return val * GOLDEN_RATIO_32;
+}
+
+static inline u32 hash_32(u32 val, unsigned int bits)
+{
+	/* High bits are more random, so use them. */
+	return __hash_32(val) >> (32 - bits);
+}
+
+#ifndef HAVE_ARCH_HASH_64
+#define hash_64 hash_64_generic
+#endif
+static __always_inline u32 hash_64_generic(u64 val, unsigned int bits)
+{
+#if __BITS_PER_LONG == 64
+	/* 64x64-bit multiply is efficient on all 64-bit processors */
+	return val * GOLDEN_RATIO_64 >> (64 - bits);
+#else
+	/* Hash 64 bits using only 32x32-bit multiply. */
+	return hash_32((u32)val ^ __hash_32(val >> 32), bits);
+#endif
+}
+
+static inline u32 hash_ptr(const void *ptr, unsigned int bits)
+{
+	return hash_long((unsigned long)ptr, bits);
+}
+
+/* This really should be called fold32_ptr; it does no hashing to speak of. */
+static inline u32 hash32_ptr(const void *ptr)
+{
+	unsigned long val = (unsigned long)ptr;
+
+#if __BITS_PER_LONG == 64
+	val ^= (val >> 32);
+#endif
+	return (u32)val;
+}
+
+/*
+ * Routines for hashing strings of bytes to a 32-bit hash value.
+ *
+ * These hash functions are NOT GUARANTEED STABLE between kernel
+ * versions, architectures, or even repeated boots of the same kernel.
+ * (E.g. they may depend on boot-time hardware detection or be
+ * deliberately randomized.)
+ *
+ * They are also not intended to be secure against collisions caused by
+ * malicious inputs; much slower hash functions are required for that.
+ *
+ * They are optimized for pathname components, meaning short strings.
+ * Even if a majority of files have longer names, the dynamic profile of
+ * pathname components skews short due to short directory names.
+ * (E.g. /usr/lib/libsesquipedalianism.so.3.141.)
+ */
+
+/*
+ * Version 1: one byte at a time.  Example of use:
+ *
+ * unsigned long hash = init_name_hash;
+ * while (*p)
+ *	hash = partial_name_hash(tolower(*p++), hash);
+ * hash = end_name_hash(hash);
+ *
+ * Although this is designed for bytes, fs/hfsplus/unicode.c
+ * abuses it to hash 16-bit values.
+ */
+
+/* Hash courtesy of the R5 hash in reiserfs modulo sign bits */
+#define init_name_hash(salt)		(unsigned long)(salt)
+
+/* partial hash update function. Assume roughly 4 bits per character */
+static inline unsigned long
+partial_name_hash(unsigned long c, unsigned long prevhash)
+{
+	return (prevhash + (c << 4) + (c >> 4)) * 11;
+}
+
+/*
+ * Finally: cut down the number of bits to a int value (and try to avoid
+ * losing bits).  This also has the property (wanted by the dcache)
+ * that the msbits make a good hash table index.
+ */
+static inline unsigned int end_name_hash(unsigned long hash)
+{
+	return hash_long(hash, 32);
+}
+
+/*
+ * Version 2: One word (32 or 64 bits) at a time.
+ * If CONFIG_DCACHE_WORD_ACCESS is defined (meaning <asm/word-at-a-time.h>
+ * exists, which describes major Linux platforms like x86 and ARM), then
+ * this computes a different hash function much faster.
+ *
+ * If not set, this falls back to a wrapper around the preceding.
+ */
+extern unsigned int __pure hash_string(const void *salt, const char *, unsigned int);
+
+/*
+ * A hash_len is a u64 with the hash of a string in the low
+ * half and the length in the high half.
+ */
+#define hashlen_hash(hashlen) ((u32)(hashlen))
+#define hashlen_len(hashlen)  ((u32)((hashlen) >> 32))
+#define hashlen_create(hash, len) ((u64)(len)<<32 | (u32)(hash))
+
+/* Return the "hash_len" (hash and length) of a null-terminated string */
+extern u64 __pure hashlen_string(const void *salt, const char *name);
+
+#endif /* _BR_HASH_H */

c/brlib/include/hashtable.h

@@ -0,0 +1,202 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+/* adaptation of Linux kernel's <linux/hashtable.h>
+ */
+
+
+/*
+ * Statically sized hash table implementation
+ * (C) 2012  Sasha Levin <levinsasha928@gmail.com>
+ */
+
+#ifndef _LINUX_HASHTABLE_H
+#define _LINUX_HASHTABLE_H
+
+#include "list.h"
+#include "hash.h"
+//#include <linux/rculist.h>
+
+#define DEFINE_HASHTABLE(name, bits)						\
+	struct hlist_head name[1 << (bits)] =					\
+			{ [0 ... ((1 << (bits)) - 1)] = HLIST_HEAD_INIT }
+
+#define DEFINE_READ_MOSTLY_HASHTABLE(name, bits)				\
+	struct hlist_head name[1 << (bits)] __read_mostly =			\
+			{ [0 ... ((1 << (bits)) - 1)] = HLIST_HEAD_INIT }
+
+#define DECLARE_HASHTABLE(name, bits)                                   	\
+	struct hlist_head name[1 << (bits)]
+
+#define HASH_SIZE(name) (ARRAY_SIZE(name))
+#define HASH_BITS(name) ilog2(HASH_SIZE(name))
+
+/* Use hash_32 when possible to allow for fast 32bit hashing in 64bit kernels. */
+#define hash_min(val, bits)							\
+	(sizeof(val) <= 4 ? hash_32(val, bits) : hash_long(val, bits))
+
+static inline void __hash_init(struct hlist_head *ht, unsigned int sz)
+{
+	unsigned int i;
+
+	for (i = 0; i < sz; i++)
+		INIT_HLIST_HEAD(&ht[i]);
+}
+
+/**
+ * hash_init - initialize a hash table
+ * @hashtable: hashtable to be initialized
+ *
+ * Calculates the size of the hashtable from the given parameter, otherwise
+ * same as hash_init_size.
+ *
+ * This has to be a macro since HASH_BITS() will not work on pointers since
+ * it calculates the size during preprocessing.
+ */
+#define hash_init(hashtable) __hash_init(hashtable, HASH_SIZE(hashtable))
+
+/**
+ * hash_add - add an object to a hashtable
+ * @hashtable: hashtable to add to
+ * @node: the &struct hlist_node of the object to be added
+ * @key: the key of the object to be added
+ */
+#define hash_add(hashtable, node, key)						\
+	hlist_add_head(node, &hashtable[hash_min(key, HASH_BITS(hashtable))])
+
+/**
+ * hash_add_rcu - add an object to a rcu enabled hashtable
+ * @hashtable: hashtable to add to
+ * @node: the &struct hlist_node of the object to be added
+ * @key: the key of the object to be added
+ */
+#define hash_add_rcu(hashtable, node, key)					\
+	hlist_add_head_rcu(node, &hashtable[hash_min(key, HASH_BITS(hashtable))])
+
+/**
+ * hash_hashed - check whether an object is in any hashtable
+ * @node: the &struct hlist_node of the object to be checked
+ */
+static inline bool hash_hashed(struct hlist_node *node)
+{
+	return !hlist_unhashed(node);
+}
+
+static inline bool __hash_empty(struct hlist_head *ht, unsigned int sz)
+{
+	unsigned int i;
+
+	for (i = 0; i < sz; i++)
+		if (!hlist_empty(&ht[i]))
+			return false;
+
+	return true;
+}
+
+/**
+ * hash_empty - check whether a hashtable is empty
+ * @hashtable: hashtable to check
+ *
+ * This has to be a macro since HASH_BITS() will not work on pointers since
+ * it calculates the size during preprocessing.
+ */
+#define hash_empty(hashtable) __hash_empty(hashtable, HASH_SIZE(hashtable))
+
+/**
+ * hash_del - remove an object from a hashtable
+ * @node: &struct hlist_node of the object to remove
+ */
+static inline void hash_del(struct hlist_node *node)
+{
+	hlist_del_init(node);
+}
+
+/**
+ * hash_for_each - iterate over a hashtable
+ * @name: hashtable to iterate
+ * @bkt: integer to use as bucket loop cursor
+ * @obj: the type * to use as a loop cursor for each entry
+ * @member: the name of the hlist_node within the struct
+ */
+#define hash_for_each(name, bkt, obj, member)				\
+	for ((bkt) = 0, obj = NULL; obj == NULL && (bkt) < HASH_SIZE(name);\
+			(bkt)++)\
+		hlist_for_each_entry(obj, &name[bkt], member)
+
+/**
+ * hash_for_each_rcu - iterate over a rcu enabled hashtable
+ * @name: hashtable to iterate
+ * @bkt: integer to use as bucket loop cursor
+ * @obj: the type * to use as a loop cursor for each entry
+ * @member: the name of the hlist_node within the struct
+ */
+#define hash_for_each_rcu(name, bkt, obj, member)			\
+	for ((bkt) = 0, obj = NULL; obj == NULL && (bkt) < HASH_SIZE(name);\
+			(bkt)++)\
+		hlist_for_each_entry_rcu(obj, &name[bkt], member)
+
+/**
+ * hash_for_each_safe - iterate over a hashtable safe against removal of
+ * hash entry
+ * @name: hashtable to iterate
+ * @bkt: integer to use as bucket loop cursor
+ * @tmp: a &struct hlist_node used for temporary storage
+ * @obj: the type * to use as a loop cursor for each entry
+ * @member: the name of the hlist_node within the struct
+ */
+#define hash_for_each_safe(name, bkt, tmp, obj, member)			\
+	for ((bkt) = 0, obj = NULL; obj == NULL && (bkt) < HASH_SIZE(name);\
+			(bkt)++)\
+		hlist_for_each_entry_safe(obj, tmp, &name[bkt], member)
+
+/**
+ * hash_for_each_possible - iterate over all possible objects hashing to the
+ * same bucket
+ * @name: hashtable to iterate
+ * @obj: the type * to use as a loop cursor for each entry
+ * @member: the name of the hlist_node within the struct
+ * @key: the key of the objects to iterate over
+ */
+#define hash_for_each_possible(name, obj, member, key)			\
+	hlist_for_each_entry(obj, &name[hash_min(key, HASH_BITS(name))], member)
+
+/**
+ * hash_for_each_possible_rcu - iterate over all possible objects hashing to the
+ * same bucket in an rcu enabled hashtable
+ * @name: hashtable to iterate
+ * @obj: the type * to use as a loop cursor for each entry
+ * @member: the name of the hlist_node within the struct
+ * @key: the key of the objects to iterate over
+ */
+#define hash_for_each_possible_rcu(name, obj, member, key, cond...)	\
+	hlist_for_each_entry_rcu(obj, &name[hash_min(key, HASH_BITS(name))],\
+		member, ## cond)
+
+/**
+ * hash_for_each_possible_rcu_notrace - iterate over all possible objects hashing
+ * to the same bucket in an rcu enabled hashtable in a rcu enabled hashtable
+ * @name: hashtable to iterate
+ * @obj: the type * to use as a loop cursor for each entry
+ * @member: the name of the hlist_node within the struct
+ * @key: the key of the objects to iterate over
+ *
+ * This is the same as hash_for_each_possible_rcu() except that it does
+ * not do any RCU debugging or tracing.
+ */
+#define hash_for_each_possible_rcu_notrace(name, obj, member, key) \
+	hlist_for_each_entry_rcu_notrace(obj, \
+		&name[hash_min(key, HASH_BITS(name))], member)
+
+/**
+ * hash_for_each_possible_safe - iterate over all possible objects hashing to the
+ * same bucket safe against removals
+ * @name: hashtable to iterate
+ * @obj: the type * to use as a loop cursor for each entry
+ * @tmp: a &struct hlist_node used for temporary storage
+ * @member: the name of the hlist_node within the struct
+ * @key: the key of the objects to iterate over
+ */
+#define hash_for_each_possible_safe(name, obj, tmp, member, key)	\
+	hlist_for_each_entry_safe(obj, tmp,\
+		&name[hash_min(key, HASH_BITS(name))], member)
+
+
+#endif

c/brlib/include/likely.h

@@ -0,0 +1,18 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+
+/*  taken from Kernel's <linux/compiler.h
+ */
+#ifndef __LIKELY_H
+#define __LIKELY_H
+
+/* See https://kernelnewbies.org/FAQ/LikelyUnlikely
+ *
+ * In 2 words:
+ * "You should use it [likely() and unlikely()] only in cases when the likeliest
+ *  branch is very very very likely, or when the unlikeliest branch is very very
+ *  very unlikely."
+ */
+# define likely(x)      __builtin_expect(!!(x), 1)
+# define unlikely(x)    __builtin_expect(!!(x), 0)
+
+#endif /* __LIKELY_H */

c/brlib/include/list.h

@@ -1,8 +1,7 @@
 /* SPDX-License-Identifier: GPL-2.0 */
 
 /* adaptation of kernel's <linux/list.h>
- * Main change is that I don't use READ_ONCE and WRITE_ONCE
- * See https://www.kernel.org/doc/Documentation/memory-barriers.txt
+ *
  */
 
 #ifndef __BR_LIST_H
@@ -11,6 +10,7 @@
 #include <stddef.h>
 #include <stdbool.h>
 #include "rwonce.h"
+#include "container-of.h"
 
 /************ originally in <include/linux/types.h> */
 struct list_head {
@@ -33,11 +33,6 @@ struct hlist_node {
 #define LIST_POISON1  ((void *) 0x100 + POISON_POINTER_DELTA)
 #define LIST_POISON2  ((void *) 0x200 + POISON_POINTER_DELTA)
 
-/************ originally in <include/linux/kernel.h> */
-#define container_of(ptr, type, member) ({				\
-	void *__mptr = (void *)(ptr);					\
-	((type *)(__mptr - offsetof(type, member))); })
-
 /*
  * Circular doubly linked list implementation.
  *

c/brlib/include/pjwhash-inline.h

@@ -0,0 +1,53 @@
+/* pjwhash-inline.h - PJW hash function, inline version.
+ *
+ * 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 _PJWHASH_INLINE_H
+#define _PJWHASH_INLINE_H
+
+#include "bits.h"
+
+#define THREE_QUARTERS ((int) ((BITS_PER_INT * 3) / 4))
+#define ONE_EIGHTH     ((int) (BITS_PER_INT / 8))
+#define HIGH_BITS      ( ~((uint)(~0) >> ONE_EIGHTH ))
+
+#ifndef _pjw_inline
+#define _pjw_inline static inline
+#endif
+
+/**
+ * unsigned int pjwhash - PJW hash function
+ * @key:    the key address.
+ * @length: the length of key.
+ *
+ * This hash was created by Peter Jay Weinberger (AT&T Bell Labs):
+ * https://en.wikipedia.org/wiki/PJW_hash_function
+ *
+ * Return: the PJW hash.
+ */
+_pjw_inline uint pjwhash(const void* key, uint length)
+{
+   uint hash = 0, high;
+   const u8 *k = key;
+
+   for (uint i = 0; i < length; ++k, ++i) {
+       hash = (hash << ONE_EIGHTH) + *k;
+      high = hash & HIGH_BITS;
+      if (high != 0) {
+          hash ^= high >> THREE_QUARTERS;
+          hash &= ~high;
+      }
+   }
+   return hash;
+}
+
+#endif  /* _PJWHASH_INLINE_H */

c/brlib/include/pjwhash.h

@@ -0,0 +1,30 @@
+/* pjwhash.h - PJW hash function, extern version.
+ *
+ * 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 _PJWHASH_H
+#define _PJWHASH_H
+
+#include "bits.h"
+
+/**
+ * unsigned int pjwhash - PJW hash function
+ * @key:    the key address.
+ * @length: the length of key.
+ *
+ * This hash was created by Peter Jay Weinberger (AT&T Bell Labs):
+ * https://en.wikipedia.org/wiki/PJW_hash_function
+ *
+ * Return: the PJW hash.
+ */
+extern uint  pjwhash (const void* key, uint length);
+
+#endif  /* _PJWHASH_H */

c/brlib/include/plist.h

@@ -0,0 +1,345 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+/* adaptation of kernel's <linux/plist.h>
+ *
+ */
+
+/*
+ * Descending-priority-sorted double-linked list
+ *
+ * (C) 2002-2003 Intel Corp
+ * Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>.
+ *
+ * 2001-2005 (c) MontaVista Software, Inc.
+ * Daniel Walker <dwalker@mvista.com>
+ *
+ * (C) 2005 Thomas Gleixner <tglx@linutronix.de>
+ *
+ * Simplifications of the original code by
+ * Oleg Nesterov <oleg@tv-sign.ru>
+ *
+ * Based on simple lists (include/linux/list.h).
+ *
+ * This is a priority-sorted list of nodes; each node has a
+ * priority from INT_MIN (highest) to INT_MAX (lowest).
+ *
+ * Addition is O(K), removal is O(1), change of priority of a node is
+ * O(K) and K is the number of RT priority levels used in the system.
+ * (1 <= K <= 99)
+ *
+ * This list is really a list of lists:
+ *
+ *  - The tier 1 list is the prio_list, different priority nodes.
+ *
+ *  - The tier 2 list is the node_list, serialized nodes.
+ *
+ * Simple ASCII art explanation:
+ *
+ * pl:prio_list (only for plist_node)
+ * nl:node_list
+ *   HEAD|             NODE(S)
+ *       |
+ *       ||------------------------------------|
+ *       ||->|pl|<->|pl|<--------------->|pl|<-|
+ *       |   |10|   |21|   |21|   |21|   |40|   (prio)
+ *       |   |  |   |  |   |  |   |  |   |  |
+ *       |   |  |   |  |   |  |   |  |   |  |
+ * |->|nl|<->|nl|<->|nl|<->|nl|<->|nl|<->|nl|<-|
+ * |-------------------------------------------|
+ *
+ * The nodes on the prio_list list are sorted by priority to simplify
+ * the insertion of new nodes. There are no nodes with duplicate
+ * priorites on the list.
+ *
+ * The nodes on the node_list are ordered by priority and can contain
+ * entries which have the same priority. Those entries are ordered
+ * FIFO
+ *
+ * Addition means: look for the prio_list node in the prio_list
+ * for the priority of the node and insert it before the node_list
+ * entry of the next prio_list node. If it is the first node of
+ * that priority, add it to the prio_list in the right position and
+ * insert it into the serialized node_list list
+ *
+ * Removal means remove it from the node_list and remove it from
+ * the prio_list if the node_list list_head is non empty. In case
+ * of removal from the prio_list it must be checked whether other
+ * entries of the same priority are on the list or not. If there
+ * is another entry of the same priority then this entry has to
+ * replace the removed entry on the prio_list. If the entry which
+ * is removed is the only entry of this priority then a simple
+ * remove from both list is sufficient.
+ *
+ * INT_MIN is the highest priority, 0 is the medium highest, INT_MAX
+ * is lowest priority.
+ *
+ * No locking is done, up to the caller.
+ */
+#ifndef _LINUX_PLIST_H_
+#define _LINUX_PLIST_H_
+
+#include "container-of.h"
+#include "list.h"
+//#include <types.h>
+
+// #include <asm/bug.h>
+
+struct plist_head {
+    struct list_head node_list;
+};
+
+struct plist_node {
+    int			prio;
+    struct list_head	prio_list;
+    struct list_head	node_list;
+};
+
+/**
+ * PLIST_HEAD_INIT - static struct plist_head initializer
+ * @head:	struct plist_head variable name
+ */
+#define PLIST_HEAD_INIT(head)				\
+    {							\
+	.node_list = LIST_HEAD_INIT((head).node_list)	\
+            }
+
+/**
+ * PLIST_HEAD - declare and init plist_head
+ * @head:	name for struct plist_head variable
+ */
+#define PLIST_HEAD(head)                                \
+    struct plist_head head = PLIST_HEAD_INIT(head)
+
+/**
+ * PLIST_NODE_INIT - static struct plist_node initializer
+ * @node:	struct plist_node variable name
+ * @__prio:	initial node priority
+ */
+#define PLIST_NODE_INIT(node, __prio)                           \
+    {                                                           \
+	.prio  = (__prio),                                      \
+            .prio_list = LIST_HEAD_INIT((node).prio_list),	\
+            .node_list = LIST_HEAD_INIT((node).node_list),	\
+            }
+
+/**
+ * plist_head_init - dynamic struct plist_head initializer
+ * @head:	&struct plist_head pointer
+ */
+static inline void
+plist_head_init(struct plist_head *head)
+{
+    INIT_LIST_HEAD(&head->node_list);
+}
+
+/**
+ * plist_node_init - Dynamic struct plist_node initializer
+ * @node:	&struct plist_node pointer
+ * @prio:	initial node priority
+ */
+static inline void plist_node_init(struct plist_node *node, int prio)
+{
+    node->prio = prio;
+    INIT_LIST_HEAD(&node->prio_list);
+    INIT_LIST_HEAD(&node->node_list);
+}
+
+extern void plist_add(struct plist_node *node, struct plist_head *head);
+extern void plist_del(struct plist_node *node, struct plist_head *head);
+
+extern void plist_requeue(struct plist_node *node, struct plist_head *head);
+
+/**
+ * plist_for_each - iterate over the plist
+ * @pos:	the type * to use as a loop counter
+ * @head:	the head for your list
+ */
+#define plist_for_each(pos, head)                               \
+    list_for_each_entry(pos, &(head)->node_list, node_list)
+
+/**
+ * plist_for_each_reverse - iterate backwards over the plist
+ * @pos:	the type * to use as a loop counter
+ * @head:	the head for your list
+ */
+#define plist_for_each_reverse(pos, head)                       \
+    list_for_each_entry_reverse(pos, &(head)->node_list, node_list)
+
+/**
+ * plist_for_each_continue - continue iteration over the plist
+ * @pos:	the type * to use as a loop cursor
+ * @head:	the head for your list
+ *
+ * Continue to iterate over plist, continuing after the current position.
+ */
+#define plist_for_each_continue(pos, head)                      \
+    list_for_each_entry_continue(pos, &(head)->node_list, node_list)
+
+/**
+ * plist_for_each_continue_reverse - continue iteration over the plist
+ * @pos:	the type * to use as a loop cursor
+ * @head:	the head for your list
+ *
+ * Continue to iterate backwards over plist, continuing after the current
+ * position.
+ */
+#define plist_for_each_continue_reverse(pos, head)              \
+    list_for_each_entry_continue_reverse(pos, &(head)->node_list, node_list)
+
+/**
+ * plist_for_each_safe - iterate safely over a plist of given type
+ * @pos:	the type * to use as a loop counter
+ * @n:	another type * to use as temporary storage
+ * @head:	the head for your list
+ *
+ * Iterate over a plist of given type, safe against removal of list entry.
+ */
+#define plist_for_each_safe(pos, n, head)                       \
+    list_for_each_entry_safe(pos, n, &(head)->node_list, node_list)
+
+/**
+ * plist_for_each_safe_reverse - iterate backwards safely over a plist of given type
+ * @pos:	the type * to use as a loop counter
+ * @n:	another type * to use as temporary storage
+ * @head:	the head for your list
+ *
+ * Iterate backwards over a plist of given type, safe against removal of list entry.
+ */
+#define plist_for_each_safe_reverse(pos, n, head)               \
+    list_for_each_entry_safe_reverse(pos, n, &(head)->node_list, node_list)
+
+/**
+ * plist_for_each_entry	- iterate over list of given type
+ * @pos:	the type * to use as a loop counter
+ * @head:	the head for your list
+ * @mem:	the name of the list_head within the struct
+ */
+#define plist_for_each_entry(pos, head, mem)                    \
+    list_for_each_entry(pos, &(head)->node_list, mem.node_list)
+
+/**
+ * plist_for_each_entry_reverse	- iterate backwards over list of given type
+ * @pos:	the type * to use as a loop counter
+ * @head:	the head for your list
+ * @mem:	the name of the list_head within the struct
+ */
+#define plist_for_each_entry_reverse(pos, head, mem)                    \
+    list_for_each_entry_reverse(pos, &(head)->node_list, mem.node_list)
+
+/**
+ * plist_for_each_entry_continue - continue iteration over list of given type
+ * @pos:	the type * to use as a loop cursor
+ * @head:	the head for your list
+ * @m:		the name of the list_head within the struct
+ *
+ * Continue to iterate over list of given type, continuing after
+ * the current position.
+ */
+#define plist_for_each_entry_continue(pos, head, m)                     \
+    list_for_each_entry_continue(pos, &(head)->node_list, m.node_list)
+
+/**
+ * plist_for_each_entry_safe - iterate safely over list of given type
+ * @pos:	the type * to use as a loop counter
+ * @n:		another type * to use as temporary storage
+ * @head:	the head for your list
+ * @m:		the name of the list_head within the struct
+ *
+ * Iterate over list of given type, safe against removal of list entry.
+ */
+#define plist_for_each_entry_safe(pos, n, head, m)                      \
+    list_for_each_entry_safe(pos, n, &(head)->node_list, m.node_list)
+
+/**
+ * plist_head_empty - return !0 if a plist_head is empty
+ * @head:	&struct plist_head pointer
+ */
+static inline int plist_head_empty(const struct plist_head *head)
+{
+    return list_empty(&head->node_list);
+}
+
+/**
+ * plist_node_empty - return !0 if plist_node is not on a list
+ * @node:	&struct plist_node pointer
+ */
+static inline int plist_node_empty(const struct plist_node *node)
+{
+    return list_empty(&node->node_list);
+}
+
+/* All functions below assume the plist_head is not empty. */
+
+/**
+ * plist_first_entry - get the struct for the first entry
+ * @head:	the &struct plist_head pointer
+ * @type:	the type of the struct this is embedded in
+ * @member:	the name of the list_head within the struct
+ */
+#ifdef CONFIG_DEBUG_PLIST
+# define plist_first_entry(head, type, member)          \
+    ({                                                  \
+	WARN_ON(plist_head_empty(head));                \
+	container_of(plist_first(head), type, member);  \
+    })
+#else
+# define plist_first_entry(head, type, member)          \
+    container_of(plist_first(head), type, member)
+#endif
+
+/**
+ * plist_last_entry - get the struct for the last entry
+ * @head:	the &struct plist_head pointer
+ * @type:	the type of the struct this is embedded in
+ * @member:	the name of the list_head within the struct
+ */
+#ifdef CONFIG_DEBUG_PLIST
+# define plist_last_entry(head, type, member)           \
+    ({                                                  \
+	WARN_ON(plist_head_empty(head));                \
+	container_of(plist_last(head), type, member);   \
+    })
+#else
+# define plist_last_entry(head, type, member)           \
+    container_of(plist_last(head), type, member)
+#endif
+
+/**
+ * plist_next - get the next entry in list
+ * @pos:	the type * to cursor
+ */
+#define plist_next(pos)                         \
+    list_next_entry(pos, node_list)
+
+/**
+ * plist_prev - get the prev entry in list
+ * @pos:	the type * to cursor
+ */
+#define plist_prev(pos)                         \
+    list_prev_entry(pos, node_list)
+
+/**
+ * plist_first - return the first node (and thus, highest priority)
+ * @head:	the &struct plist_head pointer
+ *
+ * Assumes the plist is _not_ empty.
+ */
+static inline struct plist_node *plist_first(const struct plist_head *head)
+{
+    return list_entry(head->node_list.next,
+                      struct plist_node, node_list);
+}
+
+/**
+ * plist_last - return the last node (and thus, lowest priority)
+ * @head:	the &struct plist_head pointer
+ *
+ * Assumes the plist is _not_ empty.
+ */
+static inline struct plist_node *plist_last(const struct plist_head *head)
+{
+    return list_entry(head->node_list.prev,
+                      struct plist_node, node_list);
+}
+
+#endif

c/brlib/include/pool.h

@@ -1,6 +1,6 @@
 /* pool.h - A simple memory pool manager.
  *
- * Copyright (C) 2021 Bruno Raoult ("br")
+ * Copyright (C) 2021-2022 Bruno Raoult ("br")
  * Licensed under the GNU General Public License v3.0 or later.
  * Some rights reserved. See COPYING.
  *
@@ -28,10 +28,10 @@ typedef struct {
 
 typedef struct {
     char name[POOL_NAME_LENGTH];                  /* pool name */
+    size_t eltsize;                               /* object size */
     u32 available;                                /* current available elements */
     u32 allocated;                                /* total objects allocated */
     u32 growsize;                                 /* number of objects per block allocated */
-    size_t eltsize;                               /* object size */
     u32 nblocks;                                  /* number of blocks allocated */
     struct list_head list_available;              /* available nodes */
     struct list_head list_blocks;                 /* allocated blocks */
@@ -48,29 +48,42 @@ void pool_stats(pool_t *pool);
  * @name:    the name to give to the pool.
  * @grow:    the number of elements to add when no more available.
  * @size:    the size of an element in pool.
+ *
+ * The name will be truncated to 16 characters (including the final '\0').
+ *
+ * Return:   The address of the created pool, or NULL if error.
  */
 pool_t *pool_create(const char *name, u32 grow, size_t size);
 
 /**
- * pool_get - get an element from a pool
- * @pool:    the pool address.
+ * pool_get() - Get an element from a pool.
+ * @pool:    The pool address.
+ *
+ * Get an object from the pool.
+ *
+ * Return:   The address of the object, or NULL if error.
  */
 void *pool_get(pool_t *pool);
 
 /**
- * pool_add - add (release) an element to a pool
- * @pool:    the pool address.
- * @elt:     the address of the object to add to the pool.
+ * pool_add() - Add (free) an element to a pool.
+ * @pool:    The pool address.
+ * @elt:     The address of the object to add to the pool.
+ *
+ * The object will be available for further pool_get().
+ *
+ * Return:   The current number of available elements in pool (including
+ *           @elt).
  */
 u32 pool_add(pool_t *pool, void *elt);
 
 /**
- * pool_destroy - destroy a pool.
- * @pool:    the pool address.
+ * pool_destroy() - destroy a pool.
+ * @pool:    The pool address.
  *
  * Attention: All memory is freed, but no check is done whether all pool
- * elements has been released. Referencing any pool object after this call
- * is strongly discouraged.
+ * elements have been released. Referencing any pool object after this call
+ * will likely imply some memory corruption.
  */
 void pool_destroy(pool_t *pool);
 

c/brlib/include/rwonce.h

@@ -24,8 +24,12 @@
 #ifndef __BR_RWONCE_H
 #define __BR_RWONCE_H
 
-/************ originally in <include/linux/compiler_types.h> */
-# define __compiletime_error(message) __attribute__((error(message)))
+/************ originally in <include/linux/compiler_attributes.h> */
+#if __has_attribute(__error__)
+# define __compiletime_error(msg)       __attribute__((__error__(msg)))
+#else
+# define __compiletime_error(msg)
+#endif
 
 /************ originally in <include/linux/compiler_types.h> */
 /*

c/brlib/include/stringhash.h

@@ -0,0 +1,79 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+#ifndef __LINUX_STRINGHASH_H
+#define __LINUX_STRINGHASH_H
+
+#include <linux/compiler.h>	/* For __pure */
+#include <linux/types.h>	/* For u32, u64 */
+#include <linux/hash.h>
+
+/*
+ * Routines for hashing strings of bytes to a 32-bit hash value.
+ *
+ * These hash functions are NOT GUARANTEED STABLE between kernel
+ * versions, architectures, or even repeated boots of the same kernel.
+ * (E.g. they may depend on boot-time hardware detection or be
+ * deliberately randomized.)
+ *
+ * They are also not intended to be secure against collisions caused by
+ * malicious inputs; much slower hash functions are required for that.
+ *
+ * They are optimized for pathname components, meaning short strings.
+ * Even if a majority of files have longer names, the dynamic profile of
+ * pathname components skews short due to short directory names.
+ * (E.g. /usr/lib/libsesquipedalianism.so.3.141.)
+ */
+
+/*
+ * Version 1: one byte at a time.  Example of use:
+ *
+ * unsigned long hash = init_name_hash;
+ * while (*p)
+ *	hash = partial_name_hash(tolower(*p++), hash);
+ * hash = end_name_hash(hash);
+ *
+ * Although this is designed for bytes, fs/hfsplus/unicode.c
+ * abuses it to hash 16-bit values.
+ */
+
+/* Hash courtesy of the R5 hash in reiserfs modulo sign bits */
+#define init_name_hash(salt)		(unsigned long)(salt)
+
+/* partial hash update function. Assume roughly 4 bits per character */
+static inline unsigned long
+partial_name_hash(unsigned long c, unsigned long prevhash)
+{
+	return (prevhash + (c << 4) + (c >> 4)) * 11;
+}
+
+/*
+ * Finally: cut down the number of bits to a int value (and try to avoid
+ * losing bits).  This also has the property (wanted by the dcache)
+ * that the msbits make a good hash table index.
+ */
+static inline unsigned int end_name_hash(unsigned long hash)
+{
+	return hash_long(hash, 32);
+}
+
+/*
+ * Version 2: One word (32 or 64 bits) at a time.
+ * If CONFIG_DCACHE_WORD_ACCESS is defined (meaning <asm/word-at-a-time.h>
+ * exists, which describes major Linux platforms like x86 and ARM), then
+ * this computes a different hash function much faster.
+ *
+ * If not set, this falls back to a wrapper around the preceding.
+ */
+extern unsigned int __pure full_name_hash(const void *salt, const char *, unsigned int);
+
+/*
+ * A hash_len is a u64 with the hash of a string in the low
+ * half and the length in the high half.
+ */
+#define hashlen_hash(hashlen) ((u32)(hashlen))
+#define hashlen_len(hashlen)  ((u32)((hashlen) >> 32))
+#define hashlen_create(hash, len) ((u64)(len)<<32 | (u32)(hash))
+
+/* Return the "hash_len" (hash and length) of a null-terminated string */
+extern u64 __pure hashlen_string(const void *salt, const char *name);
+
+#endif	/* __LINUX_STRINGHASH_H */

c/brlib/include/struct-group.h

@@ -0,0 +1,105 @@
+/* struct-group.h - mirrored structure macros.
+ *
+ * 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>
+ *
+ * Some parts are taken from Linux's kernel <linux/stddef.h> and others, and are :
+ * SPDX-License-Identifier: GPL-2.0
+ *
+ */
+
+#ifndef _STRUCT_GROUP_H
+#define _STRUCT_GROUP_H
+
+/**
+ * __struct_group() - Create a mirrored named and anonyomous struct
+ *
+ * @TAG: The tag name for the named sub-struct (usually empty)
+ * @NAME: The identifier name of the mirrored sub-struct
+ * @ATTRS: Any struct attributes (usually empty)
+ * @MEMBERS: The member declarations for the mirrored structs
+ *
+ * Used to create an anonymous union of two structs with identical layout
+ * and size: one anonymous and one named. The former's members can be used
+ * normally without sub-struct naming, and the latter can be used to
+ * reason about the start, end, and size of the group of struct members.
+ * The named struct can also be explicitly tagged for layer reuse, as well
+ * as both having struct attributes appended.
+ */
+#define __struct_group(TAG, NAME, ATTRS, MEMBERS...) \
+	union { \
+		struct { MEMBERS } ATTRS; \
+		struct TAG { MEMBERS } ATTRS NAME; \
+	}
+
+/**
+ * DECLARE_FLEX_ARRAY() - Declare a flexible array usable in a union
+ *
+ * @TYPE: The type of each flexible array element
+ * @NAME: The name of the flexible array member
+ *
+ * In order to have a flexible array member in a union or alone in a
+ * 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)	\
+	struct { \
+		struct { } __empty_ ## NAME; \
+		TYPE NAME[]; \
+	}
+
+/**
+ * struct_group() - Wrap a set of declarations in a mirrored struct
+ *
+ * @NAME: The identifier name of the mirrored sub-struct
+ * @MEMBERS: The member declarations for the mirrored structs
+ *
+ * Used to create an anonymous union of two structs with identical
+ * layout and size: one anonymous and one named. The former can be
+ * used normally without sub-struct naming, and the latter can be
+ * used to reason about the start, end, and size of the group of
+ * struct members.
+ */
+#define struct_group(NAME, MEMBERS...)	\
+	__struct_group(/* no tag */, NAME, /* no attrs */, MEMBERS)
+
+/**
+ * struct_group_attr() - Create a struct_group() with trailing attributes
+ *
+ * @NAME: The identifier name of the mirrored sub-struct
+ * @ATTRS: Any struct attributes to apply
+ * @MEMBERS: The member declarations for the mirrored structs
+ *
+ * Used to create an anonymous union of two structs with identical
+ * layout and size: one anonymous and one named. The former can be
+ * used normally without sub-struct naming, and the latter can be
+ * used to reason about the start, end, and size of the group of
+ * struct members. Includes structure attributes argument.
+ */
+#define struct_group_attr(NAME, ATTRS, MEMBERS...) \
+	__struct_group(/* no tag */, NAME, ATTRS, MEMBERS)
+
+/**
+ * struct_group_tagged() - Create a struct_group with a reusable tag
+ *
+ * @TAG: The tag name for the named sub-struct
+ * @NAME: The identifier name of the mirrored sub-struct
+ * @MEMBERS: The member declarations for the mirrored structs
+ *
+ * Used to create an anonymous union of two structs with identical
+ * layout and size: one anonymous and one named. The former can be
+ * used normally without sub-struct naming, and the latter can be
+ * used to reason about the start, end, and size of the group of
+ * struct members. Includes struct tag argument for the named copy,
+ * so the specified layout can be reused later.
+ */
+#define struct_group_tagged(TAG, NAME, MEMBERS...) \
+	__struct_group(TAG, NAME, /* no attrs */, MEMBERS)
+
+#endif  /* _STRUCT_GROUP_H */

c/brlib/src/bits.c

@@ -0,0 +1,91 @@
+/* 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/src/debug.c

@@ -0,0 +1,145 @@
+/* debug.c - debug/log management
+ *
+ * Copyright (C) 2021-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>
+ *
+ */
+
+#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 */
+
+/**
+ * debug_level_set() - set debug level.
+ * @_level: debug level (integer).
+ */
+void debug_level_set(int _level)
+{
+    level = _level;
+#   ifdef DEBUG_DEBUG_C
+    log(0, "debug level set to %u\n", level);
+#   endif
+}
+
+/**
+ * debug_level_get() - get debug level.
+ * @return: current level debug (integer).
+ */
+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;
+}
+
+/**
+ * debug() - log function
+ * @lev: log level
+ * @timestamp: boolean, print timestamp if true
+ * @indent: indent level (2 spaces each)
+ * @src: source file/func name (or NULL)
+ * @line: line number
+ */
+void debug(int lev, bool timestamp, int indent, const char *src,
+           int line, const char *fmt, ...)
+{
+    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);
+}
+
+#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

c/brlib/src/hash.c

@@ -0,0 +1,29 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+
+/*  inspired from kernel's <fs/namei.h>
+ */
+#include "hash.h"
+
+/* Return the hash of a string of known length */
+unsigned int hash_string(const void *salt, const char *name, unsigned int len)
+{
+	unsigned long hash = init_name_hash(salt);
+	while (len--)
+		hash = partial_name_hash((unsigned char)*name++, hash);
+	return end_name_hash(hash);
+}
+
+/* Return the "hash_len" (hash and length) of a null-terminated string */
+u64 hashlen_string(const void *salt, const char *name)
+{
+	unsigned long hash = init_name_hash(salt);
+	unsigned long len = 0, c;
+
+	c = (unsigned char)*name;
+	while (c) {
+		len++;
+		hash = partial_name_hash(c, hash);
+		c = (unsigned char)name[len];
+	}
+	return hashlen_create(end_name_hash(hash), len);
+}

c/brlib/src/pjwhash.c

@@ -0,0 +1,20 @@
+/* pjwhash.c - PJW hash function.
+ *
+ * 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>
+ *
+ */
+
+#define _pjw_inline extern
+
+//#include "bits.h"
+//extern unsigned int  pjwhash (const void* key, uint length);
+
+#include "pjwhash.h"
+#include "pjwhash-inline.h"

c/brlib/src/plist.c

@@ -0,0 +1,173 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * adapted from Linux kernel lib/plist.c
+ *
+ * Descending-priority-sorted double-linked list
+ *
+ * (C) 2002-2003 Intel Corp
+ * Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>.
+ *
+ * 2001-2005 (c) MontaVista Software, Inc.
+ * Daniel Walker <dwalker@mvista.com>
+ *
+ * (C) 2005 Thomas Gleixner <tglx@linutronix.de>
+ *
+ * Simplifications of the original code by
+ * Oleg Nesterov <oleg@tv-sign.ru>
+ *
+ * Based on simple lists (include/linux/list.h).
+ *
+ * This file contains the add / del functions which are considered to
+ * be too large to inline. See include/linux/plist.h for further
+ * information.
+ */
+
+#include "plist.h"
+#include "bug.h"
+
+#ifdef DEBUG_PLIST
+
+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,
+         "top: %p, n: %p, p: %p\n"
+         "prev: %p, n: %p, p: %p\n"
+         "next: %p, n: %p, p: %p\n",
+         t, t->next, t->prev,
+         p, p->next, p->prev,
+         n, n->next, n->prev);
+}
+
+static void plist_check_list(struct list_head *top)
+{
+    struct list_head *prev = top, *next = top->next;
+
+    plist_check_prev_next(top, prev, next);
+    while (next != top) {
+        prev = next;
+        next = prev->next;
+        plist_check_prev_next(top, prev, next);
+    }
+}
+
+static void plist_check_head(struct plist_head *head)
+{
+    if (!plist_head_empty(head))
+        plist_check_list(&plist_first(head)->prio_list);
+    plist_check_list(&head->node_list);
+}
+
+#else
+# define plist_check_head(h)	do { } while (0)
+#endif
+
+/**
+ * plist_add - add @node to @head
+ *
+ * @node:	&struct plist_node pointer
+ * @head:	&struct plist_head pointer
+ */
+void plist_add(struct plist_node *node, struct plist_head *head)
+{
+    struct plist_node *first, *iter, *prev = NULL;
+    struct list_head *node_next = &head->node_list;
+
+    plist_check_head(head);
+    WARN_ON(!plist_node_empty(node));
+    WARN_ON(!list_empty(&node->prio_list));
+
+    if (plist_head_empty(head))
+        goto ins_node;
+
+    first = iter = plist_first(head);
+
+    do {
+        if (node->prio < iter->prio) {
+            node_next = &iter->node_list;
+            break;
+        }
+
+        prev = iter;
+        iter = list_entry(iter->prio_list.next,
+                          struct plist_node, prio_list);
+    } while (iter != first);
+
+    if (!prev || prev->prio != node->prio)
+        list_add_tail(&node->prio_list, &iter->prio_list);
+ins_node:
+    list_add_tail(&node->node_list, node_next);
+
+    plist_check_head(head);
+}
+
+/**
+ * plist_del - Remove a @node from plist.
+ *
+ * @node:	&struct plist_node pointer - entry to be removed
+ * @head:	&struct plist_head pointer - list head
+ */
+void plist_del(struct plist_node *node, struct plist_head *head)
+{
+    plist_check_head(head);
+
+    if (!list_empty(&node->prio_list)) {
+        if (node->node_list.next != &head->node_list) {
+            struct plist_node *next;
+
+            next = list_entry(node->node_list.next,
+                              struct plist_node, node_list);
+
+            /* add the next plist_node into prio_list */
+            if (list_empty(&next->prio_list))
+                list_add(&next->prio_list, &node->prio_list);
+        }
+        list_del_init(&node->prio_list);
+    }
+
+    list_del_init(&node->node_list);
+
+    plist_check_head(head);
+}
+
+/**
+ * plist_requeue - Requeue @node at end of same-prio entries.
+ *
+ * This is essentially an optimized plist_del() followed by
+ * plist_add().  It moves an entry already in the plist to
+ * after any other same-priority entries.
+ *
+ * @node:	&struct plist_node pointer - entry to be moved
+ * @head:	&struct plist_head pointer - list head
+ */
+void plist_requeue(struct plist_node *node, struct plist_head *head)
+{
+    struct plist_node *iter;
+    struct list_head *node_next = &head->node_list;
+
+    plist_check_head(head);
+    BUG_ON(plist_head_empty(head));
+    BUG_ON(plist_node_empty(node));
+
+    if (node == plist_last(head))
+        return;
+
+    iter = plist_next(node);
+
+    if (node->prio != iter->prio)
+        return;
+
+    plist_del(node, head);
+
+    plist_for_each_continue(iter, head) {
+        if (node->prio != iter->prio) {
+            node_next = &iter->node_list;
+            break;
+        }
+    }
+    list_add_tail(&node->node_list, node_next);
+
+    plist_check_head(head);
+}

c/brlib/src/pool.c

@@ -1,6 +1,6 @@
 /* pool.c - A simple pool manager.
  *
- * Copyright (C) 2021 Bruno Raoult ("br")
+ * Copyright (C) 2021-2022 Bruno Raoult ("br")
  * Licensed under the GNU General Public License v3.0 or later.
  * Some rights reserved. See COPYING.
  *
@@ -25,18 +25,16 @@
 void pool_stats(pool_t *pool)
 {
     if (pool) {
-#       ifdef DEBUG_POOL
         block_t *block;
 
-        log_f(1, "[%s] pool [%p]: blocks:%u avail:%u alloc:%u grow:%u eltsize:%lu\n",
-              pool->name, (void *)pool, pool->nblocks, pool->available, pool->allocated,
-              pool->growsize, pool->eltsize);
+        log_f(1, "[%s] pool [%p]: blocks:%u avail:%u alloc:%u grow:%u eltsize:%zu\n",
+              pool->name, (void *)pool, pool->nblocks, pool->available,
+              pool->allocated, pool->growsize, pool->eltsize);
         log(5, "\tblocks: ");
         list_for_each_entry(block, &pool->list_blocks, list_blocks) {
             log(5, "%p ", block);
         }
         log(5, "\n");
-#       endif
     }
 }
 
@@ -45,14 +43,13 @@ pool_t *pool_create(const char *name, u32 growsize, size_t eltsize)
     pool_t *pool;
 
 #   ifdef DEBUG_POOL
-    log_f(1, "name=[%s] growsize=%u eltsize=%lu\n",
-          name, growsize, eltsize);
+    log_f(1, "name=[%s] growsize=%u eltsize=%zu\n", name, growsize, eltsize);
 #   endif
     /* we need at least  sizeof(struct list_head) space in pool elements
      */
     if (eltsize < sizeof (struct list_head)) {
 #       ifdef DEBUG_POOL
-        log_f(1, "[%s]: structure size too small (%lu < %lu), adjusting to %lu.\n",
+        log_f(1, "[%s]: structure size too small (%zu < %zu), adjusting to %zu.\n",
               name, eltsize, sizeof(struct list_head), sizeof(struct list_head));
 #       endif
         eltsize = sizeof(struct list_head);
@@ -67,6 +64,8 @@ pool_t *pool_create(const char *name, u32 growsize, size_t eltsize)
         pool->nblocks = 0;
         INIT_LIST_HEAD(&pool->list_available);
         INIT_LIST_HEAD(&pool->list_blocks);
+    } else {
+        errno = ENOMEM;
     }
     return pool;
 }
@@ -74,11 +73,9 @@ pool_t *pool_create(const char *name, u32 growsize, size_t eltsize)
 static u32 _pool_add(pool_t *pool, struct list_head *elt)
 {
 #   ifdef DEBUG_POOL
-    log_f(6, "pool=%p &head=%p elt=%p off1=%lu off2=%lu\n",
-          (void *)pool,
-          (void *)&pool->list_available,
-          (void *)elt,
-          (void *)&pool->list_available-(void *)pool,
+    log_f(6, "pool=%p &head=%p elt=%p off1=%zu off2=%zu\n",
+          (void *)pool, (void *)&pool->list_available, (void *)elt,
+          (void *)&pool->list_available - (void *)pool,
           offsetof(pool_t, list_available));
 #   endif
 
@@ -105,9 +102,6 @@ void *pool_get(pool_t *pool)
         return NULL;
     if (!pool->available) {
         block_t *block = malloc(sizeof(block_t) + pool->eltsize * pool->growsize);
-        void *cur;
-        u32 i;
-
         if (!block) {
 #           ifdef DEBUG_POOL
             log_f(1, "[%s]: failed block allocation\n", pool->name);
@@ -131,16 +125,15 @@ void *pool_get(pool_t *pool)
 #       endif
 
         pool->allocated += pool->growsize;
-        for (i = 0; i < pool->growsize; ++i) {
-            cur = block->data + i * pool->eltsize;
+        for (u32 i = 0; i < pool->growsize; ++i) {
+            void *cur = block->data + i * pool->eltsize;
 #           ifdef DEBUG_POOL
             log_f(7, "alloc=%p cur=%p\n", block, cur);
 #           endif
             _pool_add(pool, (struct list_head *)cur);
         }
-        //pool_stats(pool);
     }
-    /* this is the effective address if the object (and also the
+    /* this is the effective address of the object (and also the
      * pool list_head address)
      */
     return _pool_get(pool);
@@ -157,11 +150,11 @@ void pool_destroy(pool_t *pool)
     log(5, "blocks:");
 #   endif
     list_for_each_entry_safe(block, tmp, &pool->list_blocks, list_blocks) {
-        list_del(&block->list_blocks);
-        free(block);
 #       ifdef DEBUG_POOL
         log(5, " %p", block);
 #       endif
+        list_del(&block->list_blocks);
+        free(block);
     }
 #   ifdef DEBUG_POOL
     log(5, "\n");
@@ -221,5 +214,6 @@ int main(int ac, char**av)
         }
     }
     pool_stats(pool);
+    pool_destroy(pool);
 }
 #endif

c/brlib/todo/asm/unaligned.h

@@ -0,0 +1,155 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+#ifndef __ASM_GENERIC_UNALIGNED_H
+#define __ASM_GENERIC_UNALIGNED_H
+
+/*
+ * This is the most generic implementation of unaligned accesses
+ * and should work almost anywhere.
+ */
+#include <linux/unaligned/packed_struct.h>
+#include <asm/byteorder.h>
+
+#define __get_unaligned_t(type, ptr) ({						\
+	const struct { type x; } __packed *__pptr = (typeof(__pptr))(ptr);	\
+	__pptr->x;								\
+})
+
+#define __put_unaligned_t(type, val, ptr) do {					\
+	struct { type x; } __packed *__pptr = (typeof(__pptr))(ptr);		\
+	__pptr->x = (val);							\
+} while (0)
+
+#define get_unaligned(ptr)	__get_unaligned_t(typeof(*(ptr)), (ptr))
+#define put_unaligned(val, ptr) __put_unaligned_t(typeof(*(ptr)), (val), (ptr))
+
+static inline u16 get_unaligned_le16(const void *p)
+{
+	return le16_to_cpu(__get_unaligned_t(__le16, p));
+}
+
+static inline u32 get_unaligned_le32(const void *p)
+{
+	return le32_to_cpu(__get_unaligned_t(__le32, p));
+}
+
+static inline u64 get_unaligned_le64(const void *p)
+{
+	return le64_to_cpu(__get_unaligned_t(__le64, p));
+}
+
+static inline void put_unaligned_le16(u16 val, void *p)
+{
+	__put_unaligned_t(__le16, cpu_to_le16(val), p);
+}
+
+static inline void put_unaligned_le32(u32 val, void *p)
+{
+	__put_unaligned_t(__le32, cpu_to_le32(val), p);
+}
+
+static inline void put_unaligned_le64(u64 val, void *p)
+{
+	__put_unaligned_t(__le64, cpu_to_le64(val), p);
+}
+
+static inline u16 get_unaligned_be16(const void *p)
+{
+	return be16_to_cpu(__get_unaligned_t(__be16, p));
+}
+
+static inline u32 get_unaligned_be32(const void *p)
+{
+	return be32_to_cpu(__get_unaligned_t(__be32, p));
+}
+
+static inline u64 get_unaligned_be64(const void *p)
+{
+	return be64_to_cpu(__get_unaligned_t(__be64, p));
+}
+
+static inline void put_unaligned_be16(u16 val, void *p)
+{
+	__put_unaligned_t(__be16, cpu_to_be16(val), p);
+}
+
+static inline void put_unaligned_be32(u32 val, void *p)
+{
+	__put_unaligned_t(__be32, cpu_to_be32(val), p);
+}
+
+static inline void put_unaligned_be64(u64 val, void *p)
+{
+	__put_unaligned_t(__be64, cpu_to_be64(val), p);
+}
+
+static inline u32 __get_unaligned_be24(const u8 *p)
+{
+	return p[0] << 16 | p[1] << 8 | p[2];
+}
+
+static inline u32 get_unaligned_be24(const void *p)
+{
+	return __get_unaligned_be24(p);
+}
+
+static inline u32 __get_unaligned_le24(const u8 *p)
+{
+	return p[0] | p[1] << 8 | p[2] << 16;
+}
+
+static inline u32 get_unaligned_le24(const void *p)
+{
+	return __get_unaligned_le24(p);
+}
+
+static inline void __put_unaligned_be24(const u32 val, u8 *p)
+{
+	*p++ = val >> 16;
+	*p++ = val >> 8;
+	*p++ = val;
+}
+
+static inline void put_unaligned_be24(const u32 val, void *p)
+{
+	__put_unaligned_be24(val, p);
+}
+
+static inline void __put_unaligned_le24(const u32 val, u8 *p)
+{
+	*p++ = val;
+	*p++ = val >> 8;
+	*p++ = val >> 16;
+}
+
+static inline void put_unaligned_le24(const u32 val, void *p)
+{
+	__put_unaligned_le24(val, p);
+}
+
+static inline void __put_unaligned_be48(const u64 val, u8 *p)
+{
+	*p++ = val >> 40;
+	*p++ = val >> 32;
+	*p++ = val >> 24;
+	*p++ = val >> 16;
+	*p++ = val >> 8;
+	*p++ = val;
+}
+
+static inline void put_unaligned_be48(const u64 val, void *p)
+{
+	__put_unaligned_be48(val, p);
+}
+
+static inline u64 __get_unaligned_be48(const u8 *p)
+{
+	return (u64)p[0] << 40 | (u64)p[1] << 32 | (u64)p[2] << 24 |
+		p[3] << 16 | p[4] << 8 | p[5];
+}
+
+static inline u64 get_unaligned_be48(const void *p)
+{
+	return __get_unaligned_be48(p);
+}
+
+#endif /* __ASM_GENERIC_UNALIGNED_H */

c/brlib/todo/circ_buf.c

@@ -0,0 +1,61 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+/*
+ * See Documentation/core-api/circular-buffers.rst for more information.
+ */
+
+#include <stdlib.h>
+#include <stdio.h>
+
+#define CIRC_BUF(name, type, bits)               \
+    struct s##name {                             \
+        type buf[1 << (bits)];                   \
+        int head;                                \
+        int tail;                                \
+    } name = {                                   \
+        { 0 },                                   \
+        0,                                       \
+        0 };
+
+struct circ_buf {
+	char *buf;
+	int head;
+	int tail;
+};
+
+/* Return count in buffer.  */
+#define CIRC_CNT(head,tail,size) (((head) - (tail)) & ((size)-1))
+
+/* Return space available, 0..size-1.  We always leave one free char
+   as a completely full buffer has head == tail, which is the same as
+   empty.  */
+#define CIRC_SPACE(head,tail,size) CIRC_CNT((tail),((head)+1),(size))
+
+/* Return count up to the end of the buffer.  Carefully avoid
+   accessing head and tail more than once, so they can change
+   underneath us without returning inconsistent results.  */
+#define CIRC_CNT_TO_END(head,tail,size) \
+	({int end = (size) - (tail); \
+	  int n = ((head) + end) & ((size)-1); \
+	  n < end ? n : end;})
+
+/* Return space available up to the end of the buffer.  */
+#define CIRC_SPACE_TO_END(head,tail,size) \
+	({int end = (size) - 1 - (head); \
+	  int n = (end + (tail)) & ((size)-1); \
+	  n <= end ? n : end+1;})
+
+
+int main(int ac, char **av)
+{
+    int size = 5;
+
+    if (ac > 8) {
+        size = atoi(*(av + 1));
+    }
+    printf("size-%d\n", size);
+
+    CIRC_BUF(foo, int, 5);
+    printf("sizeof(elt)=%lu\n", sizeof(foo.buf[0]));
+    printf("sizeof(buf)=%lu\n", sizeof(foo.buf));
+
+}

c/brlib/todo/circ_buf.h

@@ -0,0 +1,44 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+/*
+ * See Documentation/core-api/circular-buffers.rst for more information.
+ */
+
+#ifndef _LINUX_CIRC_BUF_H
+#define _LINUX_CIRC_BUF_H 1
+
+#define CIRC_BUF(name, type, bits)               \
+    struct s##name {                             \
+        type buf[1 << (bits)];                   \
+        int head;                                \
+        int tail;                                \
+    };
+
+struct circ_buf {
+	char *buf;
+	int head;
+	int tail;
+};
+
+/* Return count in buffer.  */
+#define CIRC_CNT(head,tail,size) (((head) - (tail)) & ((size)-1))
+
+/* Return space available, 0..size-1.  We always leave one free char
+   as a completely full buffer has head == tail, which is the same as
+   empty.  */
+#define CIRC_SPACE(head,tail,size) CIRC_CNT((tail),((head)+1),(size))
+
+/* Return count up to the end of the buffer.  Carefully avoid
+   accessing head and tail more than once, so they can change
+   underneath us without returning inconsistent results.  */
+#define CIRC_CNT_TO_END(head,tail,size) \
+	({int end = (size) - (tail); \
+	  int n = ((head) + end) & ((size)-1); \
+	  n < end ? n : end;})
+
+/* Return space available up to the end of the buffer.  */
+#define CIRC_SPACE_TO_END(head,tail,size) \
+	({int end = (size) - 1 - (head); \
+	  int n = (end + (tail)) & ((size)-1); \
+	  n <= end ? n : end+1;})
+
+#endif /* _LINUX_CIRC_BUF_H  */

c/brlib/todo/hashtest.c

@@ -0,0 +1,8 @@
+#include <stdio.h>
+#include "hash.h"
+
+int main()
+{
+    printf("foo\n");
+    return 1;
+}

c/brlib/todo/list_sort.c

@@ -0,0 +1,253 @@
+// SPDX-License-Identifier: GPL-2.0
+
+/*
+ * Taken from linux kernel: lib/list_sort.c
+ */
+#include "list_sort.h"
+#include "list.h"
+#include "bits.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);
+}

c/brlib/todo/list_sort.h

@@ -0,0 +1,20 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+
+/*
+ * Taken from linux kernel: lib/list_sort.c
+ */
+
+#ifndef _BR_LIST_SORT_H
+#define _BR_LIST_SORT_H
+
+//#include <linux/types.h>
+
+struct list_head;
+
+typedef int __attribute__((nonnull(2,3))) (*list_cmp_func_t)(void *,
+		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 */

c/brlib/todo/packed_struct.h

@@ -0,0 +1,46 @@
+#ifndef _LINUX_UNALIGNED_PACKED_STRUCT_H
+#define _LINUX_UNALIGNED_PACKED_STRUCT_H
+
+#include <linux/types.h>
+
+struct __una_u16 { u16 x; } __packed;
+struct __una_u32 { u32 x; } __packed;
+struct __una_u64 { u64 x; } __packed;
+
+static inline u16 __get_unaligned_cpu16(const void *p)
+{
+	const struct __una_u16 *ptr = (const struct __una_u16 *)p;
+	return ptr->x;
+}
+
+static inline u32 __get_unaligned_cpu32(const void *p)
+{
+	const struct __una_u32 *ptr = (const struct __una_u32 *)p;
+	return ptr->x;
+}
+
+static inline u64 __get_unaligned_cpu64(const void *p)
+{
+	const struct __una_u64 *ptr = (const struct __una_u64 *)p;
+	return ptr->x;
+}
+
+static inline void __put_unaligned_cpu16(u16 val, void *p)
+{
+	struct __una_u16 *ptr = (struct __una_u16 *)p;
+	ptr->x = val;
+}
+
+static inline void __put_unaligned_cpu32(u32 val, void *p)
+{
+	struct __una_u32 *ptr = (struct __una_u32 *)p;
+	ptr->x = val;
+}
+
+static inline void __put_unaligned_cpu64(u64 val, void *p)
+{
+	struct __una_u64 *ptr = (struct __una_u64 *)p;
+	ptr->x = val;
+}
+
+#endif /* _LINUX_UNALIGNED_PACKED_STRUCT_H */

c/brlib/todo/xxhash.c

@@ -0,0 +1,489 @@
+/*
+ * xxHash - Extremely Fast Hash algorithm
+ * Copyright (C) 2012-2016, Yann Collet.
+ *
+ * BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ *   * Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer.
+ *   * Redistributions in binary form must reproduce the above
+ *     copyright notice, this list of conditions and the following disclaimer
+ *     in the documentation and/or other materials provided with the
+ *     distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License version 2 as published by the
+ * Free Software Foundation. This program is dual-licensed; you may select
+ * either version 2 of the GNU General Public License ("GPL") or BSD license
+ * ("BSD").
+ *
+ * You can contact the author at:
+ * - xxHash homepage: https://cyan4973.github.io/xxHash/
+ * - xxHash source repository: https://github.com/Cyan4973/xxHash
+ */
+
+#include <errno.h>
+#include <string.h>
+#include <asm/byteorder.h>
+
+//#include <linux/compiler.h>
+// #include <linux/kernel.h>
+#include "xxhash.h"
+#include "bits.h"
+#include "asm/unaligned.h"
+
+/*-*************************************
+ * Macros
+ **************************************/
+#define xxh_rotl32(x, r) ((x << r) | (x >> (32 - r)))
+#define xxh_rotl64(x, r) ((x << r) | (x >> (64 - r)))
+
+#ifdef __LITTLE_ENDIAN
+# define XXH_CPU_LITTLE_ENDIAN 1
+#else
+# define XXH_CPU_LITTLE_ENDIAN 0
+#endif
+
+/*-*************************************
+ * Constants
+ **************************************/
+static const uint32_t PRIME32_1 = 2654435761U;
+static const uint32_t PRIME32_2 = 2246822519U;
+static const uint32_t PRIME32_3 = 3266489917U;
+static const uint32_t PRIME32_4 =  668265263U;
+static const uint32_t PRIME32_5 =  374761393U;
+
+static const uint64_t PRIME64_1 = 11400714785074694791ULL;
+static const uint64_t PRIME64_2 = 14029467366897019727ULL;
+static const uint64_t PRIME64_3 =  1609587929392839161ULL;
+static const uint64_t PRIME64_4 =  9650029242287828579ULL;
+static const uint64_t PRIME64_5 =  2870177450012600261ULL;
+
+/*-**************************
+ *  Utils
+ ***************************/
+void xxh32_copy_state(struct xxh32_state *dst, const struct xxh32_state *src)
+{
+	memcpy(dst, src, sizeof(*dst));
+}
+
+void xxh64_copy_state(struct xxh64_state *dst, const struct xxh64_state *src)
+{
+	memcpy(dst, src, sizeof(*dst));
+}
+
+/*-***************************
+ * Simple Hash Functions
+ ****************************/
+static uint32_t xxh32_round(uint32_t seed, const uint32_t input)
+{
+	seed += input * PRIME32_2;
+	seed = xxh_rotl32(seed, 13);
+	seed *= PRIME32_1;
+	return seed;
+}
+
+uint32_t xxh32(const void *input, const size_t len, const uint32_t seed)
+{
+	const uint8_t *p = (const uint8_t *)input;
+	const uint8_t *b_end = p + len;
+	uint32_t h32;
+
+	if (len >= 16) {
+		const uint8_t *const limit = b_end - 16;
+		uint32_t v1 = seed + PRIME32_1 + PRIME32_2;
+		uint32_t v2 = seed + PRIME32_2;
+		uint32_t v3 = seed + 0;
+		uint32_t v4 = seed - PRIME32_1;
+
+		do {
+			v1 = xxh32_round(v1, get_unaligned_le32(p));
+			p += 4;
+			v2 = xxh32_round(v2, get_unaligned_le32(p));
+			p += 4;
+			v3 = xxh32_round(v3, get_unaligned_le32(p));
+			p += 4;
+			v4 = xxh32_round(v4, get_unaligned_le32(p));
+			p += 4;
+		} while (p <= limit);
+
+		h32 = xxh_rotl32(v1, 1) + xxh_rotl32(v2, 7) +
+			xxh_rotl32(v3, 12) + xxh_rotl32(v4, 18);
+	} else {
+		h32 = seed + PRIME32_5;
+	}
+
+	h32 += (uint32_t)len;
+
+	while (p + 4 <= b_end) {
+		h32 += get_unaligned_le32(p) * PRIME32_3;
+		h32 = xxh_rotl32(h32, 17) * PRIME32_4;
+		p += 4;
+	}
+
+	while (p < b_end) {
+		h32 += (*p) * PRIME32_5;
+		h32 = xxh_rotl32(h32, 11) * PRIME32_1;
+		p++;
+	}
+
+	h32 ^= h32 >> 15;
+	h32 *= PRIME32_2;
+	h32 ^= h32 >> 13;
+	h32 *= PRIME32_3;
+	h32 ^= h32 >> 16;
+
+	return h32;
+}
+
+static uint64_t xxh64_round(uint64_t acc, const uint64_t input)
+{
+	acc += input * PRIME64_2;
+	acc = xxh_rotl64(acc, 31);
+	acc *= PRIME64_1;
+	return acc;
+}
+
+static uint64_t xxh64_merge_round(uint64_t acc, uint64_t val)
+{
+	val = xxh64_round(0, val);
+	acc ^= val;
+	acc = acc * PRIME64_1 + PRIME64_4;
+	return acc;
+}
+
+uint64_t xxh64(const void *input, const size_t len, const uint64_t seed)
+{
+	const uint8_t *p = (const uint8_t *)input;
+	const uint8_t *const b_end = p + len;
+	uint64_t h64;
+
+	if (len >= 32) {
+		const uint8_t *const limit = b_end - 32;
+		uint64_t v1 = seed + PRIME64_1 + PRIME64_2;
+		uint64_t v2 = seed + PRIME64_2;
+		uint64_t v3 = seed + 0;
+		uint64_t v4 = seed - PRIME64_1;
+
+		do {
+			v1 = xxh64_round(v1, get_unaligned_le64(p));
+			p += 8;
+			v2 = xxh64_round(v2, get_unaligned_le64(p));
+			p += 8;
+			v3 = xxh64_round(v3, get_unaligned_le64(p));
+			p += 8;
+			v4 = xxh64_round(v4, get_unaligned_le64(p));
+			p += 8;
+		} while (p <= limit);
+
+		h64 = xxh_rotl64(v1, 1) + xxh_rotl64(v2, 7) +
+			xxh_rotl64(v3, 12) + xxh_rotl64(v4, 18);
+		h64 = xxh64_merge_round(h64, v1);
+		h64 = xxh64_merge_round(h64, v2);
+		h64 = xxh64_merge_round(h64, v3);
+		h64 = xxh64_merge_round(h64, v4);
+
+	} else {
+		h64  = seed + PRIME64_5;
+	}
+
+	h64 += (uint64_t)len;
+
+	while (p + 8 <= b_end) {
+		const uint64_t k1 = xxh64_round(0, get_unaligned_le64(p));
+
+		h64 ^= k1;
+		h64 = xxh_rotl64(h64, 27) * PRIME64_1 + PRIME64_4;
+		p += 8;
+	}
+
+	if (p + 4 <= b_end) {
+		h64 ^= (uint64_t)(get_unaligned_le32(p)) * PRIME64_1;
+		h64 = xxh_rotl64(h64, 23) * PRIME64_2 + PRIME64_3;
+		p += 4;
+	}
+
+	while (p < b_end) {
+		h64 ^= (*p) * PRIME64_5;
+		h64 = xxh_rotl64(h64, 11) * PRIME64_1;
+		p++;
+	}
+
+	h64 ^= h64 >> 33;
+	h64 *= PRIME64_2;
+	h64 ^= h64 >> 29;
+	h64 *= PRIME64_3;
+	h64 ^= h64 >> 32;
+
+	return h64;
+}
+
+/*-**************************************************
+ * Advanced Hash Functions
+ ***************************************************/
+void xxh32_reset(struct xxh32_state *statePtr, const uint32_t seed)
+{
+	/* use a local state for memcpy() to avoid strict-aliasing warnings */
+	struct xxh32_state state;
+
+	memset(&state, 0, sizeof(state));
+	state.v1 = seed + PRIME32_1 + PRIME32_2;
+	state.v2 = seed + PRIME32_2;
+	state.v3 = seed + 0;
+	state.v4 = seed - PRIME32_1;
+	memcpy(statePtr, &state, sizeof(state));
+}
+
+void xxh64_reset(struct xxh64_state *statePtr, const uint64_t seed)
+{
+	/* use a local state for memcpy() to avoid strict-aliasing warnings */
+	struct xxh64_state state;
+
+	memset(&state, 0, sizeof(state));
+	state.v1 = seed + PRIME64_1 + PRIME64_2;
+	state.v2 = seed + PRIME64_2;
+	state.v3 = seed + 0;
+	state.v4 = seed - PRIME64_1;
+	memcpy(statePtr, &state, sizeof(state));
+}
+
+int xxh32_update(struct xxh32_state *state, const void *input, const size_t len)
+{
+	const uint8_t *p = (const uint8_t *)input;
+	const uint8_t *const b_end = p + len;
+
+	if (input == NULL)
+		return -EINVAL;
+
+	state->total_len_32 += (uint32_t)len;
+	state->large_len |= (len >= 16) | (state->total_len_32 >= 16);
+
+	if (state->memsize + len < 16) { /* fill in tmp buffer */
+		memcpy((uint8_t *)(state->mem32) + state->memsize, input, len);
+		state->memsize += (uint32_t)len;
+		return 0;
+	}
+
+	if (state->memsize) { /* some data left from previous update */
+		const uint32_t *p32 = state->mem32;
+
+		memcpy((uint8_t *)(state->mem32) + state->memsize, input,
+			16 - state->memsize);
+
+		state->v1 = xxh32_round(state->v1, get_unaligned_le32(p32));
+		p32++;
+		state->v2 = xxh32_round(state->v2, get_unaligned_le32(p32));
+		p32++;
+		state->v3 = xxh32_round(state->v3, get_unaligned_le32(p32));
+		p32++;
+		state->v4 = xxh32_round(state->v4, get_unaligned_le32(p32));
+		p32++;
+
+		p += 16-state->memsize;
+		state->memsize = 0;
+	}
+
+	if (p <= b_end - 16) {
+		const uint8_t *const limit = b_end - 16;
+		uint32_t v1 = state->v1;
+		uint32_t v2 = state->v2;
+		uint32_t v3 = state->v3;
+		uint32_t v4 = state->v4;
+
+		do {
+			v1 = xxh32_round(v1, get_unaligned_le32(p));
+			p += 4;
+			v2 = xxh32_round(v2, get_unaligned_le32(p));
+			p += 4;
+			v3 = xxh32_round(v3, get_unaligned_le32(p));
+			p += 4;
+			v4 = xxh32_round(v4, get_unaligned_le32(p));
+			p += 4;
+		} while (p <= limit);
+
+		state->v1 = v1;
+		state->v2 = v2;
+		state->v3 = v3;
+		state->v4 = v4;
+	}
+
+	if (p < b_end) {
+		memcpy(state->mem32, p, (size_t)(b_end-p));
+		state->memsize = (uint32_t)(b_end-p);
+	}
+
+	return 0;
+}
+
+uint32_t xxh32_digest(const struct xxh32_state *state)
+{
+	const uint8_t *p = (const uint8_t *)state->mem32;
+	const uint8_t *const b_end = (const uint8_t *)(state->mem32) +
+		state->memsize;
+	uint32_t h32;
+
+	if (state->large_len) {
+		h32 = xxh_rotl32(state->v1, 1) + xxh_rotl32(state->v2, 7) +
+			xxh_rotl32(state->v3, 12) + xxh_rotl32(state->v4, 18);
+	} else {
+		h32 = state->v3 /* == seed */ + PRIME32_5;
+	}
+
+	h32 += state->total_len_32;
+
+	while (p + 4 <= b_end) {
+		h32 += get_unaligned_le32(p) * PRIME32_3;
+		h32 = xxh_rotl32(h32, 17) * PRIME32_4;
+		p += 4;
+	}
+
+	while (p < b_end) {
+		h32 += (*p) * PRIME32_5;
+		h32 = xxh_rotl32(h32, 11) * PRIME32_1;
+		p++;
+	}
+
+	h32 ^= h32 >> 15;
+	h32 *= PRIME32_2;
+	h32 ^= h32 >> 13;
+	h32 *= PRIME32_3;
+	h32 ^= h32 >> 16;
+
+	return h32;
+}
+
+int xxh64_update(struct xxh64_state *state, const void *input, const size_t len)
+{
+	const uint8_t *p = (const uint8_t *)input;
+	const uint8_t *const b_end = p + len;
+
+	if (input == NULL)
+		return -EINVAL;
+
+	state->total_len += len;
+
+	if (state->memsize + len < 32) { /* fill in tmp buffer */
+		memcpy(((uint8_t *)state->mem64) + state->memsize, input, len);
+		state->memsize += (uint32_t)len;
+		return 0;
+	}
+
+	if (state->memsize) { /* tmp buffer is full */
+		uint64_t *p64 = state->mem64;
+
+		memcpy(((uint8_t *)p64) + state->memsize, input,
+			32 - state->memsize);
+
+		state->v1 = xxh64_round(state->v1, get_unaligned_le64(p64));
+		p64++;
+		state->v2 = xxh64_round(state->v2, get_unaligned_le64(p64));
+		p64++;
+		state->v3 = xxh64_round(state->v3, get_unaligned_le64(p64));
+		p64++;
+		state->v4 = xxh64_round(state->v4, get_unaligned_le64(p64));
+
+		p += 32 - state->memsize;
+		state->memsize = 0;
+	}
+
+	if (p + 32 <= b_end) {
+		const uint8_t *const limit = b_end - 32;
+		uint64_t v1 = state->v1;
+		uint64_t v2 = state->v2;
+		uint64_t v3 = state->v3;
+		uint64_t v4 = state->v4;
+
+		do {
+			v1 = xxh64_round(v1, get_unaligned_le64(p));
+			p += 8;
+			v2 = xxh64_round(v2, get_unaligned_le64(p));
+			p += 8;
+			v3 = xxh64_round(v3, get_unaligned_le64(p));
+			p += 8;
+			v4 = xxh64_round(v4, get_unaligned_le64(p));
+			p += 8;
+		} while (p <= limit);
+
+		state->v1 = v1;
+		state->v2 = v2;
+		state->v3 = v3;
+		state->v4 = v4;
+	}
+
+	if (p < b_end) {
+		memcpy(state->mem64, p, (size_t)(b_end-p));
+		state->memsize = (uint32_t)(b_end - p);
+	}
+
+	return 0;
+}
+
+uint64_t xxh64_digest(const struct xxh64_state *state)
+{
+	const uint8_t *p = (const uint8_t *)state->mem64;
+	const uint8_t *const b_end = (const uint8_t *)state->mem64 +
+		state->memsize;
+	uint64_t h64;
+
+	if (state->total_len >= 32) {
+		const uint64_t v1 = state->v1;
+		const uint64_t v2 = state->v2;
+		const uint64_t v3 = state->v3;
+		const uint64_t v4 = state->v4;
+
+		h64 = xxh_rotl64(v1, 1) + xxh_rotl64(v2, 7) +
+			xxh_rotl64(v3, 12) + xxh_rotl64(v4, 18);
+		h64 = xxh64_merge_round(h64, v1);
+		h64 = xxh64_merge_round(h64, v2);
+		h64 = xxh64_merge_round(h64, v3);
+		h64 = xxh64_merge_round(h64, v4);
+	} else {
+		h64  = state->v3 + PRIME64_5;
+	}
+
+	h64 += (uint64_t)state->total_len;
+
+	while (p + 8 <= b_end) {
+		const uint64_t k1 = xxh64_round(0, get_unaligned_le64(p));
+
+		h64 ^= k1;
+		h64 = xxh_rotl64(h64, 27) * PRIME64_1 + PRIME64_4;
+		p += 8;
+	}
+
+	if (p + 4 <= b_end) {
+		h64 ^= (uint64_t)(get_unaligned_le32(p)) * PRIME64_1;
+		h64 = xxh_rotl64(h64, 23) * PRIME64_2 + PRIME64_3;
+		p += 4;
+	}
+
+	while (p < b_end) {
+		h64 ^= (*p) * PRIME64_5;
+		h64 = xxh_rotl64(h64, 11) * PRIME64_1;
+		p++;
+	}
+
+	h64 ^= h64 >> 33;
+	h64 *= PRIME64_2;
+	h64 ^= h64 >> 29;
+	h64 *= PRIME64_3;
+	h64 ^= h64 >> 32;
+
+	return h64;
+}

c/brlib/todo/xxhash.h

@@ -0,0 +1,259 @@
+/*
+ * xxHash - Extremely Fast Hash algorithm
+ * Copyright (C) 2012-2016, Yann Collet.
+ *
+ * BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ *   * Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer.
+ *   * Redistributions in binary form must reproduce the above
+ *     copyright notice, this list of conditions and the following disclaimer
+ *     in the documentation and/or other materials provided with the
+ *     distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License version 2 as published by the
+ * Free Software Foundation. This program is dual-licensed; you may select
+ * either version 2 of the GNU General Public License ("GPL") or BSD license
+ * ("BSD").
+ *
+ * You can contact the author at:
+ * - xxHash homepage: https://cyan4973.github.io/xxHash/
+ * - xxHash source repository: https://github.com/Cyan4973/xxHash
+ */
+
+/*
+ * Notice extracted from xxHash homepage:
+ *
+ * xxHash is an extremely fast Hash algorithm, running at RAM speed limits.
+ * It also successfully passes all tests from the SMHasher suite.
+ *
+ * Comparison (single thread, Windows Seven 32 bits, using SMHasher on a Core 2
+ * Duo @3GHz)
+ *
+ * Name            Speed       Q.Score   Author
+ * xxHash          5.4 GB/s     10
+ * CrapWow         3.2 GB/s      2       Andrew
+ * MumurHash 3a    2.7 GB/s     10       Austin Appleby
+ * SpookyHash      2.0 GB/s     10       Bob Jenkins
+ * SBox            1.4 GB/s      9       Bret Mulvey
+ * Lookup3         1.2 GB/s      9       Bob Jenkins
+ * SuperFastHash   1.2 GB/s      1       Paul Hsieh
+ * CityHash64      1.05 GB/s    10       Pike & Alakuijala
+ * FNV             0.55 GB/s     5       Fowler, Noll, Vo
+ * CRC32           0.43 GB/s     9
+ * MD5-32          0.33 GB/s    10       Ronald L. Rivest
+ * SHA1-32         0.28 GB/s    10
+ *
+ * Q.Score is a measure of quality of the hash function.
+ * It depends on successfully passing SMHasher test set.
+ * 10 is a perfect score.
+ *
+ * A 64-bits version, named xxh64 offers much better speed,
+ * but for 64-bits applications only.
+ * Name     Speed on 64 bits    Speed on 32 bits
+ * xxh64       13.8 GB/s            1.9 GB/s
+ * xxh32        6.8 GB/s            6.0 GB/s
+ */
+
+#ifndef XXHASH_H
+#define XXHASH_H
+
+#include <linux/types.h>
+
+/*-****************************
+ * Simple Hash Functions
+ *****************************/
+
+/**
+ * xxh32() - calculate the 32-bit hash of the input with a given seed.
+ *
+ * @input:  The data to hash.
+ * @length: The length of the data to hash.
+ * @seed:   The seed can be used to alter the result predictably.
+ *
+ * Speed on Core 2 Duo @ 3 GHz (single thread, SMHasher benchmark) : 5.4 GB/s
+ *
+ * Return:  The 32-bit hash of the data.
+ */
+uint32_t xxh32(const void *input, size_t length, uint32_t seed);
+
+/**
+ * xxh64() - calculate the 64-bit hash of the input with a given seed.
+ *
+ * @input:  The data to hash.
+ * @length: The length of the data to hash.
+ * @seed:   The seed can be used to alter the result predictably.
+ *
+ * This function runs 2x faster on 64-bit systems, but slower on 32-bit systems.
+ *
+ * Return:  The 64-bit hash of the data.
+ */
+uint64_t xxh64(const void *input, size_t length, uint64_t seed);
+
+/**
+ * xxhash() - calculate wordsize hash of the input with a given seed
+ * @input:  The data to hash.
+ * @length: The length of the data to hash.
+ * @seed:   The seed can be used to alter the result predictably.
+ *
+ * If the hash does not need to be comparable between machines with
+ * different word sizes, this function will call whichever of xxh32()
+ * or xxh64() is faster.
+ *
+ * Return:  wordsize hash of the data.
+ */
+
+static inline unsigned long xxhash(const void *input, size_t length,
+				   uint64_t seed)
+{
+#if BITS_PER_LONG == 64
+       return xxh64(input, length, seed);
+#else
+       return xxh32(input, length, seed);
+#endif
+}
+
+/*-****************************
+ * Streaming Hash Functions
+ *****************************/
+
+/*
+ * These definitions are only meant to allow allocation of XXH state
+ * statically, on stack, or in a struct for example.
+ * Do not use members directly.
+ */
+
+/**
+ * struct xxh32_state - private xxh32 state, do not use members directly
+ */
+struct xxh32_state {
+	uint32_t total_len_32;
+	uint32_t large_len;
+	uint32_t v1;
+	uint32_t v2;
+	uint32_t v3;
+	uint32_t v4;
+	uint32_t mem32[4];
+	uint32_t memsize;
+};
+
+/**
+ * struct xxh32_state - private xxh64 state, do not use members directly
+ */
+struct xxh64_state {
+	uint64_t total_len;
+	uint64_t v1;
+	uint64_t v2;
+	uint64_t v3;
+	uint64_t v4;
+	uint64_t mem64[4];
+	uint32_t memsize;
+};
+
+/**
+ * xxh32_reset() - reset the xxh32 state to start a new hashing operation
+ *
+ * @state: The xxh32 state to reset.
+ * @seed:  Initialize the hash state with this seed.
+ *
+ * Call this function on any xxh32_state to prepare for a new hashing operation.
+ */
+void xxh32_reset(struct xxh32_state *state, uint32_t seed);
+
+/**
+ * xxh32_update() - hash the data given and update the xxh32 state
+ *
+ * @state:  The xxh32 state to update.
+ * @input:  The data to hash.
+ * @length: The length of the data to hash.
+ *
+ * After calling xxh32_reset() call xxh32_update() as many times as necessary.
+ *
+ * Return:  Zero on success, otherwise an error code.
+ */
+int xxh32_update(struct xxh32_state *state, const void *input, size_t length);
+
+/**
+ * xxh32_digest() - produce the current xxh32 hash
+ *
+ * @state: Produce the current xxh32 hash of this state.
+ *
+ * A hash value can be produced at any time. It is still possible to continue
+ * inserting input into the hash state after a call to xxh32_digest(), and
+ * generate new hashes later on, by calling xxh32_digest() again.
+ *
+ * Return: The xxh32 hash stored in the state.
+ */
+uint32_t xxh32_digest(const struct xxh32_state *state);
+
+/**
+ * xxh64_reset() - reset the xxh64 state to start a new hashing operation
+ *
+ * @state: The xxh64 state to reset.
+ * @seed:  Initialize the hash state with this seed.
+ */
+void xxh64_reset(struct xxh64_state *state, uint64_t seed);
+
+/**
+ * xxh64_update() - hash the data given and update the xxh64 state
+ * @state:  The xxh64 state to update.
+ * @input:  The data to hash.
+ * @length: The length of the data to hash.
+ *
+ * After calling xxh64_reset() call xxh64_update() as many times as necessary.
+ *
+ * Return:  Zero on success, otherwise an error code.
+ */
+int xxh64_update(struct xxh64_state *state, const void *input, size_t length);
+
+/**
+ * xxh64_digest() - produce the current xxh64 hash
+ *
+ * @state: Produce the current xxh64 hash of this state.
+ *
+ * A hash value can be produced at any time. It is still possible to continue
+ * inserting input into the hash state after a call to xxh64_digest(), and
+ * generate new hashes later on, by calling xxh64_digest() again.
+ *
+ * Return: The xxh64 hash stored in the state.
+ */
+uint64_t xxh64_digest(const struct xxh64_state *state);
+
+/*-**************************
+ * Utils
+ ***************************/
+
+/**
+ * xxh32_copy_state() - copy the source state into the destination state
+ *
+ * @src: The source xxh32 state.
+ * @dst: The destination xxh32 state.
+ */
+void xxh32_copy_state(struct xxh32_state *dst, const struct xxh32_state *src);
+
+/**
+ * xxh64_copy_state() - copy the source state into the destination state
+ *
+ * @src: The source xxh64 state.
+ * @dst: The destination xxh64 state.
+ */
+void xxh64_copy_state(struct xxh64_state *dst, const struct xxh64_state *src);
+
+#endif /* XXHASH_H */

c/debug.c

@@ -1,111 +0,0 @@
-/* debug.c - debug/log management
- *
- * Copyright (C) 2021 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"
-
-#define NANOSEC  1000000000                       /* nano sec in sec */
-#define MILLISEC 1000000                          /* milli sec in sec */
-
-static s64 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 s64 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) {
-        s64 diff = timer_elapsed();
-        printf("%ld.%03ld ", diff/NANOSEC, (diff/1000000)%1000);
-        printf("%010ld ", 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

c/debug.h

@@ -1,84 +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);
-void _printf debug(u32 level, bool timestamp,
-                   u32 indent, const char *src,
-                   u32 line, const char *, ...);
-#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, const char *, ...) {}
-#endif  /* DEBUG_DEBUG */
-#undef _unused
-#undef _printf
-
-/* format: only printf
- */
-#define log(level, fmt, args...) \
-    debug((level), false, 0, NULL, 0, fmt, ##args)
-
-/* format : indent, no func name, no timestamp
- * >>>>val=2
- */
-#define log_i(level, fmt, args...) \
-    debug((level), false, (level), NULL, 0, fmt, ##args)
-
-/* format : func name, no indent, no timestamp
- * [foo] val=2
- */
-#define log_f(level, fmt, args...) \
-    debug((level), false, 0, __func__, 0, fmt, ##args)
-
-/* format : func name, no indent, no timestamp
- * >>>> [foo:15] val=2
- */
-#define log_if(level, fmt, args...) \
-    debug((level), false, (level), __func__, __LINE__, fmt, ##args)
-
-/* format : func name, indent, timestamp
- * >>>>foo:15 val=2
- */
-#define log_it(level, fmt, args...) \
-    debug((level), true, (level), __func__, __LINE__, fmt, ##args)
-
-/* format: file name, no indent, no timestamp
- * foo:15 val=2
- *
- * #define log_f(level, fmt, args...)                            \
- *   debug((level), false, 0, __FILE__, __LINE__, fmt, args)
- */
-
-#else
-#define log(level, fmt, args...)
-#define log_i(...)
-#define log_f(...)
-#define log_if(...)
-#define log_it(...)
-#define log_f(...)
-
-#endif  /* DEBUG_H */

config/home/.bashrc.br

@@ -0,0 +1,258 @@
+#!/usr/bin/env bash
+#
+# ~/.bashrc.br - user specific initialization
+#
+# (C) Bruno Raoult ("br"), 2001-2023
+# 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: to be invoked from .bashrc.
+# i.e., add at the end of .bashrc:
+# [ -f "$HOME/.bashrc.$USER" ] && . "$HOME/.bashrc.$USER"
+
+# _var_del() - remove an element from a colon-separated list.
+# $1: name (reference) of a colon separated list
+# $2: element to remove (string)
+#
+# _var_del() removes every occurrence of $2, if there are more than 1,
+# and leaves $1 unchanged if $2 is not present.
+#
+# Example:
+# With VAR's value being "foo:bar:quax:bar". Using "_var_del VAR bar" will
+# leave VAR with the value "foo:quax".
+_var_del() {
+    local -n _p_del=$1
+    local _l=":$_p_del:"
+
+    while [[ $_l =~ :$2: ]]; do
+          _l=${_l//:$2:/:}
+    done
+    _l=${_l%:}
+    _l=${_l#:}
+    _p_del="$_l"
+}
+
+# _var_prepend() - prepend element to colon-separated variable.
+# $1: variable name (reference)
+# $2: element to add (string)
+#
+# Any occurrence of $2 in $1 is first removed, then $2 is added at $1 beginning.
+#
+# Example:
+# With VAR's value being "foo:bar:quax:bar". Using "_var_prepend VAR bar"
+# will leave VAR with the value "bar:foo:quax".
+_var_prepend() {
+    local -n _p_prepend=$1
+
+    _var_del _p_prepend "$2"
+    [[ -z $_p_prepend ]] && _p_prepend="$2" && return
+    _p_prepend="$2:$_p_prepend"
+}
+
+# _var_append() - append element to colon-separated variable.
+# $1: variable name (reference)
+# $2: element to add (string)
+#
+# Any occurrence of $2 in $1 is first removed, then $2 is added at $1 end.
+#
+# Example:
+# With VAR's value being "foo:bar:quax:bar". Using "_var_append VAR bar"
+# will leave VAR with the value "foo:quax:bar".
+_var_append() {
+    local -n _p_append=$1
+
+    _var_del _p_append "$2"
+    [[ -z $_p_append ]] && _p_append="$2" && return
+    _p_append="$_p_append:$2"
+}
+
+# adjust PATH. Below paths will be added at beginning.
+_lpath=("$HOME/bin/$(uname -s)-$(uname -m)"
+        "$HOME/bin"
+        #"$HOME/.cargo/bin"
+        "/usr/local/bin")
+
+# loop array in reverse order. Note: We do not test for path existence and add it
+# unconditionally, to avoid automounter interference.
+for (( _i = ${#_lpath[@]} - 1; _i >= 0; --_i )); do
+    _var_prepend PATH "${_lpath[_i]}"
+done
+unset _lpath
+
+# why is it in default Ubuntu path ?
+_var_del PATH /snap/bin
+
+# enable core file
+ulimit -Sc 102400                                 # in 1024 bytes, 100Mb
+
+# ... and set PAGER to less (for man(1) and others)
+if hash less 2>/dev/null; then
+    export PAGER=less
+    # do not clear screen after "less", exit immediately if one page only
+    export LESS="-XFB"
+    # ... and just alias more... to less ;-)
+    alias more=less
+fi
+
+# no output split for dc and bc / make bc silent
+export DC_LINE_LENGTH=0
+export BC_LINE_LENGTH=0
+export BC_ENV_ARGS=--quiet
+
+# both ubuntu and debian assume we want colors if TERM contains "color"
+# this is surely not true, as TERM is often forced by terminal emulator
+# shellcheck disable=SC2154
+PS1='${debian_chroot:+($debian_chroot)}\u@\h:\w\$ '
+case "$TERM" in
+    xterm*|rxvt*)
+        PS1="\[\e]0;${debian_chroot:+($debian_chroot)}\u@\h: \w\a\]$PS1"
+        ;;
+    *)
+        ;;
+esac
+
+# trim prompt path
+export PROMPT_DIRTRIM=3
+
+# find a suitable editor
+e() {
+    $VISUAL "$@"
+}
+export -f e
+if hash emacs 2>/dev/null; then
+    # uncomment below to use full emacs
+    #export EDITOR=emacs
+    # ... OR: uncomment below to use emacsclient
+    #export ALTERNATE_EDITOR="/usr/bin/emacs"
+    #export EDITOR="emacs.sh"
+    #alias emacs="emacs.sh"
+    export ALTERNATE_EDITOR=""
+    export VISUAL="emacsclient -c"
+    alias emacs="emacsclient -c"
+    #alias crontab="VISUAL=emacsclient crontab -e"
+    #alias crontab="emacs-crontab.sh"
+else
+    # emacs clones, then vim/vi, then... whatever left.
+    _VISUALS=(zile jed mg e3em vim vi nano ed)
+
+    for e in "${_VISUALS[@]}"; do
+        if hash "$e" 2>/dev/null; then
+            export VISUAL="$e"
+            break
+        fi
+    done
+    unset _VISUALS
+fi
+export EDITOR=$VISUAL
+
+# append to the history file, don't overwrite it
+shopt -s histappend
+# write history after each command
+export PROMPT_COMMAND="history -a"
+# Add timestamp in history
+export HISTTIMEFORMAT="%d/%m %H:%M "
+# ignore history dups, delete all previous dups
+export HISTCONTROL="ignorespace:ignoredups:erasedups"
+# ignore these in history
+export HISTIGNORE="history *:h:hl:hll:hlll"
+# history size
+HISTSIZE=5000
+HISTFILESIZE=5000
+
+# remove new stupid Debian "ls" quoting, and colors...
+# Many complains, one of them:
+#    https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=813164#226
+export QUOTING_STYLE=literal
+[[ -v BASH_ALIASES[ls] ]] && unalias ls
+
+# avoid these stupid systemd defaults (horizontal scroll and pager)
+alias systemctl="systemctl --no-pager --full"
+
+# aliases for ls and history
+alias l='ls -F'
+alias ls='ls -F'
+alias l1='ls -1F'
+alias la='ls -AF'
+alias ll='ls -lF'
+alias lla='ls -lAF'
+alias ldl='ls -l | grep ^d'
+[[ -v BASH_ALIASES[lrt] ]] && unalias lrt
+lrt() {
+    local -i _l=20
+    if (( $# > 0 )) && [[ $1 =~ [[:digit:]]+ ]]; then
+        _l="$1"
+        shift
+    fi
+    # shellcheck disable=2012
+    ls -lrt "${1:-.}" | tail -"$_l"
+}
+[[ -v BASH_ALIASES[lart] ]] && unalias lart
+lart() {
+    local -i _l=20
+    if (( $# > 0 )) && [[ $1 =~ [[:digit:]]+ ]]; then
+        _l="$1"
+        shift
+    fi
+    # shellcheck disable=2012
+    ls -laFrt "${1:-.}" | tail -"$_l"
+}
+
+alias h="history   10"                            # short
+alias hl="history  25"                            # long
+alias hll="history 100"                           # very long
+alias hlll="history"                              # all history
+
+# user temp directory
+export USERTMP=~/tmp
+
+# misc aliases
+alias fuck='sudo $(history -p \!\!)'
+alias diff='diff -u'
+# fdiff() - compare two files with same name
+# parameters:
+# $1: first file
+# $2: second file directory
+#
+# fdiff will compare (diff) $1 with a file of basename $1 in $2 directory.
+# Examples:
+# % fdiff .bashrc ~                # compare .bashrc with ~/.bashrc
+# % fdiff /tmp/.bashrc /home/br/   # compare /tmp/.bashrc with /home/br/.bashrc
+
+fdiff () {
+    local file1="$1"                              # file to compare
+    local file2="$2/${file1##*/}"                 # file2 with path
+
+    diff "$file1" "$file2"
+}
+
+# I am used to rehash...
+# rehash - manage bash's remembered commands paths
+# $1...: Only forget those commands
+rehash() {
+    if (($#)); then
+        hash -d "$@"
+    else
+        hash -r
+    fi
+}
+
+# french-> english and english->french translation
+alias trans="trans.sh"
+alias rtrans="trans.sh -fen -tfr"
+
+# host specific initialization
+# shellcheck disable=SC1090
+[ -f "$HOME/.bashrc.$USER.$(hostname)" ] && . "$HOME/.bashrc.$USER.$(hostname)"
+
+# Indent style for emacs
+# Local Variables:
+# mode: shell-script
+# sh-basic-offset: 4
+# sh-indentation: 4
+# indent-tabs-mode: nil
+# End:

config/home/.bashrc.br.lorien

@@ -0,0 +1,50 @@
+#!/usr/bin/env bash
+#
+# ~/.bashrc.br.lorien - host specific initialization
+#
+# (C) Bruno Raoult ("br"), 2001-2023
+# 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: to be invoked from .bashrc.$USER
+# i.e., add at the end of .bashrc.$USER:
+# [ -f "$HOME/.bashrc.$USER.$(hostname)" ] && . "$HOME/.bashrc.$USER.$(hostname)"
+
+# look for a pdf viewer
+hash atril 2> /dev/null && alias acroread=atril
+
+# mysql aliases. Will match any "[client-XXX]" lines in ~/.my.cnf
+# and generate "myXXX" aliases.
+if [[ -r ~/.my.cnf ]]; then
+    mapfile -t MYSQL_ARRAY < ~/.my.cnf
+
+    for line in "${MYSQL_ARRAY[@]}"; do
+        if [[ $line =~ ^\[client-(.+)\]$ ]]; then
+            SUFFIX="${BASH_REMATCH[1]}"
+            # shellcheck disable=SC2139,SC2140
+            alias my"$SUFFIX"="mysql --defaults-group-suffix=-$SUFFIX"
+        fi
+    done
+fi
+
+# shortcuts to commonly used directories
+# alias dev="cd ~/dev/www/cf.bodi"                     # Clash of Clans
+alias eud="cd ~/dev/eudyptula; . ./bin/ENV.sh"         # Eudyptula
+alias aoc="cd ~/dev/advent-of-code/2022/; . ../env.sh" # Advent of Code
+alias wchess="cd ~/dev/www/com.raoult/devs/chess"      # raoult.com chess
+alias chess="cd ~/dev/brchess; . env.sh"               # brchess
+alias tools="cd ~/dev/tools"                           # tools
+alias brlib="cd ~/dev/tools/c/brlib"                   # brlib dir/repo
+
+# Indent style for emacs
+# Local Variables:
+# mode: shell-script
+# sh-basic-offset: 4
+# sh-indentation: 4
+# indent-tabs-mode: nil
+# End:

config/home/.emacs.d/eowyn.el

@@ -0,0 +1,58 @@
+;; ~/.emacs.d/lorien.el
+;;
+;; emacs configuration - this file will be loaded only when emacs runs on lorien.
+;;
+;; br, 2010-2019
+
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; pre-load often-visited files
+
+;; avoids calling this twice
+(when (not (boundp 'my/eowyn-loaded))
+  ;; I put mainfile (current project) in variable.
+  (setq
+    my/mainfile "~/dev/advent-of-code/2019/RESULTS.txt"
+    my/eowyn-loaded t)
+
+  ;; mysql CoC connection
+  (defun my/connect-coc ()
+    (interactive)
+    (my/sql-connect-preset 'coc))
+
+  ;; shortcuts for tramp
+  ;; (my/add-to-list
+  ;;   'directory-abbrev-alist
+  ;;   '(("^/root" . "/su:/")
+  ;;      ("^/rebel" . "/ssh:arwen:www/cf.bodi/rebels21/")
+  ;;      ("^/strat" . "/ssh:arwen:www/cf.bodi/strat-dom/")))
+
+  (defconst my/loaded-files-at-startup
+    (list
+      my/mainfile
+      user-init-file
+      (concat user-emacs-directory "emacs-cheatsheet.org"))
+      ;; (concat (getenv "HOME") "/dev/g910-gkey-macro-support/lib/data_mappers/char_uinput_mapper.py")
+      ;; (concat (getenv "HOME") "/Documents/org/boot-disk.org"))
+    "personal files always loaded at startup (no visible window).")
+
+  (let ((num 1))
+    (dolist
+      (filename my/loaded-files-at-startup)
+      (if (file-exists-p filename)
+        (progn
+          ;; set variable "my/buffer-1" to buffer returned by find-file
+          (set
+            (intern (concat "my/buffer-" (number-to-string num)))
+            (find-file-noselect filename nil nil nil))
+          (message "file: [%s] loaded." filename))
+        (message "cannot load file: [%s]." filename))
+        (cl-incf num)))
+
+  ;; set windows for current work buffers
+  (when (boundp 'my/graphic-loaded)
+    (set-window-buffer my/main-window my/buffer-1)
+    ;;(set-window-buffer my/upper-window (get-buffer "*Messages*"))
+    (set-window-buffer my/upper-window "*Messages*")
+    (set-window-buffer my/below-window my/buffer-3)))
+
+;; (set-window-buffer current-buffer (get-buffer "*messages*"))))
+;; (set-window-buffer "*messages*")

config/home/.emacs.d/graphic.el

@@ -0,0 +1,22 @@
+;; ~/.emacs.d/graphic.el
+;;
+;; emacs configuration - this file will be loaded only when emacs runs on graphic
+;; system.
+;;
+;; br, 2010-2019
+
+;; avoids calling this twice
+(when (not (boundp 'my/graphic-loaded))
+  ;; disable toolbar
+  (tool-bar-mode -1)
+
+  ;; initial frame size
+  (set-frame-size (selected-frame) 180 50)
+
+  (setq
+    ;; split windows and assign them references
+    my/upper-window (selected-window)
+    my/main-window  (split-window-right)
+    my/below-window (split-window-below)
+
+    my/graphic-loaded t))

config/home/.emacs.d/lorien.el

@@ -0,0 +1,141 @@
+;; ~/.emacs.d/lorien.el
+;;
+;; Emacs configuration - this file will be loaded only when run on lorien.
+;;
+;; br, 2010-2019
+
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; pre-load often-visited files
+
+;; avoids calling this twice
+(when (not (boundp 'my/lorien-loaded))
+  (setq my/lorien-loaded t)
+
+  ;; use ESC as C-g
+  ;; (global-set-key [escape] 'keyboard-escape-quit)
+  ;; (global-unset-key [escape])
+  (define-key key-translation-map (kbd "ESC") (kbd "C-g"))
+
+  ;; mail
+  (require 'message)
+  (setq message-send-mail-function 'smtpmail-send-it
+        smtpmail-default-smtp-server "localhost"
+        smtpmail-smtp-server "localhost"
+        smtpmail-debug-info t
+        mail-signature "\n\n-- \n2 + 2 = 5, for very large values of 2.\n"
+        mail-default-headers "CC: \n"
+        send-mail-function 'smtpmail-send-it
+        )
+
+  ;; shortcuts for tramp
+  ;; (my/add-to-list
+  ;;   'directory-abbrev-alist
+  ;;   '(("^/root" . "/su:/")
+  ;;      ("^/rebel" . "/ssh:arwen:www/cf.bodi/rebels21/")
+  ;;      ("^/strat" . "/ssh:arwen:www/cf.bodi/strat-dom/")))
+
+  (defconst my/loaded-files-at-startup
+    (list
+     "~/dev/brchess/Makefile"
+     "~/dev/tools/c/Makefile"
+     "~/org/boot-disk.org"
+     "~/org/beaglebone-buster-setup.org"
+     ;;"~/dev/www/cf.bodi/sql/coc.sql"
+     ;;"~/dev/www/cf.bodi/sql/coc-sql.org"
+      user-init-file
+      "~/org/emacs-cheatsheet.org"
+      ;;"~/dev/g910/g910-gkey-macro-support/lib/data_mappers/char_uinput_mapper.py"
+      "~/dev/advent-of-code/2022/Makefile"
+      "~/dev/www/com.raoult/devs/php/chess/list-pgn-games.php")
+      ;; "~/dev/eudyptula/ID")
+    "personal files always loaded at startup (no visible window).")
+
+  (let ((num 1))
+    (dolist
+      (filename my/loaded-files-at-startup)
+      (if (file-exists-p filename)
+        (progn
+          ;; set variable "my/buffer-1" to buffer returned by find-file
+          (set
+            (intern (concat "my/buffer-" (number-to-string num)))
+            (find-file-noselect filename nil nil nil))
+          (message "file: [%s] loaded." filename))
+        (message "cannot load file: [%s]." filename))
+        (cl-incf num)))
+
+  ;; set windows for current work buffers
+  (when (boundp 'my/graphic-loaded)
+    (set-window-buffer my/main-window my/buffer-1)
+    (set-window-buffer my/upper-window "*Messages*")
+    (set-window-buffer my/below-window my/buffer-2))
+
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; Coc sync
+  ;; mysql CoC connection (dev)
+  ;;(defun my/connect-coc ()
+    ;;(interactive)
+    ;;(my/sql-connect-preset 'coc))
+
+  (defun my/connect-coc ()
+    (interactive)
+    (sql-connect "coc"))
+
+  ;; sync from/to idril
+  (defun my/coc-get-db ()
+    "get last coc db from arwen"
+    (interactive)
+    ;; force run on local machine when in tramp buffer
+    (with-current-buffer (get-buffer "*scratch*")
+      (async-shell-command "sync-coc-db-from-idril.sh")))
+  (defun my/sync-www ()
+    "sync www to arwen - dry run"
+    (interactive)
+    (with-current-buffer (get-buffer "*scratch*")
+      (async-shell-command "sync-www-to-idril.sh")))
+  (defun my/sync-www-doit ()
+    "sync www to arwen"
+    (interactive)
+    (with-current-buffer (get-buffer "*scratch*")
+      (async-shell-command "sync-www-to-idril.sh -d")))
+
+  (setq org-publish-project-alist
+        '(("org"
+           :base-directory "~/org"
+           :base-extension "org"
+           :publishing-directory "~/dev/www/cf.bodi/org"
+           :recursive t
+           :publishing-function org-html-publish-to-html
+           ;;:headline-levels 4
+           ;;:section-numbers nil
+           ;;:html-head nil
+           :html-head-include-default-style nil
+           :html-head-include-scripts nil
+           ;; :html-preamble my-blog-header
+           ;;:html-postamble my-blog-footer
+           )
+          ("static"
+           :base-directory "~/org/"
+           :base-extension "css\\|js\\|png\\|jpg\\|gif\\|pdf\\|mp3\\|ogg\\|swf"
+           :publishing-directory "~/dev/www/cf.bodi/org/"
+           :recursive t
+           :publishing-function org-publish-attachment)
+
+        ;; Define any other projects here...
+        ))
+
+  (global-set-key (kbd "s-c c c") 'my/connect-coc)
+  (global-set-key (kbd "s-c c g") 'my/coc-get-db)
+  (global-set-key (kbd "s-c c s") 'my/sync-www)
+  (global-set-key (kbd "s-c c w") 'my/sync-www-doit))
+
+;; (Define-key my/keys-mode-map
+;;   (kbd "s-c c g") 'my/coc-gewt-db)
+;; (define-key my/keys-mode-map
+;;   (kbd "s-c c s") 'my/coc-sync-www)
+
+
+
+;; (set-window-buffer current-buffer (get-buffer "*messages*"))))
+;; (set-window-buffer "*messages*")
+
+;; Local Variables:
+;; flycheck-disabled-checkers: (emacs-lisp-checkdoc)
+;; End:

config/home/.emacs.d/term.el

@@ -0,0 +1,9 @@
+;; ~/.emacs.d/term.el
+;;
+;; emacs configuration - this file will be loaded only in terminal mode
+;;
+;; br, 2010-2018
+
+;;(print "loading term.el")
+
+