V0.5.0

Add one argument about the allocation of the dest buffer
Theses wrappers are internal (so no impact to API)
and only used in a few place in m-string.
This make the wrappers able to use the function
strncpy_s & strncat_s for MSVC rather than using
reimplementation of the original functions.

.github/workflows/ccpp.yml

@@ -0,0 +1,100 @@
+name: C/C++ CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        platform: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.platform }}
+    
+    steps:
+    - uses: actions/checkout@v1
+    - name: make check C99
+      run: make clean check CC="cc -std=c99 -Wno-unknown-warning-option -Werror"
+    - name: make check C11
+      working-directory: ./tests
+      run: make clean check CC="cc -std=c11 -Wno-unknown-warning-option -Werror"
+    - name: make check C++
+      working-directory: ./tests
+      run: make clean check CC="c++ -std=c++11"
+
+  build_linux32:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v1
+    - name: update package list
+      run: sudo apt-get update
+    - name: install multilib
+      run: sudo apt-get install gcc-multilib
+    - name: make check C99 (32bits)
+      working-directory: ./tests
+      run: make clean check CC="gcc -m32 -std=c99 -Wno-unknown-warning-option -Werror"
+    - name: make check C11 (32bits)
+      working-directory: ./tests
+      run: make clean check CC="gcc -m32 -std=c11 -Wno-unknown-warning-option -Werror"
+ 
+  build_linux_tcc:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v1
+    - name: Clone TCC
+      shell: bash
+      run:  git clone https://repo.or.cz/tinycc.git
+    - name: Configure, build & install TCC
+      shell: bash
+      run:  cd tinycc && ./configure --prefix=/tmp/tcc && make && make install
+    - name: make depend
+      shell: bash
+      run: make depend
+    - name: make check
+      shell: bash
+      run: make CC="/tmp/tcc/bin/tcc -std=c99" check
+
+  build_windows_mingw:
+    runs-on: windows-latest
+    
+    steps:
+    - uses: actions/checkout@v1
+    - name: make check
+      shell: bash
+      run: mingw32-make CC="gcc -std=c99 -D__USE_MINGW_ANSI_STDIO=1" check
+
+  build_windows_msys2:
+    runs-on: windows-latest
+    defaults:
+      run:
+        shell: msys2 {0}    
+    steps:
+    - uses: actions/checkout@v2
+    - uses: msys2/setup-msys2@v2
+      with:
+          msystem: MINGW64
+          update: true
+          install: git mingw-w64-x86_64-toolchain make
+    - name: make check
+      run: make CC="gcc -std=c99 -D__USE_MINGW_ANSI_STDIO=1" check
+
+  build_windows_visual:
+    runs-on: windows-latest
+    
+    steps:
+    - uses: actions/checkout@v1
+    - name: make check
+      shell: cmd
+      working-directory: ./tests
+      run: Make-check-cl.bat cl
+      
+  build_windows_clang_cl:
+    runs-on: windows-latest
+    
+    steps:
+    - uses: actions/checkout@v1
+    - name: make check
+      shell: cmd
+      working-directory: ./tests
+      run: Make-check-cl.bat clang-cl
+

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,58 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+name: "CodeQL"
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [master]
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        # Override automatic language detection by changing the below list
+        # Supported options are ['csharp', 'cpp', 'go', 'java', 'javascript', 'python']
+        language: ['cpp']
+        # Learn more...
+        # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+      with:
+        # We must fetch at least the immediate parents so that if this is
+        # a pull request then we can checkout the head.
+        fetch-depth: 2
+
+    # If this run was triggered by a pull request event, then checkout
+    # the head of the pull request instead of the merge commit.
+    - run: git checkout HEAD^2
+      if: ${{ github.event_name == 'pull_request' }}
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file. 
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    - name: Autobuild
+      working-directory: ./tests
+      run:  make exe
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.gitignore

@@ -37,3 +37,8 @@ depend
 # Others
 other/
 a*.dat
+config
+*.log
+.vscode
+.vs
+tmp-serial.*

LICENSE

@@ -1,6 +1,6 @@
 BSD 2-Clause License
 
-Copyright (c) 2017-2019, Patrick Pelissier
+Copyright (c) 2017-2021, Patrick Pelissier
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

Makefile

@@ -1,24 +1,47 @@
+# Copyright (c) 2017-2021, Patrick Pelissier
+# All rights reserved.
+# 
+# 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 REGENTS 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 REGENTS AND 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.
+
 # Environnement variable. To customize if needed.
 RM=rm -f
 MKDIR=mkdir -p
+RMDIR=rmdir
 INSTALL=install
 INSTALL_PROGRAM=${INSTALL}
 INSTALL_DATA=${INSTALL} -m 644
 
 # Installation directory
 PREFIX=/usr/local
+DESTDIR=
 
 # Package name & version.
-PACKAGE=m*lib-$(VERSION)
-VERSION=0.2.2
+PACKAGE=m_lib-$(VERSION)
+VERSION=0.5.0
 
 # Define the contain of the distribution tarball
-# TODO: Get theses lists from GIT itself.
-HEADER=m-algo.h m-array.h m-atomic.h m-bitset.h m-bptree.h m-buffer.h m-concurrent.h m-core.h m-deque.h m-dict.h m-genint.h m-i-list.h m-i-shared.h m-list.h m-mempool.h m-mutex.h m-prioqueue.h m-rbtree.h m-shared.h m-snapshot.h m-string.h m-tuple.h m-variant.h m-worker.h
+HEADER=m-algo.h m-array.h m-atomic.h m-bitset.h m-bptree.h m-buffer.h m-c-mempool.h m-concurrent.h m-core.h m-deque.h m-dict.h m-funcobj.h m-genint.h m-i-list.h m-i-shared.h m-list.h m-mempool.h m-mutex.h m-prioqueue.h m-rbtree.h m-serial-bin.h m-serial-json.h m-shared.h m-snapshot.h m-string.h m-tuple.h m-variant.h m-worker.h
 DOC1=LICENSE README.md
-DOC2=doc/API.txt doc/Container.html  doc/Container.ods doc/DEV.md doc/ISSUES.org doc/depend.png doc/oplist.png
-EXAMPLE=example/ex-array01.c  example/ex-array04.c   example/ex-dict02.c  example/ex-grep01.c  example/ex-multi01.c  example/ex-rbtree01.c example/ex-array02.c  example/ex-buffer01.c  example/ex-dict03.c  example/ex-list01.c  example/ex-multi02.c  example/Makefile example/ex-array03.c  example/ex-dict01.c    example/ex-dict04.c  example/ex-mph.c     example/ex-multi03.c
-TEST=tests/coverage.h tests/test-malgo.c tests/test-mbptree.c tests/test-mdeque.c tests/test-milist.c    tests/test-mmutex.c      tests/test-mshared.c    tests/test-mtuple.c    tests/test-obj.h     tests/tgen-mdict.c    tests/tgen-openmp.c  tests/wip-mregister.c tests/dict.txt    tests/test-marray.c   tests/test-mbuffer.c  tests/test-mdict.c    tests/test-mlist.c     tests/test-mprioqueue.c  tests/test-msnapshot.c  tests/test-mvariant.c  tests/tgen-bitset.c  tests/tgen-mlist.c    tests/tgen-queue.c tests/Makefile    tests/test-mbitset.c  tests/test-mcore.c    tests/test-mgenint.c  tests/test-mmempool.c  tests/test-mrbtree.c     tests/test-mstring.c    tests/test-mworker.c   tests/tgen-marray.c  tests/tgen-mstring.c  tests/tgen-shared.c
+DOC2=doc/API.txt doc/Container.html doc/Container.ods doc/depend.png doc/DEV.md doc/ISSUES.org doc/oplist.odp doc/oplist.png
+EXAMPLE=example/ex11-algo01.c example/ex11-algo02.c example/ex11-json01.c example/ex11-section.c example/ex-algo02.c example/ex-algo03.c example/ex-algo04.c example/ex-array00.c example/ex-array01.c example/ex-array02.c example/ex-array03.c example/ex-array04.c example/ex-array05.c example/ex-bptree01.c example/ex-buffer01.c example/ex-dict01.c example/ex-dict02.c example/ex-dict03.c example/ex-dict04.c example/ex-grep01.c example/ex-list01.c example/ex-mph.c example/ex-multi01.c example/ex-multi02.c example/ex-multi03.c example/ex-multi04.c example/ex-multi05.c example/ex-rbtree01.c example/ex11-algo02.json example/ex11-json01.json example/Makefile
+TEST=tests/test-malgo.c tests/test-marray.c tests/test-mbitset.c tests/test-mbptree.c tests/test-mbuffer.c tests/test-mcmempool.c tests/test-mconcurrent.c tests/test-mcore.c tests/test-mdeque.c tests/test-mdict.c tests/test-mfuncobj.c tests/test-mgenint.c tests/test-milist.c tests/test-mlist.c tests/test-mmempool.c tests/test-mmutex.c tests/test-mprioqueue.c tests/test-mrbtree.c tests/test-mserial-bin.c tests/test-mserial-json.c tests/test-mshared.c tests/test-msnapshot.c tests/test-mstring.c tests/test-mtuple.c tests/test-mvariant.c tests/test-mworker.c tests/tgen-bitset.c tests/tgen-marray.c tests/tgen-mdict.c tests/tgen-mlist.c tests/tgen-mstring.c tests/tgen-openmp.c tests/tgen-queue.c tests/tgen-shared.c tests/Makefile tests/coverage.h tests/test-obj.h tests/dict.txt
 
 .PHONY: all test check doc clean distclean depend install uninstall dist
 
@@ -31,6 +54,10 @@ check:
 	cd tests && $(MAKE) check
 	cd example && $(MAKE) all
 
+checkall:
+	cd tests && $(MAKE) checkall
+	cd example && $(MAKE) all
+
 html:	doc
 doc:	README.md doc/depend.png
 	markdown < README.md > README.html
@@ -70,8 +97,13 @@ distcheck: dist
 	cd '$(PACKAGE)' && make check
 
 install:
-	$(MKDIR) $(DESTDIR)$(PREFIX)/include
-	$(INSTALL_DATA) $(HEADER) $(DESTDIR)$(PREFIX)/include
+	$(MKDIR) $(DESTDIR)$(PREFIX)/include/m-lib
+	$(INSTALL_DATA) $(HEADER) $(DESTDIR)$(PREFIX)/include/m-lib
 
 uninstall:
-	for i in $(HEADER) ; do $(RM) $(DESTDIR)$(PREFIX)/include/$$i ; done
+	for i in $(HEADER) ; do $(RM) $(DESTDIR)$(PREFIX)/include/m-lib/$$i ; done
+	$(RMDIR) $(DESTDIR)$(PREFIX)/include/m-lib/
+
+format:
+	cd example && $(MAKE) ex-string01.exe
+	for i in $(HEADER) ; do ./example/ex-string01.exe $$i > tmp.h && mv tmp.h $$i ; done

bench/Makefile

@@ -1,3 +1,25 @@
+# Copyright (c) 2017-2021, Patrick Pelissier
+# All rights reserved.
+# 
+# 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 REGENTS 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 REGENTS AND 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.
+
 CC=cc -std=c11
 CXX=c++ -std=c++11
 CFLAGS=-O2 -march=native -Wall
@@ -7,7 +29,7 @@ N=4
 BENCH_DEF=
 RM=rm -rf
 
-.PHONY: all pgo container queue mempool string plain bench-mlib bench-mlib-mempool bench-stl bench-qt bench-glib bench-klib bench-libdynamic bench-sparsepp bench-collectionc bench-tommyds bench-flathashmap bench-hopscotchmap bench-mlib-thread bench-liblfds bench-concurrentqueue bench-boost bench-mempool bench-string bench-plain
+.PHONY: all pgo container queue mempool string plain bench-mlib bench-mlib-mempool bench-stl bench-qt bench-glib bench-klib bench-libdynamic bench-sparsepp bench-collectionc bench-tommyds bench-flathashmap bench-emilib bench-hopscotchmap bench-mlib-thread bench-liblfds bench-concurrentqueue bench-boost bench-mempool bench-string bench-plain bench-rigtorp-mpmc-queue bench-cmc
 
 all: container queue mempool string plain
 
@@ -17,10 +39,10 @@ pgo:
 
 #########################################################################
 
-container: bench-mlib bench-mlib-mempool bench-stl bench-qt bench-glib bench-klib bench-libdynamic bench-sparsepp bench-collectionc bench-tommyds bench-flathashmap bench-hopscotchmap
+container: bench-mlib bench-mlib-mempool bench-stl bench-qt bench-glib bench-klib bench-libdynamic bench-cmc bench-sparsepp bench-densehashmap bench-collectionc bench-tommyds bench-flathashmap bench-emilib bench-hopscotchmap bench-uthash bench-qlibc bench-libsrt bench-nedtries bench-rigtorp-hashmap
 	@echo "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
 
-queue: bench-mlib-thread bench-liblfds bench-concurrentqueue bench-boost
+queue: bench-mlib-thread bench-liblfds bench-concurrentqueue bench-boost bench-rigtorp-mpmc-queue
 	@echo "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
 
 mempool: bench-mempool
@@ -38,7 +60,7 @@ plain: bench-plain
 
 
 bench-mlib:
-	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -pthread bench-mlib.c -o bench-mlib.exe
+	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -pthread bench-mlib.c common.c -o bench-mlib.exe
 	@./bench-mlib.exe 10
 	@./bench-mlib.exe 11
 	@./bench-mlib.exe 20
@@ -47,12 +69,14 @@ bench-mlib:
 	@./bench-mlib.exe 40
 	@./bench-mlib.exe 41
 	@./bench-mlib.exe 42
+	@./bench-mlib.exe 46
+	@./bench-mlib.exe 47
 	@./bench-mlib.exe 43
 	@./bench-mlib.exe 50
 	@./bench-mlib.exe 51
 
 bench-mlib-mempool:
-	$(CC) $(CFLAGS) $(CPPFLAGS) bench-mlib.c -DUSE_MEMPOOL -pthread -o bench-mlib-mempool.exe
+	$(CC) $(CFLAGS) $(CPPFLAGS) bench-mlib.c common.c -DUSE_MEMPOOL -pthread -o bench-mlib-mempool.exe
 	@./bench-mlib-mempool.exe 10
 	@./bench-mlib-mempool.exe 11
 	@./bench-mlib-mempool.exe 20
@@ -61,12 +85,14 @@ bench-mlib-mempool:
 	@./bench-mlib-mempool.exe 40
 	@./bench-mlib-mempool.exe 41
 	@./bench-mlib-mempool.exe 42
+	@./bench-mlib-mempool.exe 46
+	@./bench-mlib-mempool.exe 47
 	@./bench-mlib-mempool.exe 43
 	@./bench-mlib-mempool.exe 50
 	@./bench-mlib-mempool.exe 51
 
 bench-mlib-thread:
-	$(CC) $(CFLAGS) $(CPPFLAGS) bench-mlib.c -DMULTI_THREAD_MEASURE -pthread -o bench-mlib-thread.exe
+	$(CC) $(CFLAGS) $(CPPFLAGS) bench-mlib.c common.c -DMULTI_THREAD_MEASURE -pthread -o bench-mlib-thread.exe
 	@./bench-mlib-thread.exe 60
 	@./bench-mlib-thread.exe 61
 	@./bench-mlib-thread.exe 62
@@ -76,13 +102,14 @@ bench-mlib-thread:
 	@./bench-mlib-thread.exe 66
 
 bench-stl:
-	$(CXX) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) bench-stl.cpp -o bench-stl.exe
+	$(CXX) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) bench-stl.cpp common.c -o bench-stl.exe
 	@./bench-stl.exe 10
 	@./bench-stl.exe 20
 	@./bench-stl.exe 30
 	@./bench-stl.exe 40
 	@./bench-stl.exe 41
 	@./bench-stl.exe 42
+	@./bench-stl.exe 46
 	@./bench-stl.exe 43
 	@./bench-stl.exe 50
 	@./bench-stl.exe 51
@@ -91,7 +118,7 @@ bench-stl:
 bench-qt:
 	@if test -n "$${QT}" ; then $(MAKE) bench-qt0 ; else echo "Nothing to be done for QT." ; fi
 bench-qt0:
-	$(CXX) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -fPIC `PKG_CONFIG_PATH="$${QT}" pkg-config --libs --cflags Qt5Core` bench-qt.cpp -o bench-qt.exe
+	$(CXX) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -fPIC `PKG_CONFIG_PATH="$${QT}" pkg-config --libs --cflags Qt5Core` bench-qt.cpp common.c -o bench-qt.exe
 	@./bench-qt.exe 10
 	@./bench-qt.exe 20
 	@./bench-qt.exe 30
@@ -104,7 +131,7 @@ bench-qt0:
 bench-glib:
 	@if test -n "$${GLIB}" ; then $(MAKE) bench-glib0 ; else echo "Nothing to be done for GLIB." ; fi
 bench-glib0:
-	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) bench-glib.c -o bench-glib.exe `PKG_CONFIG_PATH="$${GLIB}" pkg-config --libs --cflags glib-2.0`
+	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) bench-glib.c common.c -o bench-glib.exe `PKG_CONFIG_PATH="$${GLIB}" pkg-config --libs --cflags glib-2.0`
 	@./bench-glib.exe 10
 	@./bench-glib.exe 20
 	@./bench-glib.exe 30
@@ -117,7 +144,7 @@ bench-klib:
 	@if test -n "$${KLIB}" ; then $(MAKE) bench-klib0 ; else echo "Nothing to be done for KLIB." ; fi
 
 bench-klib0:
-	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I $${KLIB} bench-klib.c -o bench-klib.exe
+	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I $${KLIB} bench-klib.c common.c -o bench-klib.exe
 	@./bench-klib.exe 10
 	@./bench-klib.exe 20
 	@./bench-klib.exe 30
@@ -125,25 +152,32 @@ bench-klib0:
 	@./bench-klib.exe 41
 	@./bench-klib.exe 50
 
+# CMC shall point to the directory where the CMC main header is
+bench-cmc:
+	@if test -n "$${CMC}" ; then $(MAKE) bench-cmc0 ; else echo "Nothing to be done for CMC." ; fi
+
+bench-cmc0:
+	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I $${CMC} bench-cmc.c common.c -o bench-cmc.exe
+	@./bench-cmc.exe 20
+	@./bench-cmc.exe 30
+	@./bench-cmc.exe 40
+
 # LIBDYNAMIC shall point to the the directory containing the file libdynamic.pc
 bench-libdynamic:
 	@if test -n "$${LIBDYNAMIC}" ; then $(MAKE) bench-libdynamic0 ; else echo "Nothing to be done for LIBDYNAMIC." ; fi
 
 bench-libdynamic0:
-	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) bench-libdynamic.c -o bench-libdynamic.exe `PKG_CONFIG_PATH="$${LIBDYNAMIC}" pkg-config --libs --cflags libdynamic` 
-	@./bench-libdynamic.exe 10
+	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) bench-libdynamic.c common.c -o bench-libdynamic.exe `PKG_CONFIG_PATH="$${LIBDYNAMIC}" pkg-config --libs --cflags libdynamic` 
 	@./bench-libdynamic.exe 20
-	@./bench-libdynamic.exe 30
 	@./bench-libdynamic.exe 40
 	@./bench-libdynamic.exe 41
-	@./bench-libdynamic.exe 50
 
 # SPARSEPP shall point to the directory where the headers are
 bench-sparsepp:
 	@if test -n "$${SPARSEPP}" ; then $(MAKE) bench-sparsepp0 ; else echo "Nothing to be done for SPARSEPP." ; fi
 
 bench-sparsepp0:
-	$(CXX) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${SPARSEPP}"  -I "$${SPARSEPP}/.." bench-sparsepp.cpp -o bench-sparsepp.exe
+	$(CXX) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${SPARSEPP}"  -I "$${SPARSEPP}/.." bench-sparsepp.cpp common.c -o bench-sparsepp.exe
 	@./bench-sparsepp.exe 41
 	@./bench-sparsepp.exe 42
 	@./bench-sparsepp.exe 43
@@ -153,17 +187,17 @@ bench-densehashmap:
 	@if test -n "$${DENSEHASHMAP}" ; then $(MAKE) bench-densehashmap0 ; else echo "Nothing to be done Google DENSEHASHMAP." ; fi
 
 bench-densehashmap0:
-	$(CXX) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${DENSEHASHMAP}"  -I "$${DENSEHASHMAP}/.." bench-densehashmap.cpp -o bench-densehashmap.exe
+	$(CXX) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${DENSEHASHMAP}"  -I "$${DENSEHASHMAP}/.." bench-densehashmap.cpp common.c -o bench-densehashmap.exe
 	@./bench-densehashmap.exe 41
 	@./bench-densehashmap.exe 42
 	@./bench-densehashmap.exe 43
 
-# COLLECTIONC shall point to the directory where the 'src' directory is.
+# COLLECTIONC shall point to the directory where it is installed
 bench-collectionc:
 	@if test -n "$${COLLECTIONC}" ; then $(MAKE) bench-collectionc0 ; else echo "Nothing to be done for COLLECTIONC." ; fi
 
 bench-collectionc0:
-	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${COLLECTIONC}/include" -L "$${COLLECTIONC}" -static bench-collectionc.c -lcollectc -o bench-collectionc.exe
+	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${COLLECTIONC}/include/collectc"  bench-collectionc.c common.c "$${COLLECTIONC}/lib/libcollectc.a" -o bench-collectionc.exe
 	@./bench-collectionc.exe 10
 	@./bench-collectionc.exe 20
 	@./bench-collectionc.exe 30
@@ -176,7 +210,7 @@ bench-tommyds:
 	@if test -n "$${TOMMYDS}" ; then $(MAKE) bench-tommyds0 ; else echo "Nothing to be done for TOMMYDS." ; fi
 
 bench-tommyds0:
-	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${TOMMYDS}" bench-tommyds.c $${TOMMYDS}/tommyds/tommyarray.c $${TOMMYDS}/tommyds/tommylist.c $${TOMMYDS}/tommyds/tommytree.c $${TOMMYDS}/tommyds/tommyhashlin.c -o bench-tommyds.exe
+	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${TOMMYDS}" bench-tommyds.c $${TOMMYDS}/tommyds/tommyarray.c $${TOMMYDS}/tommyds/tommylist.c $${TOMMYDS}/tommyds/tommytree.c $${TOMMYDS}/tommyds/tommyhashlin.c common.c -o bench-tommyds.exe
 	@./bench-tommyds.exe 10
 	@./bench-tommyds.exe 20
 	@./bench-tommyds.exe 30
@@ -188,17 +222,29 @@ bench-flathashmap:
 	@if test -n "$${FLATHASHMAP}" ; then $(MAKE) bench-flathashmap0 ; else echo "Nothing to be done for FLATHASHMAP." ; fi
 
 bench-flathashmap0:
-	$(CXX) -std=c++14 $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${FLATHASHMAP}" bench-flathashmap.cpp -o bench-flathashmap.exe
+	$(CXX) -std=c++14 $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${FLATHASHMAP}" bench-flathashmap.cpp common.c -o bench-flathashmap.exe
 	@./bench-flathashmap.exe 41
 	@./bench-flathashmap.exe 42
+	@./bench-flathashmap.exe 46
 	@./bench-flathashmap.exe 43
 
+# EMILIB shall point to the directory where the headers are
+bench-emilib:
+	@if test -n "$${EMILIB}" ; then $(MAKE) bench-emilib0 ; else echo "Nothing to be done for EMILIB." ; fi
+
+bench-emilib0:
+	$(CXX) -std=c++14 $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${EMILIB}" bench-emilib.cpp common.c -o bench-emilib.exe
+	@./bench-emilib.exe 41
+	@./bench-emilib.exe 42
+	@./bench-emilib.exe 46
+	@./bench-emilib.exe 43
+
 # HOPSCOTCHMAP shall point to the directory where the source are
 bench-hopscotchmap:
 	@if test -n "$${HOPSCOTCHMAP}" ; then $(MAKE) bench-hopscotchmap0 ; else echo "Nothing to be done for HOPSCOTCHMAP." ; fi
 
 bench-hopscotchmap0:
-	$(CXX) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${HOPSCOTCHMAP}" bench-hopscotchmap.cpp -o bench-hopscotchmap.exe
+	$(CXX) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${HOPSCOTCHMAP}/include/tsl" bench-hopscotchmap.cpp common.c -o bench-hopscotchmap.exe
 	@./bench-hopscotchmap.exe 41
 	@./bench-hopscotchmap.exe 42
 	@./bench-hopscotchmap.exe 43
@@ -208,12 +254,11 @@ bench-uthash:
 	@if test -n "$${UTHASH}" ; then $(MAKE) bench-uthash0 ; else echo "Nothing to be done for UTHASH." ; fi
 
 bench-uthash0:
-	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${UTHASH}" bench-uthash.c -o bench-uthash.exe
+	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${UTHASH}" bench-uthash.c common.c -o bench-uthash.exe
 	@./bench-uthash.exe 10
 	@./bench-uthash.exe 20
+	@./bench-uthash.exe 40
 	@./bench-uthash.exe 41
-	@./bench-uthash.exe 42
-	@./bench-uthash.exe 43
 	@./bench-uthash.exe 50
 
 # QLIBC shall point to the directory where the library is installed.
@@ -221,25 +266,18 @@ bench-qlibc:
 	@if test -n "$${QLIBC}" ; then $(MAKE) bench-qlibc0 ; else echo "Nothing to be done for QLIBC." ; fi
 
 bench-qlibc0:
-	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${QLIBC}/include" -L "$${QLIBC}/lib" -lqlibc -pthread bench-qlibc.c -o bench-qlibc.exe
+	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${QLIBC}/include" -L "$${QLIBC}/lib" -lqlibc -pthread bench-qlibc.c common.c -o bench-qlibc.exe
 	@LD_LIBRARY_PATH="$${QLIBC}/lib:$${LD_LIBRARY_PATH}" ./bench-qlibc.exe 10
 	@LD_LIBRARY_PATH="$${QLIBC}/lib:$${LD_LIBRARY_PATH}" ./bench-qlibc.exe 20
 	@LD_LIBRARY_PATH="$${QLIBC}/lib:$${LD_LIBRARY_PATH}" ./bench-qlibc.exe 30
-	@LD_LIBRARY_PATH="$${QLIBC}/lib:$${LD_LIBRARY_PATH}" ./bench-qlibc.exe 42
-	@LD_LIBRARY_PATH="$${QLIBC}/lib:$${LD_LIBRARY_PATH}" ./bench-qlibc.exe 41
 
-# LIBSRT shall point to the directory where the source are
-# The library shall be built.
+# LIBSRT shall point to the directory where it is installed
 bench-libsrt:
 	@if test -n "$${LIBSRT}" ; then $(MAKE) bench-libsrt0 ; else echo "Nothing to be done for LIBSRT." ; fi
 
 bench-libsrt0:
-	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${LIBSRT}/src" bench-libsrt.c -o bench-libsrt.exe $${LIBSRT}/libsrt.a 
-	@./bench-libsrt.exe 10
+	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${LIBSRT}/include/libsrt" bench-libsrt.c common.c -o bench-libsrt.exe $${LIBSRT}/lib/libsrt.a 
 	@./bench-libsrt.exe 20
-	@./bench-libsrt.exe 41
-	@./bench-libsrt.exe 42
-	@./bench-libsrt.exe 43
 	@./bench-libsrt.exe 50
 
 
@@ -248,7 +286,7 @@ bench-libsrt0:
 bench-liblfds:
 	@if test -n "$${LIBLFDS}" ; then $(MAKE) bench-liblfds0 ; else echo "Nothing to be done for LIBLFDS." ; fi
 bench-liblfds0:
-	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${LIBLFDS}/inc" -Wno-unknown-pragmas bench-liblfds.c -o bench-liblfds.exe $${LIBLFDS}/bin/liblfds711.a -lpthread
+	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${LIBLFDS}/inc" -Wno-unknown-pragmas bench-liblfds.c common.c -DMULTI_THREAD_MEASURE -o bench-liblfds.exe $${LIBLFDS}/bin/liblfds711.a -lpthread
 	@LD_LIBRARY_PATH="$${LIBLFDS}/bin:$${LD_LIBRARY_PATH}" ./bench-liblfds.exe 60
 
 
@@ -257,7 +295,7 @@ bench-liblfds0:
 bench-concurrentqueue:
 	@if test -n "$${CONCURRENTQUEUE}" ; then $(MAKE) bench-concurrentqueue0 ; else echo "Nothing to be done for CONCURRENTQUEUE." ; fi
 bench-concurrentqueue0:
-	$(CXX) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${CONCURRENTQUEUE}/" bench-concurrentqueue.cpp -o bench-concurrentqueue.exe -lpthread
+	$(CXX) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${CONCURRENTQUEUE}/" bench-concurrentqueue.cpp common.c -DMULTI_THREAD_MEASURE  -o bench-concurrentqueue.exe -lpthread
 	@./bench-concurrentqueue.exe 60
 
 
@@ -266,24 +304,56 @@ bench-concurrentqueue0:
 bench-xxhash:
 	@if test -n "$${XXHASH}" ; then $(MAKE) bench-xxhash0 ; else echo "Nothing to be done for XXHASH." ; fi
 bench-xxhash0:
-	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${XXHASH}/" bench-xxhash.c "$${XXHASH}/libxxhash.a" -o bench-xxhash.exe
+	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${XXHASH}/" bench-xxhash.c common.c "$${XXHASH}/libxxhash.a" -o bench-xxhash.exe
 	@./bench-xxhash.exe 70
 
 # BOOST shall point to the header location.
 bench-boost:
 	@if test -n "$${BOOST}" ; then $(MAKE) bench-boost0 ; else echo "Nothing to be done for BOOST." ; fi
 bench-boost0:
-	$(CXX) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${BOOST}" bench-boost.cpp -o bench-boost.exe -lpthread
+	$(CXX) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${BOOST}" bench-boost.cpp common.c -DMULTI_THREAD_MEASURE -o bench-boost.exe -lpthread
 	@./bench-boost.exe 60
 
 # NEDTRIES shall point to the header location.
 bench-nedtries:
 	@if test -n "$${NEDTRIES}" ; then $(MAKE) bench-nedtries0 ; else echo "Nothing to be done for NEDTRIES." ; fi
 bench-nedtries0:
-	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${NEDTRIES}" bench-nedtries.c -o bench-nedtries.exe
+	$(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${NEDTRIES}" bench-nedtries.c common.c -o bench-nedtries.exe
 	@./bench-nedtries.exe 40
 	@./bench-nedtries.exe 45
 
+# RIGTORP_HASHMAP shall point to the directory where the headers are
+bench-rigtorp-hashmap:
+	@if test -n "$${RIGTORP_HASHMAP}" ; then $(MAKE) bench-rigtorp-hashmap0 ; else echo "Nothing to be done for RIGTORP_HASHMAP." ; fi
+
+bench-rigtorp-hashmap0:
+	$(CXX) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${RIGTORP_HASHMAP}/include" bench-rigtorp-hashmap.cpp common.c -o bench-rigtorp-hashmap.exe
+	@./bench-rigtorp-hashmap.exe 42
+	@./bench-rigtorp-hashmap.exe 41
+	@./bench-rigtorp-hashmap.exe 43
+
+# RIGTORP_MPMC_QUEUE shall point to the directory where the headers are
+bench-rigtorp-mpmc-queue:
+	@if test -n "$${RIGTORP_MPMC_QUEUE}" ; then $(MAKE) bench-rigtorp-mpmc-queue0 ; else echo "Nothing to be done for RIGTORP_MPMC_QUEUE." ; fi
+bench-rigtorp-mpmc-queue0:
+	$(CXX) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${RIGTORP_MPMC_QUEUE}" bench-rigtorp-mpmcqueue.cpp common.c -DMULTI_THREAD_MEASURE -o bench-mpmcqueue.exe -lpthread
+	@./bench-mpmcqueue.exe 60
+
+############################################################################
+
+bench-mlib-json: bench-mlib
+	@./bench-mlib.exe 110
+	@./bench-mlib.exe 111
+	@./bench-mlib.exe 112
+
+bench-rapidjson:
+	@if test -n "$${RAPIDJSON}" ; then $(MAKE) bench-rapidjson0 ; else echo "Nothing to be done for RAPIDJSON." ; fi
+bench-rapidjson0:
+	$(CXX) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) -I "$${RAPIDJSON}/" bench-rapidjson.cpp common.c -o bench-rapidjson.exe
+	@./bench-rapidjson.exe 110
+	@./bench-rapidjson.exe 111
+	@./bench-rapidjson.exe 112
+
 ############################################################################
 
 bench-plain:
@@ -307,19 +377,16 @@ bench-maxdict:
 ############################################################################
 
 # BSTRLIB shall point to the BSTRLIB sources
-# LIBSRT shall point to the LIBSRT sources
+# LIBSRT shall point to the LIBSRT install directory
 bench-string:
 	@if test -n "$${BSTRLIB}" ; then $(MAKE) bench-string-step1 BENCH_DEF="-DBENCH_CAN_USE_BSTRLIB -I ${BSTRLIB} $${BSTRLIB}/obj/bstrlib.o $${BSTRLIB}/obj/bstraux.o $${BSTRLIB}/obj/bstrwrap.o" ; else $(MAKE) bench-string-step1 ; fi
 
 bench-string-step1:
-	@if test -n "$${LIBSRT}" ; then $(MAKE) bench-string-step2 BENCH_DEF="$(BENCH_DEF) -DBENCH_CAN_USE_LIBSRT -I$${LIBSRT}/src $${LIBSRT}/libsrt.a" ; else $(MAKE) bench-string-step2 BENCH_DEF="$(BENCH_DEF)"; fi
+	@if test -n "$${LIBSRT}" ; then $(MAKE) bench-string-step2 BENCH_DEF="$(BENCH_DEF) -DBENCH_CAN_USE_LIBSRT -I$${LIBSRT}/include/libsrt $${LIBSRT}/lib/libsrt.a" ; else $(MAKE) bench-string-step2 BENCH_DEF="$(BENCH_DEF)"; fi
 
 #NOTE: Need to build by hand sds.o since it is not build by default and sds.c is not compatible with C++
 bench-string-step2:
-	@if test -n "$${SDS}" ; then $(MAKE) bench-string-step3 BENCH_DEF="$(BENCH_DEF) -fpermissive -DBENCH_CAN_USE_SDS -I$${SDS}/ $${SDS}/sds.o" ; else $(MAKE) bench-string-step3 BENCH_DEF="$(BENCH_DEF)"; fi
-
-bench-string-step3:
-	@if test -n "$${RAPIDSTRING}" ; then $(MAKE) bench-string-step4 BENCH_DEF="$(BENCH_DEF) -DBENCH_CAN_USE_RAPIDSTRING -I$${RAPIDSTRING}/ " ; else $(MAKE) bench-string-step4 BENCH_DEF="$(BENCH_DEF)"; fi
+	@if test -n "$${SDS}" ; then $(MAKE) bench-string-step4 BENCH_DEF="$(BENCH_DEF) -fpermissive -DBENCH_CAN_USE_SDS -I$${SDS}/ $${SDS}/sds.o" ; else $(MAKE) bench-string-step4 BENCH_DEF="$(BENCH_DEF)"; fi
 
 bench-string-step4:
 	@if test -n "$${GLIB}" ; then $(MAKE) bench-string-step5 BENCH_DEF="$(BENCH_DEF) -DBENCH_CAN_USE_GLIB $$(pkg-config --cflags --libs glib-2.0)" ; else $(MAKE) bench-string-step5 BENCH_DEF="$(BENCH_DEF)"; fi
@@ -331,7 +398,7 @@ bench-string-step5:
 	@./bench-string-2.exe  2000000 0
 	@./bench-string-2.exe  2000000 1
 	@./bench-string-2.exe  2000000 2
-	@./bench-string-2.exe  2000000 3
+	@./bench-string-2.exe  2000000 4
 
 bench-string-pgo:
 	$(MAKE) bench-string XCFLAGS="-fprofile-generate=pgo"
@@ -339,9 +406,18 @@ bench-string-pgo:
 
 ############################################################################
 
+bench-find-sort:
+	g++ bench-find-sort.cpp -O2 -march=native -std=c++11 -I.. -g common.c -o bench-find-sort.exe
+	./bench-find-sort.exe 10000000
+
+############################################################################
+
 clean:
-	$(RM) *.o bench-*.exe bench-*.s *~ massif.out.*
+	$(RM) *.o bench-*.exe
+	$(RM) bench-*.s *~ massif.out.*
+	$(RM) plot-*.dat
 	$(RM) pgo
+	$(RM) tmp-serial.*
 	cd nucleotide && $(MAKE) clean
 
 ############################################################################

bench/bench-boost.cpp

@@ -6,11 +6,8 @@
 
 #include <boost/lockfree/queue.hpp>
 
-#include "m-mutex.h"
-#define MULTI_THREAD_MEASURE
 #include "common.h"
 
-
 /********************************************************************************************/
 boost::lockfree::queue<unsigned int, boost::lockfree::capacity<4*64>> g_buff;
 boost::lockfree::queue<unsigned long long, boost::lockfree::capacity<4*64>> g_final;
@@ -51,7 +48,7 @@ static void prod(void *arg)
   }
 }
 
-static void test_buffer(size_t n)
+static void test_queue(size_t n)
 {
   const int cpu_count   = get_cpu_count();
   const int prod_count  = cpu_count/2;
@@ -88,11 +85,12 @@ static void test_buffer(size_t n)
 
 /********************************************************************************************/
 
+const config_func_t table[] = {
+  { 60,    "Queue MPMC", 1000000, 0, test_queue, 0}
+};
+
 int main(int argc, const char *argv[])
 {
-  int n = (argc > 1) ? atoi(argv[1]) : 0;
-  if (n == 60)
-    test_function("Buffer time", 1000000, test_buffer);
+  test("BOOST-LOCKFREE", numberof(table), table, argc, argv);
   exit(0);
 }
-

bench/bench-cmc.c

@@ -0,0 +1,204 @@
+#define NDEBUG
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <stdbool.h>
+
+#include "macro_collections.h"
+
+#include "common.h"
+
+/********************************************************************************************/
+
+// CMC list are dynamic array
+#define MY_LIST_PARAMS (list_uint, list_uint_s, , , unsigned int)
+C_MACRO_COLLECTIONS_EXTENDED(CMC, LIST, MY_LIST_PARAMS, (STR))
+
+struct list_uint_s_fval list_fval = { .cmp = NULL,
+				      .cpy = NULL,
+				      .str = NULL,
+				      .free = NULL,
+				      .hash = NULL,
+				      .pri = NULL };
+
+static void test_array(size_t n)
+{
+  struct list_uint_s *a1 = list_uint_new(1, &list_fval);
+  struct list_uint_s *a2 = list_uint_new(1, &list_fval);
+  
+  for(size_t i = 0; i < n; i++) {
+    list_uint_push_back(a1, rand_get() );
+    list_uint_push_back(a2, rand_get() );
+  }
+  
+  unsigned int s = 0;
+  for(unsigned long i = 0; i < n; i++) {
+    s += list_uint_get(a1, i ) * list_uint_get(a2, i );
+  }
+  g_result = s;
+  
+  list_uint_free(a1);
+  list_uint_free(a2);
+}
+
+/********************************************************************************************/
+
+#define my_cmp(a,b) ( (a) < (b) ? -1 : (a) > (b) )
+
+#define MY_TMAP_PARAMS (tree_ulong, tree_ulong_s, , unsigned long, bool)
+C_MACRO_COLLECTIONS_EXTENDED(CMC, TREEMAP, MY_TMAP_PARAMS, (STR))
+
+int cmp_ulong(unsigned long a, unsigned long b) { return my_cmp(a,b); }
+
+struct tree_ulong_s_fkey tree_fkey = { .cmp = cmp_ulong,
+				       .cpy = NULL,
+				       .str = NULL,
+				       .free = NULL,
+				       .hash = NULL,
+				       .pri = NULL };
+
+struct tree_ulong_s_fval tree_fval = { .cmp = NULL,
+				       .cpy = NULL,
+				       .str = NULL,
+				       .free = NULL,
+				       .hash = NULL,
+				       .pri = NULL };
+
+static void test_rbtree(size_t n)
+{
+  struct tree_ulong_s *tree;
+  tree = tree_ulong_new(&tree_fkey, &tree_fval);
+
+  for (size_t i = 0; i < n; i++) {
+    unsigned long j = rand_get();
+    tree_ulong_insert(tree, j, true);
+  }
+    
+  rand_init();
+  unsigned int s = 0;
+  for (size_t i = 0; i < n; i++) {
+    unsigned long j = rand_get();
+    if (tree_ulong_get_ref(tree, j) != 0)
+      s+= j;
+  }
+  g_result = s;
+  tree_ulong_free(tree);
+}
+
+/********************************************************************************************/
+#define hash_func(a) kh_int64_hash_func(a)
+size_t hash_ulong(unsigned long a)
+{
+  return ( (a) >> 33 ) ^ (a) ^ ((a) << 11);
+}
+
+#define MY_DICT_PARAMS (hmap, hmap_s, , unsigned long, unsigned long)
+C_MACRO_COLLECTIONS_EXTENDED(CMC, HASHMAP, MY_DICT_PARAMS, (STR))
+
+struct hmap_s_fkey hmap_fkey = { .cmp = cmp_ulong,
+				 .cpy = NULL,
+				 .str = NULL,
+				 .free = NULL,
+				 .hash = hash_ulong,
+				 .pri = NULL };
+
+struct hmap_s_fval hmap_fval = { .cmp = NULL,
+				 .cpy = NULL,
+				 .str = NULL,
+				 .free = NULL,
+				 .hash = NULL,
+				 .pri = NULL };
+
+static void
+test_dict(size_t  n)
+{
+  struct hmap_s *dict = hmap_new(16, 0.7, &hmap_fkey, &hmap_fval);
+  
+  for (size_t i = 0; i < n; i++) {
+    hmap_insert(dict, rand_get(), rand_get());
+  }
+  rand_init();
+  unsigned int s = 0;
+  for (size_t i = 0; i < n; i++) {
+    unsigned long *val = hmap_get_ref(dict, rand_get());
+    if (val != 0)
+      s += *val;
+  }
+  g_result = s;
+  
+  hmap_free(dict);
+}
+
+/********************************************************************************************/
+
+#if 0 // Not working issue in using not integer types
+
+typedef struct {
+  char a[256];
+} char_array_t;
+static inline int char_cmp (const char_array_t a, const char_array_t b) { return strcmp(a.a,b.a); }
+static inline size_t char_hash(const char_array_t a) {
+  size_t hash = 0;
+  const char *s = a.a;
+  while (*s) hash = hash * 31421 + (*s++) + 6927;
+  return hash;
+}
+
+#define MY_DICTB_PARAMS (bhmap, bhmap_s, , char_array_t, char_array_t)
+C_MACRO_COLLECTIONS_EXTENDED(CMC, HASHMAP, MY_DICT_PARAMS, (STR))
+
+struct bhmap_s_fkey bhmap_fkey = { .cmp = char_cmp,
+				   .cpy = NULL,
+				   .str = NULL,
+				   .free = NULL,
+				   .hash = char_hash,
+				   .pri = NULL };
+
+struct bhmap_s_fval bhmap_fval = { .cmp = NULL,
+				 .cpy = NULL,
+				 .str = NULL,
+				 .free = NULL,
+				 .hash = NULL,
+				 .pri = NULL };
+
+static void
+test_dict_big(size_t  n)
+{
+  struct bhmap_s *dict = bhmap_new(16, 0.7, &bhmap_fkey, &bhmap_fval);
+  
+  for (size_t i = 0; i < n; i++) {
+    char_array_t s1, s2;
+    sprintf(s1.a, "%u", rand_get());
+    sprintf(s2.a, "%u", rand_get());
+    bhmap_insert(dict, s1, s2);
+  }
+  rand_init();
+  unsigned int s = 0;
+  for (size_t i = 0; i < n; i++) {
+    char_array_t s1;
+    sprintf(s1.a, "%u", rand_get() );
+    char_array_t *val = bhmap_get_ref(dict, s1);
+    if (val != 0)
+      s ++;
+  }
+  g_result = s;
+  
+  bhmap_free(dict);
+}
+#endif
+
+/********************************************************************************************/
+
+const config_func_t table[] = {
+  { 20,   "Array", 100000000, 0, test_array, 0},
+  { 30,  "Rbtree", 1000000, 0, test_rbtree, 0},
+  { 40,    "dict", 1000000, 0, test_dict, 0},
+  //{ 41, "dictBig", 1000000, 0, test_dict_big, 0},
+};
+
+int main(int argc, const char *argv[])
+{
+  test("CMC", numberof(table), table, argc, argv);
+  exit(0);
+}
+

bench/bench-collectionc.c

@@ -250,20 +250,17 @@ static void test_sort(size_t n)
 
 /********************************************************************************************/
 
+const config_func_t table[] = {
+  { 10,    "List", 10000000, 0, test_list, 0},
+  { 20,   "Array", 100000000, 0, test_array, 0},
+  { 30,  "Rbtree", 1000000, 0, test_rbtree, 0},
+  { 40,    "dict", 1000000, 0, test_dict, 0},
+  { 41, "dictBig", 1000000, 0, test_dict_big, 0},
+  { 50,           "Sort",10000000, 0, test_sort, 0},
+};
+
 int main(int argc, const char *argv[])
 {
-  int n = (argc > 1) ? atoi(argv[1]) : 0;
-  if (n == 10)
-    test_function("List   time",10000000, test_list);
-  if (n == 20)
-    test_function("Array  time", 100000000, test_array);
-  if (n == 30)
-    test_function("Rbtree time", 1000000, test_rbtree);
-  if (n == 40)
-    test_function("Dict   time", 1000000, test_dict);
-  if (n == 41)
-    test_function("DictB  time", 1000000, test_dict_big);
-  if (n == 50)
-    test_function("Sort   time", 10000000, test_sort);
+  test("CollectionC", numberof(table), table, argc, argv);
   exit(0);
 }

bench/bench-concurrentqueue.cpp

@@ -6,11 +6,8 @@
 
 #include "concurrentqueue.h"
 
-#include "m-mutex.h"
-#define MULTI_THREAD_MEASURE
 #include "common.h"
 
-
 /********************************************************************************************/
 moodycamel::ConcurrentQueue<unsigned int> g_buff;
 moodycamel::ConcurrentQueue<unsigned long long> g_final;
@@ -51,7 +48,7 @@ static void prod(void *arg)
   }
 }
 
-static void test_buffer(size_t n)
+static void test_queue(size_t n)
 {
   const int cpu_count   = get_cpu_count();
   const int prod_count  = cpu_count/2;
@@ -88,11 +85,12 @@ static void test_buffer(size_t n)
 
 /********************************************************************************************/
 
+const config_func_t table[] = {
+  { 60,    "Queue MPMC", 1000000, 0, test_queue, 0}
+};
+
 int main(int argc, const char *argv[])
 {
-  int n = (argc > 1) ? atoi(argv[1]) : 0;
-  if (n == 60)
-    test_function("Buffer time", 1000000, test_buffer);
+  test("CONCURRENT-QUEUE", numberof(table), table, argc, argv);
   exit(0);
 }
-

bench/bench-densehashmap.cpp

@@ -131,14 +131,14 @@ test_dict_str(size_t  n)
 
 /********************************************************************************************/
 
+const config_func_t table[] = {
+  { 41, "dictBig", 1000000, 0, test_dict_big, 0},
+  { 42,"dict", 1000000, 0, test_dict2, 0},
+  { 43,    "DictStr", 1000000, 0, test_dict_str, 0}
+};
+
 int main(int argc, const char *argv[])
 {
-  int n = (argc > 1) ? atoi(argv[1]) : 0;
-  if (n == 42)
-    test_function("Dict(u)time", 1000000, test_dict2);
-  if (n == 41)
-    test_function("DictB  time", 1000000, test_dict_big);
-  if (n == 43)
-    test_function("DictS(u)  time", 1000000, test_dict_str);
+  test("DENSE-HASPMAP", numberof(table), table, argc, argv);
   exit(0);
 }

bench/bench-emilib.cpp

@@ -0,0 +1,138 @@
+#define NDEBUG
+
+#include <vector>
+#include <list>
+#include <iterator>
+#include <map>
+#include <set>
+#include <unordered_map>
+#include <algorithm>
+#include <string>
+#include <sstream>
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <stdbool.h>
+#include <string.h>
+
+#include "emilib/hash_map.hpp"
+
+using namespace emilib;
+using namespace std;
+
+#include "common.h"
+
+/********************************************************************************************/
+
+static void
+test_dict2(size_t  n)
+{
+  HashMap<unsigned long, unsigned long> dict;
+  for (size_t i = 0; i < n; i++) {
+    dict[rand_get()] = rand_get();
+  }
+  rand_init();
+  unsigned int s = 0;
+  for (size_t i = 0; i < n; i++) {
+    HashMap<unsigned long, unsigned long>::iterator it = dict.find(rand_get());
+    if (it != dict.end())
+      s += it->second;
+  }
+  g_result = s;
+}
+
+static void
+test_dict2_linear(size_t  n)
+{
+  HashMap<unsigned long, unsigned long> dict;
+  for (size_t i = 0; i < n; i++) {
+    dict[i] = rand_get();
+  }
+  rand_init();
+  unsigned int s = 0;
+  for (size_t i = 0; i < n; i++) {
+    HashMap<unsigned long, unsigned long>::iterator it = dict.find(i);
+    if (it != dict.end())
+      s += it->second;
+  }
+  g_result = s;
+}
+
+/********************************************************************************************/
+struct char_array_s {
+  char a[256];
+  char_array_s () { a[0] = 0 ; }
+  char_array_s ( const char_array_s & other) { strcpy(a, other.a); }
+  bool operator==(const char_array_s &other) const { return strcmp(a, other.a) == 0; }
+};
+
+namespace std {
+  template <> struct hash<char_array_s> {
+    std::size_t operator()(const char_array_s &k) const {
+      size_t hash = 0;
+      const char *s = k.a;
+      while (*s) hash = hash * 31421 + (*s++) + 6927;
+      return hash;
+    };
+  };
+}
+
+static void
+test_dict_big(size_t  n)
+{
+  HashMap<char_array_s, char_array_s> dict;
+
+  for (size_t i = 0; i < n; i++) {
+    char_array_s s1, s2;
+    sprintf(s1.a, "%u", rand_get());
+    sprintf(s2.a, "%u", rand_get());
+    dict[s1] = s2;
+  }
+  rand_init();
+  unsigned int s = 0;
+  for (size_t i = 0; i < n; i++) {
+    char_array_s s1;
+    sprintf(s1.a, "%u", rand_get());
+    HashMap<char_array_s, char_array_s>::iterator it = dict.find(s1);
+    if (it != dict.end())
+      s ++;
+  }
+  g_result = s;
+}
+
+/********************************************************************************************/
+static void
+test_dict_str(size_t  n)
+{
+  HashMap<string, string> dict;
+
+  for (size_t i = 0; i < n; i++) {
+    string s1 = static_cast<ostringstream*>( &(ostringstream() << rand_get()) )->str();
+    string s2 = static_cast<ostringstream*>( &(ostringstream() << rand_get()) )->str();
+    dict[s1] = s2;
+  }
+  rand_init();
+  unsigned int s = 0;
+  for (size_t i = 0; i < n; i++) {
+    string s1 = static_cast<ostringstream*>( &(ostringstream() << rand_get()) )->str();
+    HashMap<string, string>::iterator it = dict.find(s1);
+    if (it != dict.end())
+      s ++;
+  }
+  g_result = s;
+}
+
+/********************************************************************************************/
+
+const config_func_t table[] = {
+  { 41, "dictBig", 1000000, 0, test_dict_big, 0},
+  { 42,"dict", 1000000, 0, test_dict2, 0},
+  { 43,    "DictStr", 1000000, 0, test_dict_str, 0},
+  { 46,    "DictLinear", 1000000, 0, test_dict2_linear, 0}
+};
+
+int main(int argc, const char *argv[])
+{
+  test("EMILIB", numberof(table), table, argc, argv);
+  exit(0);
+}

bench/bench-find-sort.cpp

@@ -0,0 +1,101 @@
+// program to find longest contiguous subsequence
+// based on https://www.geeksforgeeks.org/longest-consecutive-subsequence/
+#include <iostream>
+#include <unordered_set>
+
+using namespace std; 
+  
+// Returns length of the longest contiguous subsequence 
+int cpp_find_longest(int arr[], int n) 
+{ 
+  unordered_set<int> S; 
+  int ans = 0; 
+  
+  // Hash all the array elements 
+  for (int i = 0; i < n; i++) 
+    S.insert(arr[i]); 
+  
+  // check each possible sequence from 
+  // the start then update optimal length 
+  for (int i = 0; i < n; i++) { 
+    // if current element is the starting 
+    // element of a sequence 
+    if (S.find(arr[i] - 1) == S.end()) { 
+      // Then check for next elements 
+      // in the sequence 
+      int j = arr[i] + 1;
+      while (S.find(j) != S.end()) 
+        j++; 
+      
+      // update  optimal length if 
+      // this length is more 
+      ans = max(ans, j - arr[i]); 
+    } 
+  } 
+  return ans; 
+} 
+
+#include "m-dict.h"
+
+static inline bool oor_equal_p(int a, unsigned char c) { return a == ((c == 0) ? INT_MIN : INT_MAX); }
+static inline void oor_set(int *a, unsigned char c) { *a = ((c == 0) ? INT_MIN : INT_MAX); }
+
+DICT_OASET_DEF(dict_int, int, M_OPEXTEND(M_DEFAULT_OPLIST, OOR_EQUAL(oor_equal_p), OOR_SET(oor_set M_IPTR)))
+
+// Returns length of the longest contiguous subsequence 
+int mlib_find_longest(int arr[], int n) 
+{ 
+  dict_int_t S;
+  int ans = 0; 
+
+  dict_int_init(S);
+  
+  // Hash all the array elements 
+  for (int i = 0; i < n; i++) 
+    dict_int_push(S, arr[i]);
+  
+  // check each possible sequence from 
+  // the start then update optimal length 
+  for (int i = 0; i < n; i++) { 
+    // if current element is the starting 
+    // element of a sequence
+    int *p = dict_int_get(S, arr[i]-1);
+    if (p == NULL) {
+      // Then check for next elements 
+      // in the sequence 
+      int j = arr[i] + 1; 
+      while (dict_int_get(S, j) != NULL)
+        j++; 
+      
+      // update  optimal length if 
+      // this length is more 
+      ans = M_MAX(ans, j - arr[i]); 
+    } 
+  }
+
+  dict_int_clear(S);
+  return ans; 
+} 
+
+#include "common.h"
+
+int main(int argc, const char *argv[]) 
+{
+  int n = argc == 1 ? 10000 : atoi(argv[1]);
+  int *arr = (int*) malloc(n * sizeof(int));
+  for(int i = 0; i < n; i++)
+    arr[i] = rand_get();
+  
+  unsigned long long t0 = cputime();
+  cout << "Length of the Longest contiguous subsequence is "
+       << cpp_find_longest(arr, n) << endl; 
+  
+  unsigned long long t1 = cputime();
+  
+  cout << "Length of the Longest contiguous subsequence is "
+       << mlib_find_longest(arr, n) << endl;
+  unsigned long long t2 = cputime();
+  
+  cout << "Time C++: " << (t1-t0) << " Time M*LIB: " << (t2-t1) << endl;
+  return 0; 
+}

bench/bench-flathashmap.cpp

@@ -42,6 +42,23 @@ test_dict2(size_t  n)
   g_result = s;
 }
 
+static void
+test_dict2_linear(size_t  n)
+{
+  flat_hash_map<unsigned long, unsigned long> dict;
+  for (size_t i = 0; i < n; i++) {
+    dict[i] = rand_get();
+  }
+  rand_init();
+  unsigned int s = 0;
+  for (size_t i = 0; i < n; i++) {
+    flat_hash_map<unsigned long, unsigned long>::iterator it = dict.find(i);
+    if (it != dict.end())
+      s += it->second;
+  }
+  g_result = s;
+}
+
 /********************************************************************************************/
 struct char_array_s {
   char a[256];
@@ -108,14 +125,15 @@ test_dict_str(size_t  n)
 
 /********************************************************************************************/
 
+const config_func_t table[] = {
+  { 41, "dictBig", 1000000, 0, test_dict_big, 0},
+  { 42,"dict", 1000000, 0, test_dict2, 0},
+  { 43,    "DictStr", 1000000, 0, test_dict_str, 0},
+  { 46,    "DictLinear", 1000000, 0, test_dict2_linear, 0}
+};
+
 int main(int argc, const char *argv[])
 {
-  int n = (argc > 1) ? atoi(argv[1]) : 0;
-  if (n == 42)
-    test_function("Dict(u)time", 1000000, test_dict2);
-  if (n == 41)
-    test_function("DictB  time", 1000000, test_dict_big);
-  if (n == 43)
-    test_function("DictS(u)  time", 1000000, test_dict_str);
+  test("FLAT-HASPMAP", numberof(table), table, argc, argv);
   exit(0);
 }

bench/bench-glib.c

@@ -186,20 +186,17 @@ static void test_sort(size_t n)
 
 /********************************************************************************************/
 
+const config_func_t table[] = {
+  { 10,    "List", 10000000, 0, test_list, 0},
+  { 20,   "Array", 100000000, 0, test_array, 0},
+  { 30,  "Rbtree", 1000000, 0, test_rbtree, 0},
+  { 40,    "dict", 1000000, 0, test_dict, 0},
+  { 41, "dictBig", 1000000, 0, test_dict_big, 0},
+  { 50,           "Sort",10000000, 0, test_sort, 0},
+};
+
 int main(int argc, const char *argv[])
 {
-  int n = (argc > 1) ? atoi(argv[1]) : 0;
-  if (n == 10)
-    test_function("List   time",10000000, test_list);
-  if (n == 20)
-    test_function("Array  time", 100000000, test_array);
-  if (n == 30)
-    test_function("Rbtree time", 1000000, test_rbtree);
-  if (n == 40)
-    test_function("Dict   time", 1000000, test_dict);
-  if (n == 41)
-    test_function("DictB  time", 1000000, test_dict_big);
-  if (n == 50)
-    test_function("Sort   time", 10000000, test_sort);
+  test("GLIB", numberof(table), table, argc, argv);
   exit(0);
 }

bench/bench-hopscotchmap.cpp

@@ -15,7 +15,7 @@
 #include <stdbool.h>
 #include <string.h>
 
-#include "src/hopscotch_map.h"
+#include "hopscotch_map.h"
 
 using namespace tsl;
 using namespace std;
@@ -109,14 +109,15 @@ test_dict_str(size_t  n)
 
 /********************************************************************************************/
 
+const config_func_t table[] = {
+  { 41, "dictBig", 1000000, 0, test_dict_big, 0},
+  { 42,"dict", 1000000, 0, test_dict2, 0},
+  { 43,    "DictStr", 1000000, 0, test_dict_str, 0}
+};
+
 int main(int argc, const char *argv[])
 {
-  int n = (argc > 1) ? atoi(argv[1]) : 0;
-  if (n == 42)
-    test_function("Dict(u)time", 1000000, test_dict2);
-  if (n == 41)
-    test_function("DictB  time", 1000000, test_dict_big);
-  if (n == 43)
-    test_function("DictS(u)  time", 1000000, test_dict_str);
+  test("HOPSCOTCHMAP", numberof(table), table, argc, argv);
   exit(0);
+
 }

bench/bench-klib.c

@@ -185,21 +185,18 @@ static void test_sort(size_t n)
 
 /********************************************************************************************/
 
+const config_func_t table[] = {
+  { 10,    "List", 10000000, 0, test_list, 0},
+  { 20,   "Array", 100000000, 0, test_array, 0},
+  { 30,  "Rbtree", 1000000, 0, test_rbtree, 0},
+  { 40,    "dict", 1000000, 0, test_dict, 0},
+  { 41, "dictBig", 1000000, 0, test_dict_big, 0},
+  { 50,           "Sort",10000000, 0, test_sort, 0},
+};
+
 int main(int argc, const char *argv[])
 {
-  int n = (argc > 1) ? atoi(argv[1]): 0;
-  if (n == 10)
-    test_function("List   time",10000000, test_list);
-  if (n == 20)
-    test_function("Array  time", 100000000, test_array);
-  if (n == 30)
-    test_function("B-tree time", 1000000, test_rbtree);
-  if (n == 40)
-    test_function("DictOA time", 1000000, test_dict);
-  if (n == 41)
-    test_function("DictB  time", 1000000, test_dict_big);
-  if (n == 50)
-    test_function("Sort   time", 10000000, test_sort);
+  test("KLIB", numberof(table), table, argc, argv);
   exit(0);
 }
 

bench/bench-libdynamic.c

@@ -7,6 +7,9 @@
 #include <stdint.h>
 #include <unistd.h>
 
+// Needed due to compilation error in pool.h
+#include <pthread.h>
+
 #include "dynamic.h"
 
 #include "common.h"
@@ -45,6 +48,9 @@ static size_t hash_func (void *a)
 static int equal_func(void *a, void *b)
 {
   const unsigned long *pa = a;
+  if (b == NULL) {
+    return *pa == -1U;      
+  }
   const unsigned long *pb = b;
   return *pa == *pb;
 }
@@ -52,8 +58,12 @@ static int equal_func(void *a, void *b)
 static void set_func(void *a, void *b)
 {
   unsigned long *pa = a;
-  const unsigned long *pb = b;
-  *pa = *pb;
+  if (b == NULL) {
+    *pa = -1U;
+  } else {
+    const unsigned long *pb = b;
+    *pa = *pb;
+  }
 }
 
 typedef struct map_element map_element;
@@ -67,10 +77,10 @@ static void
 test_dict(size_t  n)
 {
   map dict;
-  map_construct(&dict, sizeof(map_element), (map_element[]) {{.key = -1}}, set_func);
+  map_construct(&dict, sizeof(map_element), set_func);
 
   for (size_t i = 0; i < n; i++) {
-    map_insert(&dict, (map_element[]) {{.key = rand_get(), .value = rand_get()}}, hash_func, equal_func, set_func, NULL);
+    map_insert(&dict, (map_element[]) {{.key = rand_get(), .value = rand_get()}}, hash_func, set_func, equal_func, NULL);
   }    
   rand_init();
   unsigned int s = 0;
@@ -90,6 +100,8 @@ typedef char char_array_t[256];
 static int char_equal (void *a, void *b)
 {
   const char_array_t *pa = (const char_array_t *)a;
+  if (b == NULL)
+    return strcmp(*pa, "") == 0;
   const char_array_t *pb = (const char_array_t *)b;
   return strcmp(*pa,*pb)==0;
 }
@@ -103,8 +115,12 @@ static size_t char_hash(void *a)
 static void char_set(void *a, void *b)
 {
   char_array_t *pa = (char_array_t *)a;
-  const char_array_t *pb = (const char_array_t *)b;
-  strcpy(*pa,*pb);
+  if (b == NULL) {
+    strcpy(*pa, "");
+  } else {
+    const char_array_t *pb = (const char_array_t *)b;
+    strcpy(*pa,*pb);
+  }
 }
 
 typedef struct big_map_element big_map_element;
@@ -118,16 +134,13 @@ static void
 test_dict_big(size_t  n)
 {
   map dict;
-  big_map_element empty;
-  strcpy(empty.key, "");
-  strcpy(empty.value, "");
-  map_construct(&dict, sizeof(big_map_element), &empty, char_set);
+  map_construct(&dict, sizeof(big_map_element), char_set);
   
   for (size_t i = 0; i < n; i++) {
     big_map_element el;
     sprintf(el.key, "%u", rand_get());
     sprintf(el.value, "%u", rand_get());
-    map_insert(&dict, &el, char_hash, char_equal, char_set, NULL);
+    map_insert(&dict, &el, char_hash, char_set, char_equal, NULL);
   }
   rand_init();
   unsigned int s = 0;
@@ -144,14 +157,14 @@ test_dict_big(size_t  n)
 
 /********************************************************************************************/
 
+const config_func_t table[] = {
+  { 20,   "Array", 100000000, 0, test_array, 0},
+  { 40,    "dict", 1000000, 0, test_dict, 0},
+  { 41, "dictBig", 1000000, 0, test_dict_big, 0},
+};
+
 int main(int argc, const char *argv[])
 {
-  int n = (argc > 1) ? atoi(argv[1]) : 0;
-  if (n == 20)
-    test_function("Array  time", 100000000, test_array);
-  if (n == 40)
-    test_function("Dict   time", 1000000, test_dict);
-  if (n == 41)
-    test_function("Dict B time", 1000000, test_dict_big);
+  test("LIBDYNAMIC", numberof(table), table, argc, argv);
   exit(0);
  }

bench/bench-liblfds.c

@@ -6,11 +6,8 @@
 
 #include "liblfds711.h"
 
-#include "m-mutex.h"
-#define MULTI_THREAD_MEASURE
 #include "common.h"
 
-
 /********************************************************************************************/
 
 struct lfds711_queue_bmm_state g_buff;
@@ -23,12 +20,9 @@ static void final(void *arg)
   unsigned long long j, s = 0;
   LFDS711_MISC_MAKE_VALID_ON_CURRENT_LOGICAL_CORE_INITS_COMPLETED_BEFORE_NOW_ON_ANY_OTHER_LOGICAL_CORE;
   for(int i = 0; i < n;i++) {
-    int rv;
-    do {
-      void *p;
-      rv = lfds711_queue_bmm_dequeue(&g_final, &p, NULL);
-      j = (uintptr_t)p;
-    } while (rv == 0);
+    void *p;
+    while (0 == lfds711_queue_bmm_dequeue(&g_final, &p, NULL)) {  m_thread_yield(); }
+    j = (uintptr_t)p;
     s += j;
   }
   g_result = s;
@@ -42,18 +36,12 @@ static void conso(void *arg)
   unsigned long long s = 0;
   LFDS711_MISC_MAKE_VALID_ON_CURRENT_LOGICAL_CORE_INITS_COMPLETED_BEFORE_NOW_ON_ANY_OTHER_LOGICAL_CORE;
   for(int i = 0; i < n;i++) {
-    int rv;
-    do {
-      void *p; 
-      rv = lfds711_queue_bmm_dequeue(&g_buff, &p, NULL);
-      j = (uintptr_t) p;
-    } while (rv == 0);
+    void *p;
+    while (0 == lfds711_queue_bmm_dequeue(&g_buff, &p, NULL)) {  m_thread_yield(); }
+    j = (uintptr_t) p;
     s += j;
   }
-  int rv;
-  do {
-    rv = lfds711_queue_bmm_enqueue(&g_final, (void*)(uintptr_t)s, NULL);
-  } while (rv == 0); 
+  while (0 == lfds711_queue_bmm_enqueue(&g_final, (void*)(uintptr_t)s, NULL)) {  m_thread_yield(); }
 }
 
 static void prod(void *arg)
@@ -63,15 +51,12 @@ static void prod(void *arg)
   size_t r = n;
   LFDS711_MISC_MAKE_VALID_ON_CURRENT_LOGICAL_CORE_INITS_COMPLETED_BEFORE_NOW_ON_ANY_OTHER_LOGICAL_CORE;
   for(unsigned int i = 0; i < n;i++) {
-    int rv;
-    do {
-      rv = lfds711_queue_bmm_enqueue(&g_buff, (void*)(uintptr_t)r, NULL);
-    } while (rv == 0);
+    while (0 == lfds711_queue_bmm_enqueue(&g_buff, (void*)(uintptr_t)r, NULL)) {  m_thread_yield(); }
     r = r * 31421U + 6927U;
   }
 }
 
-static void test_buffer(size_t n)
+static void test_queue(size_t n)
 {
   const int cpu_count   = get_cpu_count();
   const int prod_count  = cpu_count/2;
@@ -120,11 +105,12 @@ static void test_buffer(size_t n)
 
 /********************************************************************************************/
 
+const config_func_t table[] = {
+  { 60,    "Queue MPMC", 1000000, 0, test_queue, 0}
+};
+
 int main(int argc, const char *argv[])
 {
-  int n = (argc > 1) ? atoi(argv[1]) : 0;
-  if (n == 60)
-    test_function("Buffer time", 1000000, test_buffer);
+  test("LIBLFDS", numberof(table), table, argc, argv);
   exit(0);
 }
-

bench/bench-libsrt.c

@@ -14,8 +14,8 @@
 
 static void test_array(size_t n)
 {
-  sv_t *a1 = sv_alloc ( sizeof (unsigned int), 16, NULL);
-  sv_t *a2 = sv_alloc ( sizeof (unsigned int), 16, NULL);
+  srt_vector *a1 = sv_alloc ( sizeof (unsigned int), 16, NULL);
+  srt_vector *a2 = sv_alloc ( sizeof (unsigned int), 16, NULL);
 
   for(size_t i = 0; i < n; i++) {
     unsigned int value = rand_get();
@@ -48,7 +48,7 @@ static int cmp_float (const void *a, const void *b)
 
 static void test_sort(size_t n)
 {
-  sv_t *a1 = sv_alloc(sizeof(float), 16, cmp_float);
+  srt_vector *a1 = sv_alloc(sizeof(float), 16, cmp_float);
   for(size_t i = 0; i < n; i++) {
     unsigned int value = rand_get();
     sv_push(&a1, &value );
@@ -60,13 +60,15 @@ static void test_sort(size_t n)
 
 /********************************************************************************************/
 
+
+const config_func_t table[] = {
+  { 20,   "Array", 100000000, 0, test_array, 0},
+  { 50,    "sort", 10000000, 0, test_sort, 0}
+};
+
 int main(int argc, const char *argv[])
 {
-  int n = (argc > 1) ? atoi(argv[1]) : 0;
-  if (n == 20)
-    test_function("Array  time", 100000000, test_array);
-  if (n == 50)
-    test_function("Sort   time", 10000000, test_sort);
+  test("LIBSRT", numberof(table), table, argc, argv);
   exit(0);
 }
 

bench/bench-mlib.c

@@ -8,6 +8,7 @@
 #include "m-list.h"
 #include "m-rbtree.h"
 #include "m-bptree.h"
+#include "m-deque.h"
 #include "m-dict.h"
 #include "m-algo.h"
 #include "m-mempool.h"
@@ -16,6 +17,9 @@
 #include "m-mutex.h"
 #include "m-deque.h"
 #include "m-concurrent.h"
+#include "m-tuple.h"
+#include "m-serial-bin.h"
+#include "m-serial-json.h"
 
 #include "common.h"
 
@@ -40,6 +44,30 @@ static void test_array(size_t n)
 
 /********************************************************************************************/
 
+DEQUE_DEF(deque_uint, unsigned int)
+
+static void test_deque(size_t n)
+{
+  M_LET(a1, a2, DEQUE_OPLIST(deque_uint)) {
+    for(size_t i = 0; i < n; i++) {
+      deque_uint_push_back(a1, rand_get() );
+      deque_uint_push_back(a2, rand_get() );
+    }
+    unsigned int s = 0;
+    deque_uint_it_t it1, it2;
+    deque_uint_it(it1, a1);
+    deque_uint_it(it2, a2);
+    while (!deque_uint_end_p(it1)) {
+      s += *deque_uint_cref(it1 ) * *deque_uint_cref(it2 );
+      deque_uint_next(it1);
+      deque_uint_next(it2);
+    }
+    g_result = s;
+  }
+}
+
+/********************************************************************************************/
+
 // Two benched mode: with or without mempool
 #ifdef USE_MEMPOOL
 LIST_DEF(list_uint, unsigned int, (MEMPOOL( list_mpool), MEMPOOL_LINKAGE(static)))
@@ -220,14 +248,36 @@ test_dict_oa(size_t  n)
   }
 }
 
-/********************************************************************************************/
+static void
+test_dict_oa_linear(size_t  n)
+{
+  M_LET(dict, DICT_OPLIST(dict_oa_ulong)) {
+    for (size_t i = 0; i < n; i++) {
+      dict_oa_ulong_set_at(dict, i, rand_get() );
+    }
+    rand_init();
+    unsigned int s = 0;
+    for (size_t i = 0; i < n; i++) {
+      unsigned long *p = dict_oa_ulong_get(dict, i);
+      if (p)
+        s += *p;
+    }
+    g_result = s;
+  }
+}
 
-typedef char char_array_t[256];
+/********************************************************************************************/
+#ifndef CHAR_ARRAY_SIZE
+#define CHAR_ARRAY_SIZE 256
+#endif
+typedef char char_array_t[CHAR_ARRAY_SIZE];
 static void char_init (char_array_t a) { a[0] = 0; }
 static void char_set (char_array_t a, const char_array_t b) { strcpy(a, b); }
 static bool char_equal_p (const char_array_t a, const char_array_t b) { return strcmp(a,b)==0; }
 static size_t char_hash(const char_array_t a) { return m_core_hash (a, strlen(a)); }
-#define M_OPL_char_array_t() (INIT(char_init), INIT_SET(char_set), SET(char_set), CLEAR(char_init), HASH(char_hash), EQUAL(char_equal_p))
+static bool char_oor_equal_p(const char_array_t a, unsigned char n) { return a[0] == 1+n; }
+static void char_oor_set(char_array_t a, unsigned char n) { a[0] = 1+n; }
+#define M_OPL_char_array_t() (INIT(char_init), INIT_SET(char_set), SET(char_set), CLEAR(char_init), HASH(char_hash), EQUAL(char_equal_p), OOR_EQUAL(char_oor_equal_p), OOR_SET(char_oor_set))
 
 #ifdef USE_MEMPOOL
 DICT_STOREHASH_DEF2(dict_char, char_array_t, M_OPEXTEND(M_OPL_char_array_t(),MEMPOOL(dict_mpool2), MEMPOOL_LINKAGE(static)), char_array_t, M_OPL_char_array_t())
@@ -235,6 +285,7 @@ DICT_STOREHASH_DEF2(dict_char, char_array_t, M_OPEXTEND(M_OPL_char_array_t(),MEM
 DICT_STOREHASH_DEF2(dict_char, char_array_t, M_OPL_char_array_t(), char_array_t, M_OPL_char_array_t())
 #endif
 
+
 static void
 test_dict_big(size_t  n)
 {
@@ -264,6 +315,31 @@ test_dict_big(size_t  n)
 #endif
 }
 
+DICT_OA_DEF2(dict_oa_char, char_array_t, char_array_t)
+
+static void
+test_dict_oa_big(size_t  n)
+{
+  M_LET(dict, DICT_OPLIST(dict_oa_char)) {
+    for (size_t i = 0; i < n; i++) {
+      char_array_t s1, s2;
+      sprintf(s1, "%u", rand_get());
+      sprintf(s2, "%u", rand_get());
+      dict_oa_char_set_at(dict, s1, s2);
+    }
+    rand_init();
+    unsigned int s = 0;
+    for (size_t i = 0; i < n; i++) {
+      char_array_t s1;
+      sprintf(s1, "%u", rand_get());
+      char_array_t *p = dict_oa_char_get(dict, s1);
+      if (p)
+        s ++;
+    }
+    g_result = s;
+  }
+}
+
 /********************************************************************************************/
 
 #ifdef USE_MEMPOOL
@@ -671,7 +747,6 @@ static void test_queue_single_bulk(size_t n)
 
 /********************************************************************************************/
 
-DEQUE_DEF(deque_uint, unsigned int)
 CONCURRENT_DEF(cdeque_uint, deque_uint_t, M_OPEXTEND(DEQUE_OPLIST(deque_uint, M_DEFAULT_OPLIST), PUSH(deque_uint_push_front)))
 
 DEQUE_DEF(deque_ull, unsigned long long)
@@ -791,59 +866,225 @@ static void test_core_hash(size_t n)
 
 /********************************************************************************************/
 
+ARRAY_DEF(vector_string, string_t)
+
+vector_string_t vstring;
+vector_string_t vstring2;
+
+static void
+bench_vector_string_init(size_t n)
+{
+    vector_string_init(vstring);
+    for(size_t i = 0; i < n; i++)
+    {
+        M_LET( (s, "%zu", i, i, i, i), string_t) {
+            vector_string_push_back(vstring, s);
+        }
+    }
+    vector_string_init(vstring2);
+}
+
+static void
+bench_vector_string_init_big(size_t n)
+{
+    vector_string_init(vstring);
+    for(size_t i = 0; i < n; i++)
+    {
+        M_LET( (s, "%zu%zu%zu%zu%zu%zu", i, i, i, i, i, i), string_t) {
+            vector_string_push_back(vstring, s);
+        }
+    }
+    vector_string_init(vstring2);
+}
+
+static void
+bench_vector_string_bin_run(size_t n)
+{
+    if (vector_string_size(vstring) != n) {
+        printf("Size are different!\n");
+        abort();
+    }
+
+    FILE *f = fopen("tmp-serial.dat", "wb");
+    if (!f) abort();
+    M_LET( (serial, f), m_serial_bin_write_t) {
+        vector_string_out_serial(serial, vstring);
+    }
+    fclose(f);
+    
+    f = fopen("tmp-serial.dat", "rb");
+    if (!f) abort();
+    M_LET( (serial, f), m_serial_bin_read_t) {
+        vector_string_in_serial(vstring2, serial);
+    }
+    fclose(f);
+
+    if (vector_string_size(vstring2) != n) {
+        printf("Size are different!\n");
+        abort();
+    }
+}
+
+static void
+bench_vector_string_json_run(size_t n)
+{
+    if (vector_string_size(vstring) != n) {
+        printf("Size are different!\n");
+        abort();
+    }
+
+    FILE *f = fopen("tmp-serial.json", "wt");
+    if (!f) abort();
+    M_LET( (serial, f), m_serial_json_write_t) {
+        vector_string_out_serial(serial, vstring);
+    }
+    fclose(f);
+    
+    f = fopen("tmp-serial.json", "rt");
+    if (!f) abort();
+    M_LET( (serial, f), m_serial_json_read_t) {
+        vector_string_in_serial(vstring2, serial);
+    }
+    fclose(f);
+
+    if (vector_string_size(vstring2) != n) {
+        printf("Size are different!\n");
+        abort();
+    }
+}
+
+static void
+bench_vector_string_clear(void)
+{
+    if (!vector_string_equal_p(vstring, vstring2)) {
+        printf("Array are different!\n");
+        abort();
+    }
+    vector_string_clear(vstring);
+    vector_string_clear(vstring2);
+}
+
+/********************************************************************************************/
+
+ARRAY_DEF(vector_ulong, unsigned long)
+
+vector_ulong_t vulong;
+vector_ulong_t vulong2;
+
+static void
+bench_vector_ulong_init(size_t n)
+{
+    vector_ulong_init(vulong);
+    for(size_t i = 0; i < n; i++)
+    {
+      vector_ulong_push_back(vulong, i*i);
+    }
+    vector_ulong_init(vulong2);
+}
+
+static void
+bench_vector_ulong_bin_run(size_t n)
+{
+    if (vector_ulong_size(vulong) != n) {
+        printf("Size are different!\n");
+        abort();
+    }
+
+    FILE *f = fopen("tmp-serial.dat", "wb");
+    if (!f) abort();
+    M_LET( (serial, f), m_serial_bin_write_t) {
+        vector_ulong_out_serial(serial, vulong);
+    }
+    fclose(f);
+    
+    f = fopen("tmp-serial.dat", "rb");
+    if (!f) abort();
+    M_LET( (serial, f), m_serial_bin_read_t) {
+        vector_ulong_in_serial(vulong2, serial);
+    }
+    fclose(f);
+
+    if (vector_ulong_size(vulong2) != n) {
+        printf("Size are different!\n");
+        abort();
+    }
+}
+
+static void
+bench_vector_ulong_json_run(size_t n)
+{
+    if (vector_ulong_size(vulong) != n) {
+        printf("Size are different!\n");
+        abort();
+    }
+
+    FILE *f = fopen("tmp-serial.json", "wt");
+    if (!f) abort();
+    M_LET( (serial, f), m_serial_json_write_t) {
+        vector_ulong_out_serial(serial, vulong);
+    }
+    fclose(f);
+    
+    f = fopen("tmp-serial.json", "rt");
+    if (!f) abort();
+    M_LET( (serial, f), m_serial_json_read_t) {
+        vector_ulong_in_serial(vulong2, serial);
+    }
+    fclose(f);
+
+    if (vector_ulong_size(vulong2) != n) {
+        printf("Size are different!\n");
+        abort();
+    }
+}
+
+static void
+bench_vector_ulong_clear(void)
+{
+    if (!vector_ulong_equal_p(vulong, vulong2)) {
+        printf("Array are different!\n");
+        abort();
+    }
+    vector_ulong_clear(vulong);
+    vector_ulong_clear(vulong2);
+}
+
+/********************************************************************************************/
+
+const config_func_t table[] = {
+  { 10,    "List", 10000000, 0, test_list, 0},
+  { 11,  "DPList", 10000000, 0, test_dlist, 0},
+  { 20,   "Array", 100000000, 0, test_array, 0},
+  { 21,   "Deque", 100000000, 0, test_deque, 0},
+  { 30,  "Rbtree", 1000000, 0, test_rbtree, 0},
+  { 31,  "B+tree", 1000000, 0, test_bptree, 0},
+  { 40,    "dict", 1000000, 0, test_dict, 0},
+  { 41, "dictBig", 1000000, 0, test_dict_big, 0},
+  { 42,"dict(OA)", 1000000, 0, test_dict_oa, 0},
+  { 43,"DictStr", 1000000, 0, test_dict_str, 0},
+  { 46, "dictLinear(OA)", 1000000, 0, test_dict_oa_linear, 0},
+  { 47,    "dictBig(OA)", 1000000, 0, test_dict_oa_big, 0},
+  { 50,           "Sort",10000000, 0, test_sort, 0},
+  { 51,    "Stable Sort",10000000, 0, test_stable_sort, 0},
+  { 60,"Buffer",  1000000, 0, test_buffer, 0},
+  { 61,"Queue MPMC",  1000000, 0, test_queue, 0},
+  { 62,"Buffer(P=2)",  SIZE_LIMIT+1000000, 0, test_buffer, 0},
+  { 63,"Queue MPMC (P=2)",  SIZE_LIMIT+1000000, 0, test_queue, 0},
+  { 64,"Queue SPSC (P=2)",  1000000, 0, test_queue_single, 0},
+  { 65,"Queue Concurrent",  1000000, 0, test_queue_concurrent, 0},
+  { 66,"Queue SPSC(Bulk)",  1000000, 0, test_queue_single_bulk, 0},
+  { 70,"M_HASH",  100000000, test_hash_prepare, test_hash, test_hash_final},
+  { 71,"Core Hash", 100000000, test_hash_prepare, test_core_hash, test_hash_final},
+  {100,    "serial-bin STR", 10000000, bench_vector_string_init, bench_vector_string_bin_run, bench_vector_string_clear},
+  {101,    "serial-bin STR.big", 10000000, bench_vector_string_init_big, bench_vector_string_bin_run, bench_vector_string_clear},
+  {102,    "serial-bin INT", 10000000, bench_vector_ulong_init, bench_vector_ulong_bin_run, bench_vector_ulong_clear},
+  {110,    "serial-json STR", 10000000, bench_vector_string_init, bench_vector_string_json_run, bench_vector_string_clear},
+  {111,    "serial-json STR.big", 10000000, bench_vector_string_init_big, bench_vector_string_json_run, bench_vector_string_clear},
+  {112,    "serial-json INT", 10000000, bench_vector_ulong_init, bench_vector_ulong_json_run, bench_vector_ulong_clear}
+};
 
 int main(int argc, const char *argv[])
 {
-  int n = (argc > 1) ? atoi(argv[1]) : 0;
-  if (n == 10)
-    test_function("List   time",10000000, test_list);
-  if (n == 11)
-    test_function("DPList time",10000000, test_dlist);
-  if (n == 20)
-    test_function("Array  time", 100000000, test_array);
-  if (n == 30)
-    test_function("Rbtree time", 1000000, test_rbtree);
-  if (n == 31)
-    test_function("B+tree time", 1000000, test_bptree);
-  if (n == 40)
-    test_function("Dict   time", 1000000, test_dict);
-  if (n == 42)
-    test_function("DictOA time", 1000000, test_dict_oa);
-  if (n == 41)
-    test_function("DictB  time", 1000000, test_dict_big);
-  if (n == 43)
-    test_function("DictS  time", 1000000, test_dict_str);
-  if (n == 50)
-    test_function("Sort   time", 10000000, test_sort);
-  if (n == 51)
-    test_function("Stable Sort time", 10000000, test_stable_sort);
-  if (n == 60)
-    test_function("Buffer time", 1000000, test_buffer);
-  if (n == 61)
-    test_function("Queue MPMC time", 1000000, test_queue);
-  if (n == 62)
-    test_function("Buffer time (P2)", SIZE_LIMIT+1000000, test_buffer);
-  if (n == 63)
-    test_function("Queue MPMC time (P2)", SIZE_LIMIT+1000000, test_queue);
-  if (n == 64)
-    test_function("Queue SPSC time", 1000000, test_queue_single);
-  if (n == 65)
-    test_function("Queue CONCURRENT time", 1000000, test_queue_concurrent);
-  if (n == 66)
-    test_function("Queue SPSC BULK time", 1000000, test_queue_single_bulk);
-  if (n == 70) {
-    n = (argc > 2) ? atoi(argv[2]) : 100000000;
-    test_hash_prepare(n);
-    test_function("M_HASH time", n, test_hash);
-    test_hash_final();
-  }
-  if (n == 71) {
-    n = (argc > 2) ? atoi(argv[2]) : 100000000;
-    test_hash_prepare(n);
-    test_function("CORE_HASH time", n, test_core_hash);
-    test_hash_final();
-  }
-  
+  test("M-LIB", numberof(table), table, argc, argv);
   exit(0);
 }
-

bench/bench-nedtries.c

@@ -87,15 +87,13 @@ test_dict_noalloc(size_t  n)
 
 /********************************************************************************************/
 
+const config_func_t table[] = {
+  { 40,    "dict", 1000000, 0, test_dict, 0},
+  { 45, "dict(noalloc)", 1000000, 0, test_dict_noalloc, 0}
+};
 
 int main(int argc, const char *argv[])
 {
-  int n = (argc > 1) ? atoi(argv[1]) : 0;
-  if (n == 40)
-    test_function("Dict   time", 1000000, test_dict);
-  if (n == 45)
-    test_function("Dict No Alloc time", 1000000, test_dict_noalloc);
-  
+  test("NEDTRIES", numberof(table), table, argc, argv);
   exit(0);
 }
-

bench/bench-qlibc.c

@@ -98,14 +98,16 @@ static void test_rbtree(size_t n)
 
 /* qlibc hash functions only accept a string as the key */
 
+/********************************************************************************************/
+
+const config_func_t table[] = {
+  { 10,    "List", 10000000, 0, test_list, 0},
+  { 20,   "Array", 100000000, 0, test_array, 0},
+  { 30,  "Rbtree", 1000000, 0, test_rbtree, 0}
+};
+
 int main(int argc, const char *argv[])
 {
-  int n = (argc > 1) ? atoi(argv[1]) : 0;
-  if (n == 20)
-    test_function("Array  time", 100000000, test_array);
-  if (n == 10)
-    test_function("List   time",10000000, test_list);
-  if (n == 30)
-    test_function("Rbtree time", 1000000, test_rbtree);
+  test("QLIBC", numberof(table), table, argc, argv);
   exit(0);
 }

bench/bench-qt.cpp

@@ -162,22 +162,18 @@ static void test_sort(size_t n)
 
 /********************************************************************************************/
 
+const config_func_t table[] = {
+  { 10,    "List", 10000000, 0, test_list, 0},
+  { 20,   "Array", 100000000, 0, test_array, 0},
+  { 30,  "Rbtree", 1000000, 0, test_rbtree, 0},
+  { 40,    "dict(m)", 1000000, 0, test_dict1, 0},
+  { 41, "dictBig", 1000000, 0, test_dict_big, 0},
+  { 42,"dict(u)", 1000000, 0, test_dict2, 0},
+  { 50,           "Sort",10000000, 0, test_sort, 0}
+};
+
 int main(int argc, const char *argv[])
 {
-  int n = (argc > 1) ? atoi(argv[1]) : 0;
-  if (n == 10)
-    test_function("List   time",10000000, test_list);
-  if (n == 20)
-    test_function("Array  time", 100000000, test_array);
-  if (n == 30)
-     test_function("Rbtree time", 1000000, test_rbtree);
-  if (n == 40)
-    test_function("Dict(m)time", 1000000, test_dict1);
-  if (n == 42)
-    test_function("Dict(u)time", 1000000, test_dict2);
-  if (n == 41)
-    test_function("DictB  time", 1000000, test_dict_big);
-  if (n == 50)
-    test_function("Sort   time", 10000000, test_sort);
+  test("QT", numberof(table), table, argc, argv);
   exit(0);
 }

bench/bench-rapidjson.cpp

@@ -0,0 +1,185 @@
+#define NDEBUG
+#define RAPIDJSON_HAS_STDSTRING 1
+
+#include "rapidjson/reader.h"
+#include "rapidjson/document.h"
+#include "rapidjson/prettywriter.h"
+#include "rapidjson/filereadstream.h"
+#include "rapidjson/filewritestream.h"
+#include "rapidjson/encodedstream.h"
+#include "rapidjson/error/en.h"
+
+#include <stdio.h>
+#include <string>
+#include <vector>
+
+#include "common.h"
+
+using namespace std;
+
+/********************************************************************************************/
+
+vector<string> vstring;
+vector<string> vstring2;
+
+static void
+bench_vector_string_init(size_t n)
+{
+    for(size_t i = 0; i < n; i++)
+    {
+        char buff[100];
+        snprintf(buff, sizeof(buff), "%zu", i);
+        std::string s(buff);
+        vstring.push_back(s);
+    }
+}
+
+static void
+bench_vector_string_init_big(size_t n)
+{
+    for(size_t i = 0; i < n; i++)
+    {
+        char buff[100];
+        snprintf(buff, sizeof(buff), "%zu%zu%zu%zu%zu%zu", i, i, i, i, i, i);
+        std::string s(buff);
+        vstring.push_back(s);
+    }
+}
+
+static void
+bench_vector_string_json_run(size_t n)
+{
+    if (vstring.size() != n) {
+        printf("Size are different!\n");
+        abort();
+    }
+
+    FILE *f = fopen("tmp-serial.json", "wt");
+    if (!f) abort();
+    {
+        // Prepare writer and output stream.
+        char writeBuffer[65536];
+        typedef rapidjson::AutoUTFOutputStream<unsigned, rapidjson::FileWriteStream> OutputStream; 
+        rapidjson::FileWriteStream os(f, writeBuffer, sizeof(writeBuffer));
+        OutputStream eos(os, rapidjson::kUTF8, false); 
+        rapidjson::PrettyWriter<OutputStream, rapidjson::UTF8<>, rapidjson::AutoUTF<unsigned> > writer(eos);
+
+        writer.StartArray();
+        for(size_t i = 0; i < n; i++){
+            writer.String(vstring[i]);
+        }
+        writer.EndArray();
+    }
+    fclose(f);
+    
+    f = fopen("tmp-serial.json", "rt");
+    if (!f) abort();
+    {
+        char readBuffer[65536];
+        rapidjson::FileReadStream is(f, readBuffer, sizeof(readBuffer));
+        rapidjson::Document d;
+        d.ParseStream(is);
+        for(size_t i = 0; i < d.Size(); i++) {
+            rapidjson::Value& s = d[i];
+            vstring2.push_back(s.GetString());
+        }
+    }
+    fclose(f);
+
+    if (vstring2.size() != n) {
+        printf("Size are different!\n");
+        abort();
+    }
+}
+
+static void
+bench_vector_string_clear(void)
+{
+    if (vstring != vstring2) {
+        printf("Array are different!\n");
+        abort();
+    }
+}
+
+/********************************************************************************************/
+
+vector<unsigned long> vulong;
+vector<unsigned long> vulong2;
+
+static void
+bench_vector_ulong_init(size_t n)
+{
+    for(size_t i = 0; i < n; i++)
+    {
+      vulong.push_back(i*i);
+    }
+}
+
+static void
+bench_vector_ulong_json_run(size_t n)
+{
+    if (vulong.size() != n) {
+        printf("Size are different!\n");
+        abort();
+    }
+
+    FILE *f = fopen("tmp-serial.json", "wt");
+    if (!f) abort();
+    {
+        // Prepare writer and output stream.
+        char writeBuffer[65536];
+        typedef rapidjson::AutoUTFOutputStream<unsigned, rapidjson::FileWriteStream> OutputStream; 
+        rapidjson::FileWriteStream os(f, writeBuffer, sizeof(writeBuffer));
+        OutputStream eos(os, rapidjson::kUTF8, false); 
+        rapidjson::PrettyWriter<OutputStream, rapidjson::UTF8<>, rapidjson::AutoUTF<unsigned> > writer(eos);
+
+        writer.StartArray();
+        for(size_t i = 0; i < n; i++){
+            writer.Int64(vulong[i]);
+        }
+        writer.EndArray();
+    }
+    fclose(f);
+    
+    f = fopen("tmp-serial.json", "rt");
+    if (!f) abort();
+    {
+        char readBuffer[65536];
+        rapidjson::FileReadStream is(f, readBuffer, sizeof(readBuffer));
+        rapidjson::Document d;
+        d.ParseStream(is);
+        for(size_t i = 0; i < d.Size(); i++) {
+            rapidjson::Value& s = d[i];
+            vulong2.push_back(s.GetInt64());
+        }
+    }
+    fclose(f);
+
+    if (vulong2.size() != n) {
+        printf("Size are different!\n");
+        abort();
+    }
+}
+
+static void
+bench_vector_ulong_clear(void)
+{
+    if (vulong != vulong2) {
+        printf("Array are different!\n");
+        abort();
+    }
+}
+
+/********************************************************************************************/
+
+const config_func_t table[] = {
+  {110,    "serial-json STR", 10000000, bench_vector_string_init, bench_vector_string_json_run, bench_vector_string_clear},
+  {111,    "serial-json STR.big", 10000000, bench_vector_string_init_big, bench_vector_string_json_run, bench_vector_string_clear},
+  {112,    "serial-json INT", 10000000, bench_vector_ulong_init, bench_vector_ulong_json_run, bench_vector_ulong_clear}
+};
+
+int main(int argc, const char *argv[])
+{
+  test("RAPIDJSON", numberof(table), table, argc, argv);
+  exit(0);
+}

bench/bench-rigtorp-hashmap.cpp

@@ -0,0 +1,159 @@
+#define NDEBUG
+
+#include <vector>
+#include <list>
+#include <iterator>
+#include <map>
+#include <set>
+#include <unordered_map>
+#include <algorithm>
+#include <string>
+#include <sstream>
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <stdbool.h>
+#include <string.h>
+
+#include "rigtorp/HashMap.h"
+
+using namespace rigtorp;
+using namespace std;
+
+#include "common.h"
+
+/********************************************************************************************/
+
+// Hash for using unsigned long as lookup key
+struct UL_Hash {
+  size_t operator()(const unsigned long v) { return v * 7; }
+};
+
+// Equal comparison for using unsigned long as lookup key
+struct UL_Equal {
+  bool operator()(const unsigned long lhs, const unsigned long rhs) {
+    return lhs == rhs;
+  }
+};
+
+static void
+test_dict2(size_t  n)
+{
+  HashMap<unsigned long, unsigned long, UL_Hash, UL_Equal> dict(16, -1UL);
+
+  for (size_t i = 0; i < n; i++) {
+    dict[rand_get()] = rand_get();
+  }
+  rand_init();
+  unsigned int s = 0;
+  for (size_t i = 0; i < n; i++) {
+    HashMap<unsigned long, unsigned long, UL_Hash, UL_Equal>::iterator it = dict.find(rand_get());
+    if (it != dict.end())
+      s += it->second;
+  }
+  g_result = s;
+}
+
+/********************************************************************************************/
+
+
+struct char_array_s {
+  char a[256];
+  char_array_s () { a[0] = 0 ; }
+  char_array_s ( const char_array_s & other) { strcpy(a, other.a); }
+  bool operator==(const char_array_s &other) const { return strcmp(a, other.a) == 0; }
+};
+
+namespace std {
+  template <> struct hash<char_array_s> {
+    std::size_t operator()(const char_array_s &k) const {
+      size_t hash = 0;
+      const char *s = k.a;
+      while (*s) hash = hash * 31421 + (*s++) + 6927;
+      return hash;
+    };
+  };
+}
+
+struct BIG_Hash {
+  size_t operator()(const char_array_s v) { return hash<char_array_s>()(v); }
+};
+
+struct BIG_Equal {
+  bool operator()(const char_array_s lhs, const char_array_s rhs) {
+    return lhs == rhs;
+  }
+};
+
+static void
+test_dict_big(size_t  n)
+{
+  char_array_s empty;
+  HashMap<char_array_s, char_array_s, BIG_Hash, BIG_Equal> dict(16, empty);
+
+  for (size_t i = 0; i < n; i++) {
+    char_array_s s1, s2;
+    sprintf(s1.a, "%u", rand_get());
+    sprintf(s2.a, "%u", rand_get());
+    dict[s1] = s2;
+  }
+  rand_init();
+  unsigned int s = 0;
+  for (size_t i = 0; i < n; i++) {
+    char_array_s s1;
+    sprintf(s1.a, "%u", rand_get());
+    HashMap<char_array_s, char_array_s, BIG_Hash, BIG_Equal>::iterator it = dict.find(s1);
+    if (it != dict.end())
+      s ++;
+  }
+  g_result = s;
+}
+
+/********************************************************************************************/
+
+struct STR_Hash {
+  size_t operator()(const string v) { return hash<string>()(v); }
+};
+
+struct STR_Equal {
+  bool operator()(const string lhs, const string rhs) {
+    return lhs == rhs;
+  }
+};
+
+
+static void
+test_dict_str(size_t  n)
+{
+  string empty;
+  HashMap<string, string, STR_Hash, STR_Equal> dict(16, empty);
+
+  for (size_t i = 0; i < n; i++) {
+    string s1 = static_cast<ostringstream*>( &(ostringstream() << rand_get()) )->str();
+    string s2 = static_cast<ostringstream*>( &(ostringstream() << rand_get()) )->str();
+    dict[s1] = s2;
+  }
+  rand_init();
+  unsigned int s = 0;
+  for (size_t i = 0; i < n; i++) {
+    string s1 = static_cast<ostringstream*>( &(ostringstream() << rand_get()) )->str();
+    HashMap<string, string, STR_Hash, STR_Equal>::iterator it = dict.find(s1);
+    if (it != dict.end())
+      s ++;
+  }
+  g_result = s;
+}
+
+/********************************************************************************************/
+
+const config_func_t table[] = {
+  { 41, "dictBig", 1000000, 0, test_dict_big, 0},
+  { 42,"dict", 1000000, 0, test_dict2, 0},
+  { 43,    "DictStr", 1000000, 0, test_dict_str, 0}
+};
+
+int main(int argc, const char *argv[])
+{
+  test("RIGTORP-HASHMAP", numberof(table), table, argc, argv);
+  exit(0);
+}

bench/bench-rigtorp-mpmcqueue.cpp

@@ -0,0 +1,96 @@
+#define NDEBUG
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <stdbool.h>
+
+#include <rigtorp/MPMCQueue.h>
+
+#include "common.h"
+
+/********************************************************************************************/
+rigtorp::MPMCQueue<unsigned int> g_buff(4*64);
+rigtorp::MPMCQueue<unsigned long long> g_final(4*64);
+
+static void final(void *arg)
+{
+  size_t *p_n = (size_t*) arg;
+  size_t    n = *p_n;
+  unsigned long long j, s = 0;
+  for(unsigned int i = 0; i < n;i++) {
+    g_final.pop(j);
+    s += j;
+  }
+  g_result = s;
+}
+
+static void conso(void *arg)
+{
+  unsigned int j;
+  size_t *p_n = (size_t*)arg;
+  size_t n = *p_n;
+  unsigned long long s = 0;
+  for(unsigned int i = 0; i < n;i++) {
+    g_buff.pop(j);
+    s += j;
+  }
+  g_final.push(s);
+}
+
+static void prod(void *arg)
+{
+  size_t *p_n = (size_t*)arg;
+  size_t n = *p_n;
+  size_t r = n;
+  for(unsigned int i = 0; i < n;i++) {
+    g_buff.push(r);
+    r = r * 31421U + 6927U;
+  }
+}
+
+static void test_queue(size_t n)
+{
+  const int cpu_count   = get_cpu_count();
+  const int prod_count  = cpu_count/2;
+  const int conso_count = cpu_count - prod_count;
+  if (cpu_count < 2) {
+    fprintf(stderr, "WARNING: Can not measure Buffer performance.\n");
+    return;
+  }
+  rand_get();
+  // Create thread
+  m_thread_t idx_p[prod_count];
+  m_thread_t idx_c[conso_count];
+  m_thread_t idx_final;
+  for(int i = 0; i < prod_count; i++) {
+    m_thread_create (idx_p[i], prod, &n);
+  }
+  for(int i = 0; i < conso_count; i++) {
+    m_thread_create (idx_c[i], conso, &n);
+  }
+  size_t n2 = conso_count;
+  m_thread_create(idx_final, final, &n2);
+
+  // Wait for jobs to be done.
+  for(int i = 0; i < prod_count; i++) {
+    m_thread_join(idx_p[i]);
+  }
+  for(int i = 0; i < conso_count; i++) {
+    m_thread_join(idx_c[i]);
+  }
+  m_thread_join(idx_final);
+
+}
+
+
+/********************************************************************************************/
+
+const config_func_t table[] = {
+  { 60,    "Queue MPMC", 1000000, 0, test_queue, 0}
+};
+
+int main(int argc, const char *argv[])
+{
+  test("RIGTORP-MPMC-QUEUE", numberof(table), table, argc, argv);
+  exit(0);
+}

bench/bench-sparsepp.cpp

@@ -109,14 +109,14 @@ test_dict_str(size_t  n)
 
 /********************************************************************************************/
 
+const config_func_t table[] = {
+  { 41, "dictBig", 1000000, 0, test_dict_big, 0},
+  { 42,"dict", 1000000, 0, test_dict2, 0},
+  { 43,    "DictStr", 1000000, 0, test_dict_str, 0}
+};
+
 int main(int argc, const char *argv[])
 {
-  int n = (argc > 1) ? atoi(argv[1]) : 0;
-  if (n == 42)
-    test_function("Dict(u)time", 1000000, test_dict2);
-  if (n == 41)
-    test_function("DictB  time", 1000000, test_dict_big);
-  if (n == 43)
-    test_function("DictS(u)  time", 1000000, test_dict_str);
+  test("SPARSEPP", numberof(table), table, argc, argv);
   exit(0);
 }

bench/bench-stl.cpp

@@ -1,6 +1,7 @@
 #define NDEBUG
 
 #include <vector>
+#include <deque>
 #include <list>
 #include <iterator>
 #include <map>
@@ -53,6 +54,23 @@ static void test_array(size_t n)
 
 /********************************************************************************************/
 
+static void test_deque(size_t n)
+{
+  deque<unsigned int> a1, a2;
+  for(size_t i = 0; i < n; i++) {
+    a1.push_back(rand_get() );
+    a2.push_back(rand_get() );
+  }
+  unsigned int s = 0;
+  for(auto it1 = a1.cbegin(), it2 = a2.cbegin();
+      it1 != a1.cend() ;it1++, it2++) {
+    s += *it1 * *it2;
+  }
+  g_result = s;
+}
+
+/********************************************************************************************/
+
 static void test_rbtree(size_t n)
 {
   set<unsigned long> tree;
@@ -110,6 +128,24 @@ test_dict2(size_t  n)
   g_result = s;
 }
 
+static void
+test_dict2_linear(size_t  n)
+{
+  unordered_map<unsigned long, unsigned long> dict;
+
+  for (size_t i = 0; i < n; i++) {
+    dict[i] = rand_get();
+  }
+  rand_init();
+  unsigned int s = 0;
+  for (size_t i = 0; i < n; i++) {
+    unordered_map<unsigned long, unsigned long>::iterator it = dict.find(i);
+    if (it != dict.end())
+      s += it->second;
+  }
+  g_result = s;
+}
+
 /********************************************************************************************/
 
 struct char_array_s {
@@ -220,28 +256,23 @@ static void test_stable_sort(size_t n)
 
 /********************************************************************************************/
 
+const config_func_t table[] = {
+  { 10,    "List", 10000000, 0, test_list, 0},
+  { 20,   "Array", 100000000, 0, test_array, 0},
+  { 21,   "Deque", 100000000, 0, test_deque, 0},
+  { 30,  "Rbtree", 1000000, 0, test_rbtree, 0},
+  { 40,    "dict(m)", 1000000, 0, test_dict1, 0},
+  { 41, "dictBig", 1000000, 0, test_dict_big, 0},
+  { 42,"dict(u)", 1000000, 0, test_dict2, 0},
+  { 43,"DictStr(u)", 1000000, 0, test_dict_str, 0},
+  { 44,"DictStr(m)", 1000000, 0, test_dict_str2, 0},
+  { 46, "dictLinear(u)", 1000000, 0, test_dict2_linear, 0},
+  { 50,           "Sort",10000000, 0, test_sort, 0},
+  { 51,    "Stable Sort",10000000, 0, test_stable_sort, 0}
+};
+
 int main(int argc, const char *argv[])
 {
-  int n = (argc > 1) ? atoi(argv[1]) : 0;
-  if (n == 10)
-    test_function("List   time",10000000, test_list);
-  if (n == 20)
-    test_function("Array  time", 100000000, test_array);
-  if (n == 30)
-    test_function("Rbtree time", 1000000, test_rbtree);
-  if (n == 40)
-    test_function("Dict(m)time", 1000000, test_dict1);
-  if (n == 42)
-    test_function("Dict(u)time", 1000000, test_dict2);
-  if (n == 41)
-    test_function("DictB  time", 1000000, test_dict_big);
-  if (n == 43)
-    test_function("DictS(u)  time", 1000000, test_dict_str);
-  if (n == 44)
-    test_function("DictS(m)  time", 1000000, test_dict_str2);
-  if (n == 50)
-    test_function("Sort   time", 10000000, test_sort);
-  if (n == 51)
-    test_function("Stable Sort time", 10000000, test_stable_sort);
+  test("STL", numberof(table), table, argc, argv);
   exit(0);
 }

bench/bench-string-2.cpp

@@ -1,7 +1,7 @@
 /*
  * M*LIB - String Bench
  *
- * Copyright (c) 2017-2019, Patrick Pelissier
+ * Copyright (c) 2017-2021, Patrick Pelissier
  * All rights reserved.
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -27,17 +27,20 @@
 #include <string>
 #include <vector>
 
-#include "m-string.h"
 #include "common.h"
 
+#include "m-string.h"
+
 #ifdef BENCH_CAN_USE_SDS
 extern "C" {
 #include "sds.h"
 };
 #endif
 
-#ifdef BENCH_CAN_USE_RAPIDSTRING
-#include "rapidstring.h"
+#ifdef BENCH_CAN_USE_BSTRLIB
+#include "bstrlib.h"
+#include "bstrwrap.h"
+#include "bstraux.h"
 #endif
 
 /*
@@ -70,6 +73,17 @@ void random_permutation(unsigned n)
 
 using namespace std;
 
+static void replace_all_stl(string &str, const char pattern[], const char replace[])
+{
+  size_t pos = 0;
+  do {
+    pos = str.find(pattern, pos);
+    if (pos != string::npos) {
+      str.replace (pos, strlen(pattern), replace);
+    }
+  } while (pos != string::npos);
+}
+
 size_t bench_stl(unsigned n)
 {
   vector<string> tab;
@@ -82,25 +96,12 @@ size_t bench_stl(unsigned n)
     str += tab[permutation_tab[i]];
   }
 
-  size_t pos = 0;
-  do {
-    pos = str.find("1234", pos);
-    if (pos != string::npos) {
-      str.replace (pos, 4, "WELL");
-    }
-  } while (pos != string::npos);
-
-  pos = 0;
-  do {
-    pos = str.find("56789", pos);
-    if (pos != string::npos) {
-      str.replace (pos, 5, "DONE");
-    }
-  } while (pos != string::npos);
+  replace_all_stl(str, "1234", "WELL");
+  replace_all_stl(str, "56789", "DONE");
 
   return str.length();
 }
-                        
+
 size_t bench_mlib(unsigned n)
 {
   string_t *tab = (string_t*) malloc (n * sizeof (string_t));
@@ -117,15 +118,8 @@ size_t bench_mlib(unsigned n)
     string_cat(str, tab[permutation_tab[i]]);
   }
   // P3
-  size_t i = 0;
-  do {
-    i = string_replace_str(str, "1234", "WELL", i);
-  } while (i != STRING_FAILURE);
-  // P4
-  i = 0;
-  do {
-    i = string_replace_str(str, "56789", "DONE", i);
-  } while (i != STRING_FAILURE);
+  string_replace_all_str(str, "1234", "WELL");
+  string_replace_all_str(str, "56789", "DONE");
   size_t length = string_size(str);
   // Clean
   string_clear(str);
@@ -136,6 +130,42 @@ size_t bench_mlib(unsigned n)
   return length;
 }
 
+
+#ifdef BENCH_CAN_USE_BSTRLIB
+
+static void replace_all_bstrlib(CBString &str, const char pattern[], const char replace[])
+{
+  size_t pos = 0;
+  do {
+    pos = str.find(pattern, pos);
+    if (pos != string::npos) {
+      str.replace (pos, strlen(pattern), replace);
+    }
+  } while (pos != string::npos);
+}
+
+size_t bench_bstrlib(unsigned n)
+{
+  vector<CBString> tab;
+  tab.resize(n);
+  for(unsigned i = 0; i < n; i++) {
+    char tmp[10];
+    sprintf(tmp, "%u", rand_get());
+    tab[i] = tmp;
+  }
+
+  CBString str;
+  for(unsigned i = 0; i < n; i++) {
+    str += tab[permutation_tab[i]];
+  }
+
+  replace_all_bstrlib(str, "1234", "WELL");
+  replace_all_bstrlib(str, "56789", "DONE");
+
+  return str.length();
+}
+#endif
+
 #ifdef BENCH_CAN_USE_SDS
 sds SDS_replace_at(sds str, size_t pos, size_t len, const char str2[])
 {
@@ -147,6 +177,19 @@ sds SDS_replace_at(sds str, size_t pos, size_t len, const char str2[])
   return a;
 }
 
+sds replace_all_sds(sds str, const char pattern[], const char replace[])
+{
+  size_t pos = 0;
+  do {
+    char *p = strstr(&str[pos], pattern);
+    pos = p == NULL ? -1U : (p - str);
+    if (pos != -1U) {
+      str = SDS_replace_at(str, pos, strlen(pattern), replace);
+    }
+  } while (pos != -1U);
+  return str;
+}
+
 size_t bench_sds(unsigned n)
 {
   sds *tab = (sds*) malloc (n * sizeof (sds));
@@ -161,25 +204,10 @@ size_t bench_sds(unsigned n)
     str = sdscat(str, tab[permutation_tab[i]]);
   }
   // P3
-  size_t pos = 0;
-  do {
-    char *p = strstr(&str[pos], "1234");
-    pos = p == NULL ? -1U : (p - str);
-    if (pos != -1U) {
-      str = SDS_replace_at(str, pos, 4, "WELL");
-    }
-  } while (pos != -1U);
-  // P4
-  pos = 0;
-  do {
-    char *p = strstr(&str[pos], "56789");
-    pos = p == NULL ? -1U : (p - str);
-    if (pos != -1U) {
-      str = SDS_replace_at(str, pos, 5, "DONE");
-    }
-  } while (pos != -1U);
-  size_t length = sdslen(str);
+  str = replace_all_sds(str, "1234", "WELL");
+  str = replace_all_sds(str, "56789", "DONE");
   // Clean
+  size_t length = sdslen(str);
   sdsfree(str);
   for(unsigned i = 0; i < n; i++) {
     sdsfree(tab[i]);
@@ -189,63 +217,6 @@ size_t bench_sds(unsigned n)
 }
 #endif
 
-#ifdef BENCH_CAN_USE_RAPIDSTRING
-void RAPIDSTRING_replace_at(rapidstring *str, size_t pos, size_t len, const char str2[])
-{
-  // simple implementation as replace is not available
-  rapidstring a;
-  
-  rs_init_w_n(&a, rs_data(str), pos);
-  rs_cat(&a, str2);
-  rs_cat(&a, &rs_data(str)[pos+len] );
-  rs_free(str);
-  *str = a;
-}
-
-size_t bench_rapidstring(unsigned n)
-{
-  rapidstring *tab = (rapidstring*) malloc (n * sizeof (rapidstring));
-  assert (tab != 0);
-  // P1
-  for(unsigned i = 0; i < n; i++) {
-    char tmp[10];
-    sprintf(tmp, "%u", rand_get());
-    rs_init_w(&tab[i], tmp);
-  }
-  // P2
-  rapidstring str;
-  rs_init(&str);
-  for(unsigned i = 0; i < n; i++) {
-    rs_cat_rs(&str, &tab[permutation_tab[i]]);
-  }
-  // P3
-  size_t pos = 0;
-  do {
-    char *p = strstr(&rs_data(&str)[pos], "1234");
-    pos = p == NULL ? -1U : (p - rs_data(&str));
-    if (pos != -1U) {
-      RAPIDSTRING_replace_at(&str, pos, 4, "WELL");
-    }
-  } while (pos != -1U);
-  // P4
-  pos = 0;
-  do {
-    char *p = strstr(&rs_data(&str)[pos], "56789");
-    pos = p == NULL ? -1U : (p - rs_data(&str));
-    if (pos != -1U) {
-      RAPIDSTRING_replace_at(&str, pos, 5, "DONE");
-    }
-  } while (pos != -1U);
-  size_t length = rs_len(&str);
-  // Clean
-  rs_free(&str);
-  for(unsigned i = 0; i < n; i++) {
-    rs_free(&tab[i]);
-  }
-  free(tab);
-  return length;
-}
-#endif
 
 int main(int argc, const char *argv[])
 {
@@ -271,10 +242,10 @@ int main(int argc, const char *argv[])
     name = "SDS";
     break;
 #endif
-#ifdef BENCH_CAN_USE_RAPIDSTRING
-  case 3:
-    length = bench_rapidstring(n);
-    name = "RAPID";
+#ifdef BENCH_CAN_USE_BSTRLIB
+  case 4:
+    length = bench_bstrlib(n);
+    name = "BSTRLIB";
     break;
 #endif
   default:
@@ -285,4 +256,3 @@ int main(int argc, const char *argv[])
 
   return 0;
 }
-

bench/bench-string.cpp

@@ -35,8 +35,8 @@
  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-/* Update of integrating M*LIB, LIBSRT, SDS, RAPIDSTRING & GLIB
-   done by Patrick Pelissier
+/* Update of integrating M*LIB, LIBSRT, SDS & GLIB
+   Copyright (c) 2018-2021 Patrick Pelissier
  */
 
 /*
@@ -79,11 +79,6 @@ extern "C" {
 #include <string>
 #endif
 
-#if defined (BENCH_CAN_USE_RAPIDSTRING)
-#include "rapidstring.h"
-#endif
-
-
 #if defined(BENCH_CAN_USE_GLIB)
 #include "gmodule.h"
 #endif
@@ -682,121 +677,6 @@ int testSDS_replace (int count) {
 
 #endif
 
-#ifdef BENCH_CAN_USE_RAPIDSTRING
-int testRAPIDSTRING_emptyCtor (int count) {
-  int i, c = 0;
-  for (c=i=0; i < count; i++) {
-    rapidstring b;
-    rs_init(&b);
-    BARRIER(&b);
-    c += rs_len(&b) ^i;
-    rs_free(&b);
-  }
-  return c;
-}
-
-int testRAPIDSTRING_nonemptyCtor (int count) {
-  int i, c = 0;
-  for (c=i=0; i < count; i++) {
-    rapidstring b;
-    rs_init_w(&b, TESTSTRING1);
-    BARRIER(&b);
-    c += rs_len(&b) ^i;
-    rs_free(&b);
-  }
-  return c;
-}
-
-int testRAPIDSTRING_smallnonemptyCtor (int count) {
-  int i, c = 0;
-  for (c=i=0; i < count; i++) {
-    rapidstring b;
-    rs_init_w(&b, SMALLTESTSTRING1);
-    BARRIER(&b);
-    c += rs_len(&b) ^i;
-    rs_free(&b);
-  }
-  return c;
-}
-
-int testRAPIDSTRING_cstrAssignment (int count) {
-  int i, c = 0;
-  rapidstring b;
-  rs_init(&b);
-  for (c=i=0; i < count; i++) {
-    rs_cpy(&b, TESTSTRING1);
-    BARRIER(&b);
-    c += rs_len(&b) ^i;
-  }
-  rs_free(&b);
-  return c;
-}
-
-int testRAPIDSTRING_extraction (int count) {
-  int i, c = 0;
-
-  rapidstring b;
-  rs_init_w(&b, TESTSTRING1);
-  
-  for (c=i=0; i < count; i++) {
-    c += rs_data_c(&b)[i & 7];
-    c += rs_data_c(&b)[(i & 7) ^ 8];
-    c += rs_data_c(&b)[(i & 7) ^ 4] ^i;
-    BARRIER(&b);
-  }
-  rs_free(&b);
-  return c;
-}
-
-int testRAPIDSTRING_concat (int count) {
-  int i, j, c = 0;
-  rapidstring a, accum;
-  rs_init_w(&a, TESTSTRING1);
-  rs_init (&accum);
-
-  for (j=0; j < count; j++) {
-    rs_cpy(&accum, "");
-    for (i=0; i < 250; i++) {
-      rs_cat_rs(&accum, &a);
-      rs_cat(&accum, "!!");
-      BARRIER(&accum);
-      c += rs_len(&accum) ^i;
-    }
-  }
-  rs_free(&a);
-  rs_free(&accum);
-  return c;
-}
-
-void RAPIDSTRING_replace_at(rapidstring *str, size_t pos, size_t len, const char str2[])
-{
-  // simple implementation as replace is not available
-  rapidstring a;
-  
-  rs_init_w_n(&a, rs_data(str), pos);
-  rs_cat(&a, str2);
-  rs_cat(&a, &rs_data(str)[pos+len] );
-  rs_free(str);
-  *str = a;
-}
-
-int testRAPIDSTRING_replace (int count) {
-  int j, c = 0;
-  rapidstring a;
-  rs_init_w(&a, TESTSTRING1);
-  for (j=0; j < count; j++) {
-    RAPIDSTRING_replace_at(&a, 11, 4, "XXXXXX");
-    RAPIDSTRING_replace_at(&a, 23, 2, "XXXXXX");
-    RAPIDSTRING_replace_at(&a, 4, 8, "XX");
-    BARRIER(&a);
-    c += rs_len(&a) ^j;
-  }  
-  rs_free(&a);
-  return c;
-}
-
-#endif
-
 
 #ifdef BENCH_CAN_USE_GLIB
 int testGLIB_emptyCtor (int count) {
@@ -1088,37 +968,6 @@ int benchTest (const struct flags * runflags) {
   }
 #endif
 
-#ifdef BENCH_CAN_USE_RAPIDSTRING
-  if (runflags->runtest[0]) {
-    c += timeTest (cps, testRAPIDSTRING_emptyCtor, 100000);
-    print ("RAPIDSTRING", "empty constructor", cps);
-  }
-  if (runflags->runtest[1]) {
-    c += timeTest (cps, testRAPIDSTRING_nonemptyCtor, 100000);
-    print ("RAPIDSTRING", "non-empty constructor", cps);
-  }
-  if (runflags->runtest[2]) {
-    c += timeTest (cps, testRAPIDSTRING_smallnonemptyCtor, 100000);
-    print ("RAPIDSTRING", "small non-empty constructor", cps);
-  }
-  if (runflags->runtest[3]) {
-    c += timeTest (cps, testRAPIDSTRING_cstrAssignment, 100000);
-    print ("RAPIDSTRING", "char * assignment", cps);
-  }
-  if (runflags->runtest[4]) {
-    c += timeTest (cps, testRAPIDSTRING_extraction, 100000);
-    print ("RAPIDSTRING", "char extraction", cps);
-  }
-  if (runflags->runtest[6]) {
-    c += timeTest (cps, testRAPIDSTRING_concat, 10);
-    print ("RAPIDSTRING", "concatenation", cps * 250);
-  }
-  if (runflags->runtest[7]) {
-    c += timeTest (cps, testRAPIDSTRING_replace, 10);
-    print ("RAPIDSTRING", "replace", cps);
-  }
-#endif
-
 #ifdef BENCH_CAN_USE_GLIB
   if (runflags->runtest[0]) {
     c += timeTest (cps, testGLIB_emptyCtor, 100000);

bench/bench-tommyds.c

@@ -206,18 +206,16 @@ test_dict_big(size_t  n)
 
 /********************************************************************************************/
 
+const config_func_t table[] = {
+  { 10,    "List", 10000000, 0, test_list, 0},
+  { 20,   "Array", 100000000, 0, test_array, 0},
+  { 30,  "Rbtree", 1000000, 0, test_rbtree, 0},
+  { 40,    "dict", 1000000, 0, test_dict, 0},
+  { 41, "dictBig", 1000000, 0, test_dict_big, 0}
+};
+
 int main(int argc, const char *argv[])
 {
-  int n = (argc > 1) ? atoi(argv[1]) : 0;
-  if (n == 10)
-    test_function("List   time",10000000, test_list);
-  if (n == 20)
-    test_function("Array  time", 100000000, test_array);
-  if (n == 30)
-    test_function("Rbtree time", 1000000, test_rbtree);
-  if (n == 40)
-    test_function("Dict   time", 1000000, test_dict);
-  if (n == 41)
-    test_function("DictB  time", 1000000, test_dict_big);
+  test("TommyDS", numberof(table), table, argc, argv);
   exit(0);
 }

bench/bench-uthash.c

@@ -1,4 +1,5 @@
 #define NDEBUG
+#define  _GNU_SOURCE
 
 #include <stdlib.h>
 #include <stdio.h>
@@ -199,19 +200,16 @@ static void test_sort(size_t n)
 
 /********************************************************************************************/
 
+const config_func_t table[] = {
+  { 10,    "List", 10000000, 0, test_list, 0},
+  { 20,   "Array", 100000000, 0, test_array, 0},
+  { 40,    "dict", 1000000, 0, test_dict, 0},
+  { 41, "dictBig", 1000000, 0, test_dict_big, 0},
+  { 50,    "sort", 10000000, 0, test_sort, 0}
+};
+
 int main(int argc, const char *argv[])
 {
-  int n = (argc > 1) ? atoi(argv[1]): 0;
-  if (n == 10)
-    test_function("List   time",10000000, test_list);
-  if (n == 20)
-    test_function("Array  time", 100000000, test_array);
-  if (n == 40 || n == 42)
-    test_function("Dict   time", 1000000, test_dict);
-  if (n == 41)
-    test_function("DictB  time", 1000000, test_dict_big);
-  if (n == 50)
-    test_function("Sort   time", 10000000, test_sort);
+  test("UT-HASH", numberof(table), table, argc, argv);
   exit(0);
 }
-

bench/bench-xxhash.c

@@ -31,17 +31,12 @@ static void test_hash(size_t n)
 
 /********************************************************************************************/
 
+const config_func_t table[] = {
+  { 70,"XXHASH64", 100000000, test_hash_prepare, test_hash, test_hash_final}
+};
 
 int main(int argc, const char *argv[])
 {
-  int n = (argc > 1) ? atoi(argv[1]) : 0;
-  if (n == 70) {
-    n = (argc > 2) ? atoi(argv[2]) : 100000000;
-    test_hash_prepare(n);
-    test_function("XXHASH64 time", n, test_hash);
-    test_hash_final();
-  }
-  
+  test("XXHASH", numberof(table), table, argc, argv);
   exit(0);
 }
-

bench/common.c

@@ -1,7 +1,7 @@
 /*
  * M*LIB - common functions for bench module
  *
- * Copyright (c) 2017-2019, Patrick Pelissier
+ * Copyright (c) 2017-2021, Patrick Pelissier
  * All rights reserved.
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -23,8 +23,21 @@
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
+#include <string.h>
 #include "common.h"
 
+// Maximum supported value for repeat argument
+#define MAX_REPEAT 10000
+
+// The global result
+unsigned long g_result;
+
+// The rand value
+#if defined(MULTI_THREAD_MEASURE)
+M_THREAD_ATTR
+#endif
+unsigned int randValue = 0;
+
 void compiler_barrier(void *p)
 {
   // Do nothing, but let the compiler thinks that we did.
@@ -32,3 +45,260 @@ void compiler_barrier(void *p)
   // Can be used for FLTO building
   //  asm volatile("": "+r" (p) : :"memory");
 }
+
+struct parse_opt_s {
+  int test_function;
+  double from, to, step, grow;
+  double within;
+  unsigned repeat;
+  bool graph, best, best_within, average, quiet;
+};
+
+static void
+parse_config(struct parse_opt_s *opt, int argc, const char *argv[])
+{
+  char *end;
+  
+  opt->test_function = 0;
+  opt->from = 0.0;
+  opt->to   = 0.0;
+  opt->step = 0.0;
+  opt->grow = 1.1;
+  opt->graph = false;
+  opt->best = false;
+  opt->best_within = false;
+  opt->average = false;
+  opt->quiet = false;
+  opt->repeat = 1;
+  opt->within = .05;
+  
+  for(int i = 1; i < argc ; i++)
+    {
+      if (argv[i][0] == '-') {
+	if (strcmp(argv[i], "--from") == 0){
+	  i++;
+	  opt->from = strtod(argv[i], &end);
+	  opt->to   = opt->from;
+	} else if (strcmp(argv[i], "--to") == 0) {
+	  i++;
+	  opt->to = strtod(argv[i], &end);
+	  opt->grow = 1.1;
+	} else if (strcmp(argv[i], "--step") == 0) {
+	  i++;
+	  opt->step = strtod(argv[i], &end);
+	  opt->grow = 0;
+	} else if (strcmp(argv[i], "--grow") == 0) {
+	  i++;
+	  opt->grow = strtod(argv[i], &end);
+	  opt->step = 0;
+	} else if (strcmp(argv[i], "--repeat") == 0) {
+	  i++;
+	  opt->repeat = strtol(argv[i], &end, 10);
+	  opt->repeat = (opt->repeat > MAX_REPEAT) ? MAX_REPEAT : opt->repeat;
+	} else if (strcmp(argv[i], "--graph") == 0) {
+	  opt->graph = true;
+	} else if (strcmp(argv[i], "--best") == 0) {
+	  opt->best = true;
+	  opt->average = false;
+	  opt->best_within = false;
+	} else if (strcmp(argv[i], "--best-within") == 0) {
+	  opt->best_within = true;
+	  opt->best = false;
+	  opt->average = false;
+	  i++;
+	  opt->within = strtod(argv[i], &end) / 100.0;
+	} else if (strcmp(argv[i], "--average") == 0) {
+	  opt->average = true;
+	  opt->best = false;
+	  opt->best_within = false;
+	} else if (strcmp(argv[i], "--quiet") == 0) {
+	  opt->quiet = true;
+	} else {
+	  fprintf(stderr, "ERROR: Option unkown: %s.\n",
+		  argv[i]);
+	  exit(-1);
+	}
+	if (*end != 0) {
+	  fprintf(stderr, "ERROR: Cannot parse %s. Expected float\n",
+		  argv[i]);
+	  exit(-1);
+	}
+
+      } else {
+	opt->test_function = strtol (argv[i], &end, 10);
+	if (*end != 0) {
+	  fprintf(stderr, "ERROR: Cannot parse %s. Expected function number\n",
+		  argv[i]);
+	  exit(-1);
+	}
+      }
+    }
+}
+
+static int
+select_config(int func, size_t n, const config_func_t functions[])
+{
+  for(size_t i = 0; i < n;i++) {
+    if (functions[i].num == func)
+      return i;
+  }
+  fprintf(stderr, "ERROR: Function number %d not found. Available functions are:\n", func);
+  for(size_t i = 0; i < n;i++) {
+    fprintf(stderr, "  %d: %s\n", functions[i].num, functions[i].funcname);
+  }
+  fprintf(stderr,
+	  "USAGE: FUNC_NUMBER [--from number --to number (--grow number | --step number)] [--grapĥ]\n"
+	  "[--repeat number] [--best|--average|--best-within] [--quiet]\n");
+  exit(-1);
+}
+
+// Utility function for qsort
+static int cmp_double(const void *pa, const void *pb)
+{
+  const double *a = (const double *) pa, *b = (const double *)pb;
+  return (*a < *b) ? -1 : *a > *b;
+}
+
+/* Get the longest sequence of values within 'f'% */
+static int
+get_sequence(int i, int n, double tab[], double f)
+{
+  int j;
+  for(j = i + 1; j < n; j++) {
+    if (tab[j] > f * tab[i])
+      break;
+  }
+  return j-i;
+}
+
+/* Return the minimum of the longest sequence of values with 'f'% */
+static double
+get_best_within(int n, double tab[], double f)
+{
+  qsort(tab, n, sizeof(double), cmp_double);
+  int best_i   = 0;
+  int best_seq = get_sequence(0, n, tab, f);
+  for(int i = 1; i < n && (n-i) > best_seq ; i++) {
+    int seq = get_sequence(i, n, tab, f);
+    if (seq > best_seq) {
+      best_i = i;
+      best_seq = seq;
+    }
+  }
+  return tab[best_i];
+}
+
+// Integer sqrt function (to avoid depending on libm)
+static unsigned integer_sqrt(unsigned n)
+{
+  // Find greatest shift.
+  int shift = 2;
+  unsigned nShifted = n >> shift;
+  // We check for nShifted being n, since some implementations
+  // perform shift operations modulo the word size.
+  while (nShifted != 0 && nShifted != n){
+    shift += 2;
+    nShifted = n >> shift;
+  }
+  shift -= 2;
+  // Find digits of result.
+  unsigned result = 0;
+  while (shift >= 0) {
+    result = result << 1;
+    unsigned candidateResult = result + 1;
+    if (candidateResult*candidateResult <= n >> shift) {
+      result = candidateResult;
+    }
+    shift -= 2;
+  }
+  return result;
+}
+
+void
+test(const char library[], size_t n, const config_func_t functions[], int argc, const char *argv[])
+{
+  // Init & parse arguments
+  // NUMBER
+  // --from NUMBER --to NUMBER --step NUMBER --grow NUMBER
+  // --graph --best --average --quiet
+  // --repeat N
+  struct parse_opt_s arg;
+  parse_config(&arg, argc, argv);
+  int i = select_config(arg.test_function, n, functions);
+  double from = (arg.from == 0) ? functions[i].default_n : arg.from;
+  double to   = (arg.to   == 0) ? functions[i].default_n : arg.to;
+
+  // Open plot file if needed
+  FILE *graph_file = NULL;
+  if (arg.graph) {
+    char filename[100];
+    sprintf(filename, "plot-%s-%d.dat", library, arg.test_function);
+    graph_file = fopen(filename, "wt");
+    if (!graph_file) {
+      fprintf(stderr, "ERROR: Cannot create plot.dat\n");
+      exit(-2);
+    }
+    fprintf(graph_file, "# plotting %s-%d : %s\n# N T", library, arg.test_function, functions[i].funcname);
+  }
+  
+  // Do the bench
+  for(double n = from; n <= to ; n = ((arg.grow == 0) ? n + arg.step : n * arg.grow))
+    {
+      double best = (1.0/0.0);
+      double avg  = 0.0;
+      double variance = 0.0;
+      static double measure[MAX_REPEAT];
+      double ba = 0.0;
+      
+      if (functions[i].init != NULL)
+	functions[i].init(n);
+
+      // Measure the time of the test_function
+      for(unsigned r = 0; r < arg.repeat; r++) {
+	double t0 = test_function( (arg.graph|arg.best|arg.average|arg.quiet) ? NULL : functions[i].funcname, (size_t) n, functions[i].func);
+	best = (t0 < best) ? t0 : best;
+	avg += t0;
+	variance += t0 * t0;
+	measure[r] = t0;
+      }
+
+      // Closure of the tests
+      if (functions[i].clear != NULL)
+	functions[i].clear();
+
+      // Finish computing the different times
+      if (arg.repeat > 1) {
+	avg /= arg.repeat;
+	variance = (variance - arg.repeat * avg * avg) / (arg.repeat - 1);
+	ba = get_best_within(arg.repeat, measure, 1. + arg.within);
+      }
+      
+      // The average value shall be around best_within (and greater)
+      // otherwise the result doesn't seem reliable.
+      bool reliable = (ba <= avg && ba * (1.0+arg.within/2) + 0.5 > avg);
+      
+      // Print the result
+      if (arg.graph) {
+	fprintf(graph_file, "%f %f\n", n, arg.average ? avg : arg.best ? best : ba);
+      } else if (arg.quiet) {
+	printf("%ld\n", (long)(arg.average ? avg : arg.best ? best : reliable ? ba : -1));
+      } else if (arg.repeat > 1) {
+	if (arg.average == false && arg.best_within == false)
+	  printf ("%20.20s time %lu ms for n = %lu ***   BEST  ***\n", functions[i].funcname, (unsigned long) best, (unsigned long) n);
+	if (arg.best == false  && arg.best_within == false)
+	  printf ("%20.20s time %lu ms +/- %u ms for n = %lu *** AVERAGE ***\n", functions[i].funcname, (unsigned long) avg, 2*integer_sqrt(variance), (unsigned long) n);
+	if (arg.best == false  && arg.average == false)
+	  printf ("%20.20s time %lu ms for n = %lu *** BEST within %d%% *** %s\n", functions[i].funcname, (unsigned long) ba, (unsigned long) n, (int)(100*arg.within), reliable ? "" : "(unreliable result)");
+      }
+    }
+  
+  // Close the FILE if needed
+  if (arg.graph) {
+    fclose(graph_file);
+    printf("File plot-%s-%d.dat generated.\n"
+	   "Run in gnuplot the following command:\n"
+	   "\tplot 'plot-%s-%d.dat' with linespoints linestyle 1\n",
+	   library, arg.test_function, library, arg.test_function);
+  }
+  return;
+}

bench/common.h

@@ -1,7 +1,7 @@
 /*
  * M*LIB - common functions for bench module
  *
- * Copyright (c) 2017-2019, Patrick Pelissier
+ * Copyright (c) 2017-2021, Patrick Pelissier
  * All rights reserved.
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -27,36 +27,57 @@
 
 #include <stdio.h>
 #include <stdlib.h>
+#include <stdbool.h>
+
+// Needed for M_THREAD_ATTR
+#if defined(MULTI_THREAD_MEASURE)
+#include "m-mutex.h"
+#endif
 
 #if defined(_WIN32)
-/* WINDOWS variant */
-#include <windows.h>
+# include <windows.h>
+#elif (defined(__APPLE__) && defined(__MACH__)) \
+  || defined(__DragonFly__) || defined(__FreeBSD__) \
+  || defined(__NetBSD__) || defined(__OpenBSD__)
+# include <sys/types.h>
+# include <sys/resource.h>
+# include <sys/time.h>
+# include <sys/param.h>
+# include <sys/sysctl.h>
+# define USE_SYSCTL
+#else
+# include <sys/types.h>
+# include <sys/resource.h>
+# include <sys/time.h>
+# include <unistd.h>
+#endif
 
+// Number of elements of a table
+#define numberof(x) (sizeof(x)/sizeof(x[0]))
+
+/* Get the current CPU time. */
+#if defined(_WIN32)
+/* WINDOWS variant */
 static inline unsigned long long
 cputime (void)
 {
-	LARGE_INTEGER freq, val;
-	QueryPerformanceFrequency(&freq);
-	QueryPerformanceCounter(&val);
-	return (unsigned long long) (1000000. * (double) val.QuadPart / (double) freq.QuadPart);
+  LARGE_INTEGER freq, val;
+  QueryPerformanceFrequency(&freq);
+  QueryPerformanceCounter(&val);
+  return (unsigned long long) (1000000. * (double) val.QuadPart / (double) freq.QuadPart);
 }
-
 #else
 /* UNIX variant */
-#include <sys/types.h>
-#include <sys/resource.h>
-#include <sys/time.h>
-
 static inline unsigned long long
 cputime (void)
 {
 #if defined(MULTI_THREAD_MEASURE)
-  // Multi thread
+  // Multi thread: Uses real time
   struct timeval tv;
   gettimeofday (&tv, NULL);
   return tv.tv_sec * 1000000ULL + tv.tv_usec;
 #else
-  // Single thread
+  // Single thread: Uses process usage time
   struct rusage rus;
   getrusage (0, &rus);
   return rus.ru_utime.tv_sec * 1000000ULL + rus.ru_utime.tv_usec;
@@ -65,46 +86,61 @@ cputime (void)
 
 #endif
 
-static unsigned long g_result;
-static
+// The result of the bench
+extern unsigned long g_result;
+
+// The rand value
+extern
 #if defined(MULTI_THREAD_MEASURE)
 M_THREAD_ATTR
 #endif
-unsigned int randValue = 0;
+unsigned int randValue;
 
+// Pseudo rand value generator.
+// Not very random but sufficient and fast enough for the bench
 static inline void rand_init(void)
 {
   randValue = 0;
 }
-
 static inline unsigned int rand_get(void)
 {
   randValue = randValue * 31421U + 6927U;
   return randValue;
 }
 
-static inline void test_function(const char str[], size_t n, void (*func)(size_t))
+// The function that performs the bench
+static inline double
+test_function(const char *str, size_t n, void (*func)(size_t))
 {
+  double result;
   unsigned long long start, end;
   rand_init();
   start = cputime();
   (*func)(n);
   end = cputime();
+  result = (double)(end-start) / 1000.0;
   end = (end - start) / 1000U;
-  printf ("%s %lu ms for n = %lu [r=%lu]\n", str, (unsigned long) end, (unsigned long) n, g_result);
+  if (str != NULL) {
+    printf ("%20.20s time %lu ms for n = %lu [r=%lu]\n", str, (unsigned long) end, (unsigned long) n, g_result);
+  }
+  return result;
 }
 
-#if defined(_WIN32)
-# include <windows.h>
-#elif (defined(__APPLE__) && defined(__MACH__)) \
-  || defined(__DragonFly__) || defined(__FreeBSD__) \
-  || defined(__NetBSD__) || defined(__OpenBSD__)
-# include <sys/param.h>
-# include <sys/sysctl.h>
-# define USE_SYSCTL
-#else
-# include <unistd.h>
+// Configuration table
+typedef struct {
+  int num;
+  const char *funcname;
+  size_t default_n;
+  void (*init)(size_t);
+  void (*func)(size_t);
+  void (*clear)(void);
+} config_func_t;
+
+// Perform a parsing of the given arguments and do the bench according to the table
+#ifdef __cplusplus
+extern "C"
 #endif
+void test(const char library[], size_t n, const config_func_t functions[], int argc, const char *argv[]);
 
 /* Return the number of CPU of the system */
 static inline int get_cpu_count(void)

bench/max-dict.c

@@ -1,7 +1,7 @@
 /*
  * MLIB - TEST module
  *
- * Copyright (c) 2017-2019, Patrick Pelissier
+ * Copyright (c) 2017-2021, Patrick Pelissier
  * All rights reserved.
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -59,7 +59,7 @@ static void find_max(void)
     dict_int64_set_at (dict, get_rand(), get_rand());
     n++;
     if ((n & ((1<<20)-1)) == 0) {
-      printf ("n=%lu\n", n);
+      printf ("n=%zu\n", n);
     }
   }
   dict_int64_clear(dict);

bench/udb/test-mlib-oa.c

@@ -1,8 +1,3 @@
-#ifndef NDEBUG
-#define NDEBUG
-#endif
-#undef NDEBUG
-
 #include <string.h>
 
 #include "benchmark.h"
@@ -48,7 +43,7 @@ int test_int(int N, const unsigned *data)
       if (dict_int_get (h, data[i]) == NULL) {
         dict_int_set_at (h, data[i], i);
       } else {
-        dict_int_remove(h, data[i]);
+        dict_int_erase(h, data[i]);
       }
     }
     ret = (int)dict_int_size(h);
@@ -64,7 +59,7 @@ int test_str(int N, char * const *data)
       if (dict_str_get (h, data[i]) == NULL) {
         dict_str_set_at (h, data[i], i);
       } else {
-        dict_str_remove(h, data[i]);
+        dict_str_erase(h, data[i]);
       }
     }
     ret = (int)dict_str_size(h);

bench/udb/test-mlib.c

@@ -4,10 +4,10 @@
 #include "m-dict.h"
 #include "m-mempool.h"
 
-DICT_DEF2(dict_int,
+DICT_STOREHASH_DEF2(dict_int,
           int, M_OPEXTEND(M_DEFAULT_OPLIST, MEMPOOL(mpool_int), MEMPOOL_LINKAGE(static)),
           int, M_DEFAULT_OPLIST)
-DICT_DEF2(dict_str,
+DICT_STOREHASH_DEF2(dict_str,
           const char *, M_OPEXTEND (M_CSTR_OPLIST, MEMPOOL(mpool_str), MEMPOOL_LINKAGE(static)),
           int, M_DEFAULT_OPLIST)
 
@@ -20,7 +20,7 @@ int test_int(int N, const unsigned *data)
       if (dict_int_get (h, data[i]) == NULL) {
         dict_int_set_at (h, data[i], i);
       } else {
-        dict_int_remove(h, data[i]);
+        dict_int_erase(h, data[i]);
       }
     }
     ret = (int)dict_int_size(h);
@@ -38,7 +38,7 @@ int test_str(int N, char * const *data)
       if (dict_str_get (h, data[i]) == NULL) {
         dict_str_set_at (h, data[i], i);
       } else {
-        dict_str_remove(h, data[i]);
+        dict_str_erase(h, data[i]);
       }
     }
     ret = (int)dict_str_size(h);

bench/udb2/test-mlib.c

@@ -1,4 +1,5 @@
 #include "../common.c"
+#define DICTI_OA_PROBING(s) 1
 #include "m-dict.h"
 
 static inline bool oor_equal_p(unsigned int k, unsigned char n)
@@ -11,10 +12,10 @@ static inline void oor_set(unsigned int *k, unsigned char n)
 }
 
 DICT_OA_DEF2(dict_oa_uint,
-	     unsigned int, M_OPEXTEND(M_DEFAULT_OPLIST, OOR_EQUAL(oor_equal_p), OOR_SET(oor_set M_IPTR)),
+	     unsigned int, M_OPEXTEND(M_DEFAULT_OPLIST, HASH(hash_fn), OOR_EQUAL(oor_equal_p), OOR_SET(oor_set M_IPTR)),
 	     unsigned int, M_DEFAULT_OPLIST)
 
-void test_int(uint32_t n, uint32_t x0)
+uint32_t test_int(uint32_t n, uint32_t x0)
 {
   uint32_t i, x, z = 0;
   dict_oa_uint_t h;
@@ -22,10 +23,12 @@ void test_int(uint32_t n, uint32_t x0)
   for (i = 0, x = x0; i < n; ++i) {
     x = hash32(x);
     unsigned int key = get_key(n, x);
-    unsigned int *ptr = dict_oa_uint_get(h, key);
-    if (ptr) { (*ptr)++; z+= *ptr; }
-    else { dict_oa_uint_set_at(h, key, 1); z+=1; }
+    unsigned int *ptr = dict_oa_uint_get_at(h, key);
+    (*ptr)++;
+    z += *ptr;
   }
   fprintf(stderr, "# unique keys: %d; checksum: %u\n", (int) dict_oa_uint_size(h), z);
+  z = dict_oa_uint_size(h);
   dict_oa_uint_clear(h);
+  return z;
 }

doc/API.txt

@@ -35,3 +35,25 @@ V0.2.*: * worker_start takes a 'worker_t' as an additional parameter
         The provided _remove doesn't use an iterator but a 'key', incompatible with the one of array or list.
         But is like the one provided by the priority queue.
         
+V0.3.*: * Remove B+TREE _remove method as it has been deprecated (use _erase instead)
+        * Remove DICT _remove method as it has been deprecated (use _erase instead)
+        * Make _it_to_p method of B+TREE / RB-TREE as deprecated (uses _it_until_p instead ).
+        * Deprecated buffer options BUFFER_BLOCKING* and BUFFER_UNBLOCKING*
+        as the _push_blocking and _pop_blocking functions can do the same and are more versatil.
+	* Iteration over the items of a dictionnary/tree returns const iterators for access through
+	OPLIST (impact: algorithm & M_EACH) as the IT_REF operator is no longer exported.
+	The _it_ref method is still defined and can be used, so you can still modify the values
+	but it won't be automatically used anymore (as the keys CANNOT be modified).
+	(Previously it generates incorrect algorithm when used with m-dict).
+
+V0.4.*: * The order of a list initialized using M_LET is reversed
+        to match what is done for ARRAY (and the C++ forward_list).
+        * Rename M_SKIP, M_KEEP & M_MID into M_SKIP_ARGS, M_KEEP_ARGS & M_MID_ARGS
+        due to conflict with glibc malloc.h (that defines M_KEEP for compatibility).
+        * Method write_string of m_serial expects a new argument (number of characters).
+        * Method _init_set2 of m-i-shared is removed.
+        * Operator _it_insert updates it_insertion iterator to reference the inserted element.
+        * Dereference Type of an iterator of a dict / B+Tree is suffixed by _itref_t instead of _type_t.
+        * Rename TUPLE _init_set2 in _init_emplace & _set2 in _emplace.
+        * Rename Priority Queue method _update_further in _update.
+        

doc/DEV.md

@@ -30,6 +30,16 @@ List of tested systems
 * clang 3.8 on linux/armv7l
 
 
+Atomic library
+==============
+
+For target, armel m68k mips mipsel powerpc powerpcspe sh4, you may need to run the test suite:
+
+make check LDFLAGS="-pthread -latomic"
+
+since 'atomic' library is not automatically included for 32 bits systems.
+
+
 Cross compilation
 =================
 
@@ -62,3 +72,40 @@ This will have the following gains:
 
 Once one issue of ISSUES.org is taken into account,
 its state shall be changed to DONE (the issue shall not be removed).
+
+
+Debugging
+===============
+
+Debugging the library can be quite difficult
+as it performs heavy preprocessing expansion
+and expands all code in one line.
+Different strategy for debugging the library itself are still possible:
+
+1) Good old printf.
+Add printf of interresting values in the debugged function.
+
+
+2) Preprocess the library and then compile the preprocessed file:
+
+          cc -std=c99 -E test-file.c > test-file.i
+          perl -pi -e 's/;/;\n/g' test-file.i
+          cc -std=c99 -c -Wall test-file.i
+
+ The resulting executable can be debugged much more easily.
+
+
+3) To debug the preprocessing itself, the Boot Wave library can be used
+and in particular the [wave driver](https://www.boost.org/doc/libs/1_71_0/libs/wave/doc/wave_driver.html)
+
+ Add in the code the following pragmas around the code to debug:
+
+     	  #pragma wave trace(enable)  
+     	  ARRAY_DEF (array_charp, char *)
+     	  #pragma wave trace(disable)
+
+Run the wave driver:
+
+    	 ./wave ex-array01.c -I .. --c99 -t test.trace
+
+The different expansion performed by the library are described in test.trace

doc/ISSUES.org

@@ -1,11 +1,97 @@
 *Long term issues*
 ------------------
 
+* TODO #26 : Hash-Map for huge objects                          :ENHANCEMENT:
+
+Specialize Hashmap for huge objects on supported hardware:
+
+based on OA hash map with taggued pointer (needs space for tagging):
+low bits = low bits of hash
+pointer to object { key, hash, value }
+
+Can detect collision without dereferencing object with 1/2^lowbits chances.
+Reduce cache usage ==> Should be faster.
+
+Use of pointer to avoid moving object on GC.
+
+On AMD64, only 48 bits of 64 bits are really used for addressing data.
+
+
+* TODO #25 : Support of error code model for error handling.    :ENHANCEMENT:
+
+Find a way to support error return code for the API in case of allocation
+failure.
+
+Any service that returns void shall return a "int".
+In case of allocation failure, it shall return an error.
+M_CALL macro shall stop its execution if the service returns an error code
+and the error code represents an error (avoid rewritting everything)
+and throw back the error code (stopping the execution flow).
+
+Services returning already something shall not be modified.
+
+This model should be applied at the container level only and not globally.
+Different containers may need different levels of error handling.
+4 combinaison to take into account:
+
+==> ABORT on container / ABORT on used type: The current model
+==> ABORT on container / RETCODE on used type: Needs to abort on reported error.
+==> RETCODE on container / ABORT on used type: Nothing particular to note.
+==> RETCODE on container / RETCODE on used type: Forward retcode to caller.
+
+Find a way to make it while not making the code too complex 
+(try to keep as simple as possible).
+
+Using a specialized oplist for such containers (_OPLIST_RETCODE)
+using a specialized API for retcode:
+
+API_RET_*: that expands to
+
+     if (func(args) == 0) goto handler_exit_failure;
+
+Adding at the end of each service:
+     M_END_FUNCTION(cleanup_code) that expands to different cases:
+     M_END_FUNCTION_VALUE(cleanup_code, return_success, return_failure) that expands to different cases:
+
+ABORT/ABORT:
+     handler_exit_success: 
+     handler_exit_failure: 
+      return;
+
+ABORT/RETCODE:
+     handler_exit_success: 
+      return;
+     handler_exit_failure: 
+      RAISE_FATAL_ERROR
+
+RETCODE/ABORT
+     handler_exit_success: 
+      return SUCESS;
+     handler_exit_failure: 
+      cleanup_code
+      return FAILURE;
+
+RETCODE/RETCODE
+     handler_exit_success: 
+      return SUCESS;
+     handler_exit_failure: 
+      cleanup_code
+      return FAILURE;
+
+If really needed, the macro can be avoided and code can be hand written.
+
+Open points:
+- How to handle warnings on unused labels?
+- What about M_LET/ M_EACH?
+
+
 * TODO #24 : Add MIN-MAX-HEAP container                         :ENHANCEMENT:
 
 See https://en.wikipedia.org/wiki/Min-max_heap
 as DPRIORITY_QUEUE_DEF ?
 
+NOTE: Needs for such container?
+
 
 * TODO #23: Force MOVE semantic                                 :ENHANCEMENT:
 
@@ -34,48 +120,12 @@ For example for tuple, it shall
 - create an init_move operator if no one has disabled INIT_MOVE,
 - export the init_move operator if at least one has exported a INIT_MOVE and no one has disabled INIT_MOVE.
 
-  
-* DONE #22: Enhanced services for SPSC Queue                    :ENHANCEMENT:
+** DO_INIT_MOVE operator
 
-Add services:
-
-** DONE _push_bulk
-Test the capacity of the queue and push as much as possible in the queue
-with one check of the atomic structure.
-
-** DONE _pop_bulk
-Test the capacity of the queue and push as much as possible in the queue
-with one check of the atomic structure.
-
-** DONE _push_force:
-
-If the capacity of the queue is full, pop one element and push it:
-push always succeed and the queue always keep the youngest element.
-
-
-* TODO #21: Generic Binary serialization                        :ENHANCEMENT:
-
-   Based on issue #26 of  https://github.com/P-p-H-d/mlib/issues/26
-   
-   Some kind of "binary serialization" on the model of get_str/parse_str 
-   could be possible. It would be a great feature from the application 
-   point-of-view: binary representation is more bandwidth-efficient if 
-   used on network communications.
-
-   It will be good to have import/export methods to the 
-   XML/JSON/MSGPACK/PROTOBUF/BINARY format. 
-   However, adding all of them on by one in the M*LIB containers
-   doesn't seem satisfactory. 
-
-   Instead, adding a generic interface for the serialization of data 
-   that may be customized by the user to perform the import/export of
-   objects in whatever format they want into what they want (FILE/memory/...). 
-   To simplify it, this interface could only support one kind of import/export
-   per compilation unit.
-
-   Problem:
-   the interface is either too high level (limiting too much what we can do)
-   or too low level (exporting too many internal things of the library).
+DO_INIT_MOVE macro is not also fully working for structure
+defined with [1] tricks but without an explicit INIT_MOVE / MOVE
+operators as it uses MOVE_DEFAULT which is not (fully compatible).
+==> Analyse limitation and possible constraint usages.
 
 
 * TODO #20: Bucket priority queue                               :ENHANCEMENT:
@@ -98,6 +148,7 @@ implementation.
 * TODO #19: Intrusive Red Black Tree                            :ENHANCEMENT:
 
  Add intrusive red black tree. 
+ Look also for AVL tree (NOTE: Is there a performance difference between the two?)
 
 
 * TODO #18: Missing methods                                     :ENHANCEMENT:
@@ -154,7 +205,7 @@ http://htmlpreview.github.io/?https://github.com/P-p-H-d/mlib/blob/master/doc/Co
 
  backoff has be used when using CAS.
  
- Concurrent insertion / insertion and insertion / deletion and deletion / deletion shall be taken into account.
+ Concurrent insertion / insertion and insertion / deletion and deletion / deletion shall be crefully analyzed when taken into account.
  
  Questions:
  - singly or doubly or dual push?
@@ -162,10 +213,11 @@ http://htmlpreview.github.io/?https://github.com/P-p-H-d/mlib/blob/master/doc/Co
    (NULL if not logically deleted) ? TBC
 
 
-* TODO #15: Constructor / Destructor Prologue / Epilogue for Stack Exception Handling :ENHANCEMENT:
+* TODO #15: Prologue / Epilogue for Constructor / Destructor for error handling :ENHANCEMENT:
 
 Constructor (and destructor) need to use user-defined prologue / epilogue.
-This is in order to register the constructed object into a proper Stack Exception Handling so that exceptions throwing may work reliably.
+This is in order to register the constructed object into a proper Exception
+Handling Stack so that throwing exceptions may work reliably.
 
 Proposal:
 
@@ -174,15 +226,19 @@ Proposal:
 - M_DESTRUCTOR_PROLOGUE(object, oplist);
 - M_DESTRUCTOR_EPILOGUE(object, oplist);
 
-Object creation will need to add all sub-objects into the stack, then unstack all to push instead the root object (which will recursively remove them).
+Object creation will need to add all sub-objects into the stack, 
+then unstack all to push instead the root object (which recursively remove them).
 
 See also http://freetype.sourceforge.net/david/reliable-c.html#cseh
 
+- How to handle like allocation of the object?
+- How to avoid calling the destructor multiple times? (It is needed?)
+- How the code can be factorized with RETCODE needs?
 
 
 * TODO #14: Memory allocation enhancement                       :ENHANCEMENT:
 
-Enhancement of the memory allocation scheme to find way to deal properly with advance allocators:
+Enhancement of the memory allocation scheme to find way to deal properly with advanced allocators:
 
 -  non-default alignment requirements for types,
 -  instance-based allocator (may need instance based variable access),
@@ -214,6 +270,7 @@ Needs some formal operator in the oplist to support it fully and an example.
 
 It is a kind of object  inheritance where the container inherits some extra data from its base.
 
+
 * TODO #12: Atomic shared pointer                               :ENHANCEMENT:
 
 Add an extension to the SHARED_PTR API:
@@ -231,7 +288,10 @@ No _ref or direct _init: we need to init first a normal shared_ptr then the atom
 
 ** _atomic_set method:
 
-It can be implemented by incrementing the non atomic shared pointer reference, then performs a compare_and_swap to the data of the atomic shared pointer, finally decrement and dec/free the swapped previous data of the atomic .
+It can be implemented by incrementing the non atomic shared pointer reference, 
+then performs a compare_and_swap to the data of the atomic shared pointer, 
+finally decrement and dec/free the swapped previous data of the atomic like a normal shared pointer.
+All 3 steps are safe.
 
 ** _set_atomic method:
 
@@ -338,3 +398,44 @@ Not sure it will really help. To analyse.
 
  A good way maybe Open Addessing table used only for indirection and a freelist memory reclamation container for handle the entries
  (like a transaction).
+
+* DONE #22: Enhanced services for SPSC Queue                    :ENHANCEMENT:
+
+Add services:
+
+** DONE _push_bulk
+Test the capacity of the queue and push as much as possible in the queue
+with one check of the atomic structure.
+
+** DONE _pop_bulk
+Test the capacity of the queue and push as much as possible in the queue
+with one check of the atomic structure.
+
+** DONE _push_force:
+
+If the capacity of the queue is full, pop one element and push it:
+push always succeed and the queue always keep the youngest element.
+
+* DONE #21: Generic Binary serialization                        :ENHANCEMENT:
+
+   Based on issue #26 of  https://github.com/P-p-H-d/mlib/issues/26
+   
+   Some kind of "binary serialization" on the model of get_str/parse_str 
+   could be possible. It would be a great feature from the application 
+   point-of-view: binary representation is more bandwidth-efficient if 
+   used on network communications.
+
+   It will be good to have import/export methods to the 
+   XML/JSON/MSGPACK/PROTOBUF/BINARY format. 
+   However, adding all of them on by one in the M*LIB containers
+   doesn't seem satisfactory. 
+
+   Instead, adding a generic interface for the serialization of data 
+   that may be customized by the user to perform the import/export of
+   objects in whatever format they want into what they want (FILE/memory/...). 
+   To simplify it, this interface could only support one kind of import/export
+   per compilation unit.
+
+
+
+

example/Makefile

@@ -1,18 +1,47 @@
+# Copyright (c) 2017-2021, Patrick Pelissier
+# All rights reserved.
+# 
+# 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 REGENTS 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 REGENTS AND 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.
+
 CC=cc -std=c99
-CFLAGS=-Wall -W -pedantic -Wshadow -Wpointer-arith -Wcast-qual -Wstrict-prototypes -Wmissing-prototypes -Wswitch-default -Wswitch-enum -Wcast-align -Wpointer-arith -Wbad-function-cast -Wstrict-overflow=5 -Wstrict-prototypes -Winline -Wundef -Wnested-externs -Wcast-qual -Wshadow -Wunreachable-code -Wlogical-op -Wstrict-aliasing=2 -Wredundant-decls -Wold-style-definition -Wno-unused-function
+CFLAGS=-Wall -W -pedantic -Wshadow -Wpointer-arith -Wcast-qual -Wstrict-prototypes -Wmissing-prototypes -Wswitch-default -Wswitch-enum -Wcast-align -Wpointer-arith -Wbad-function-cast -Wstrict-overflow=5 -Wstrict-prototypes -Winline -Wundef -Wnested-externs -Wcast-qual -Wshadow -Wunreachable-code -Wlogical-op -Wstrict-aliasing=2 -Wredundant-decls -Wold-style-definition -Wno-unused-function -g
+GMP_DIR=
 CPPFLAGS=-I..
-LDFLAGS=-pthread -lgmp
+LDFLAGS=-pthread
 RM=rm -f
 
 .SUFFIXES: .c .exe
 
 .c.exe:
-	$(CC) $(CFLAGS) $(CPPFLAGS) $(LDFLAGS) $< -o $@
+	$(CC) $(CFLAGS) $(CPPFLAGS) $(LDFLAGS) `cat config` $< -o $@
 
-all:
+all: config
 	$(MAKE) `ls ex-*.c|sed -e 's/\.c/\.exe/g'`
+	if test "$(CC)" = "cc -std=c99" ; then $(MAKE) `ls ex11-*.c|sed -e 's/\.c/\.exe/g'` CC="cc -std=c11" ; fi
+
+config:
+	printf "#include <gmp.h>\nint main(void){mpz_t z; mpz_init(z); return 0;}\n" > config-test.c
+	$(CC) $(CFLAGS) $(CPPFLAGS) $(LDFLAGS)  -I$(GMP_DIR)/include -L$(GMP_DIR)/lib -lgmp config-test.c -o config-test.exe 2> /dev/null && echo "-DHAVE_GMP=1  -I$(GMP_DIR)/include -L$(GMP_DIR)/lib -lgmp" > config || echo "-DHAVE_GMP=0" > config
+	$(RM) config-test.c config-test.exe
 
 clean:
-	$(RM) *.exe *.s *~ *.o ./a.dat
+	$(RM) *.exe *.s *~ *.o ./a.dat config
 
 

example/ex-algo02.c

@@ -0,0 +1,68 @@
+#include <stdio.h>
+#include "m-array.h"
+#include "m-algo.h"
+
+/* Define a dynamic array of int */ 
+ARRAY_DEF(vector_int, int)
+/* Register the oplist of this dynamic array globally */
+#define M_OPL_vector_int_t() ARRAY_OPLIST(vector_int)
+/* Define some standards algorithms on this dynamic array */
+ALGO_DEF(vector_int, vector_int_t)
+
+/* Define a dynamic array of bool */ 
+ARRAY_DEF(vector_bool, bool, M_BOOL_OPLIST)
+/* Register the oplist of this dynamic array globally */
+#define M_OPL_vector_bool_t() ARRAY_OPLIST(vector_bool, M_BOOL_OPLIST)
+/* Define some standards algorithms on this dynamic array */
+ALGO_DEF(vector_bool, vector_bool_t)
+
+/* ID function */
+static bool id(bool x) { return x ; }
+
+int main(void)
+{
+  // Define, init (& later clear) myvector & tmp as vector_int_t
+  M_LET(myvector, tmp, vector_int_t) {
+    // Fill myvector with 3 int equal to 20
+    vector_int_fill_n(myvector, 3, 20);
+    // Fill tmp with 3 int equal to 33
+    vector_int_fill_n(tmp, 3, 33);
+    // Append all tmp in myvector
+    vector_int_splice(myvector, tmp);
+    // Fill tmp with 2 int equal to 10 
+    vector_int_fill_n(tmp, 2, 10);
+    // Append all tmp in myvector
+    vector_int_splice(myvector, tmp);
+    // Display the result
+    printf("myvector contains:");
+    // In C11, the for loop can be simplified as :
+#if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L)
+    ALGO_FOR_EACH(myvector, vector_int_t, M_PRINT, " ");
+#else
+    for M_EACH(it, myvector, vector_int_t) {
+        printf(" %d", *it);
+      }
+#endif
+    printf("\n");
+  }
+  
+  // Same thing but with booleans
+  M_LET(myvector, tmp, vector_bool_t) {
+    vector_bool_fill_n(myvector, 3, false);
+    vector_bool_fill_n(tmp, 3, true);
+    vector_bool_splice(myvector, tmp);
+    vector_bool_fill_n(tmp, 2, false);
+    vector_bool_splice(myvector, tmp);
+    printf("myvector contains:");
+    for M_EACH(it, myvector, vector_bool_t) {
+        printf(" %d", (int)*it);
+      }
+    printf("\n");
+    printf ("ALL: %d ANY: %d NONE: %d\n",
+            vector_bool_all_of_p(myvector, id),
+            vector_bool_any_of_p(myvector, id),
+            vector_bool_none_of_p(myvector, id) );
+  }
+
+  return 0;
+}

example/ex-algo03.c

@@ -0,0 +1,42 @@
+#include "m-dict.h"
+#include "m-array.h"
+#include "m-algo.h"
+#include "m-string.h"
+
+/* Define a dictionnary (or hash_map or undordered_map)
+ * from a string_t to int */
+DICT_DEF2(dict, string_t, int)
+/* Register the oplist of this dictionnary globally */
+#define M_OPL_dict_t() DICT_OPLIST(dict, STRING_OPLIST, M_DEFAULT_OPLIST)
+
+/* Define an array of integer */
+ARRAY_DEF(vector_int, int)
+/* Register the oplist of this array of integer globally */
+#define M_OPL_vector_int_t() ARRAY_OPLIST(vector_int)
+
+/* Micro macro to detect if a string starts with the given pattern */
+#define start_with(pattern, item)                \
+  string_start_with_str_p((item).key, (pattern))
+
+/* Micro macro to get the value of a pair of (key, value) */
+#define get_value(out, item) ((out) = (item).value)
+
+int main(void)
+{
+  int s;
+  // Init keys as a vector_int_t, initialize it (and prepare its destruction)
+  M_LET(keys, vector_int_t)
+    // Initialize m as a dictionnary and initialize it with the given database
+    // Initialize tmp as a dictionanry
+    M_LET( (m, (STRING_CTE("foo"), 1), (STRING_CTE("bar"), 42), (STRING_CTE("bluez"), 7), (STRING_CTE("stop"), 789) ), tmp, dict_t) {
+ 
+    /* Extract all elements of 'm' that starts with 'b' */
+    ALGO_EXTRACT(tmp, dict_t, m, dict_t, start_with, "b");
+    /* Extract the values of theses elements */
+    ALGO_TRANSFORM(keys, vector_int_t, tmp, dict_t, get_value);
+    /* Sum theses values */
+    ALGO_REDUCE(s, keys, vector_int_t, sum);
+    printf("Sum of elements starting with 'b' is: %d\n", s);
+  }
+  return 0;
+}

example/ex-algo04.c

@@ -0,0 +1,38 @@
+#include "m-algo.h"
+#include "m-array.h"
+#include "m-string.h"
+
+/* Define an array of int */
+ARRAY_DEF(vector_int, int)
+/* Register the oplist of this array of int globally */
+#define M_OPL_vector_int_t() ARRAY_OPLIST(vector_int)
+
+/* Set s (string_t) to the integer i */
+#define str_ui(s, i) string_printf(s, "%d", i)
+
+/* Concat two strings by insertion a '-' within them */
+#define str_cat(s1, s2) (string_cat_str(s1, "-"), string_cat(s1, s2))
+
+int main(void)
+{
+  // Let s be a string_t and initilize it.
+  M_LET(s, string_t)
+    // Let v be a vector of integer and initialize it.
+    M_LET( (v, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10), vector_int_t) {
+    int sum, product;
+    
+    // Compute the sum of theses integers.
+    ALGO_REDUCE(sum, v, vector_int_t, add);
+
+    // Compute the product of theses integers.
+    ALGO_REDUCE(product, v, vector_int_t, mul);
+
+    /* Example of reduction with a transformation of the type from int to string_t */
+    ALGO_REDUCE( (s, string_t), v, vector_int_t, str_cat, str_ui);
+
+    printf ("sum: %d\n"
+            "product: %d\n"
+            "dash str: %s\n", sum, product, string_get_cstr(s));
+  }
+  return 0;
+}

example/ex-array00.c

@@ -0,0 +1,619 @@
+/* Include M*LIB header */
+#include "m-array.h"
+#include "m-string.h"
+#include "m-tuple.h"
+
+/* Provide several examples of different types usage with array,
+   with the oplist to use for each case.
+
+   Each time it creates and initializes an array,
+   fills it with some number,
+   computes its sum,
+   and returns it.
+
+   This is done for several basic C types:
+   - integers,
+   - floats, 
+   - pointers, 
+   - structures,
+   - tuples
+*/
+
+
+
+/* Generate prototypes and inline functions
+   for basic types.
+   For integer and floats, there is no need to specify
+   an oplist. M_DEFAULT_OPLIST will be used.
+ */
+ARRAY_DEF(r_bool, bool)
+
+/* Basic usage of the type */
+static int
+test_bool(int n)
+{
+  r_bool_t array;
+
+  r_bool_init(array);
+  for(int i = 0; i < n; i++) {
+    r_bool_push_back(array, i & 1);
+  }
+
+  int s = 0;
+  for(int i = 0; i < n; i++) {
+    s += *r_bool_get(array, i);
+  }
+  
+  r_bool_clear(array);
+
+  return s;
+}
+
+
+
+/* Same with type char */
+ARRAY_DEF(r_char, char)
+
+static int
+test_char(int n)
+{
+  r_char_t array;
+
+  r_char_init(array);
+  for(int i = 0; i < n; i++) {
+    r_char_push_back(array, i & 255);
+  }
+
+  int s = 0;
+  for(int i = 0; i < n; i++) {
+    s += *r_char_get(array, i);
+  }
+  
+  r_char_clear(array);
+
+  return s;
+}
+
+
+
+/* Same with type signed int. */
+ARRAY_DEF(r_int, signed int)
+
+static int
+test_int(int n)
+{
+  r_int_t array;
+
+  r_int_init(array);
+  for(int i = 0; i < n; i++) {
+    r_int_push_back(array, i);
+  }
+
+  int s = 0;
+  for(int i = 0; i < n; i++) {
+    s += *r_int_get(array, i);
+  }
+  
+  r_int_clear(array);
+
+  return s;
+}
+
+
+
+/* Same with type signed int.
+   But with an explicit oplist.
+   This generates exactly the same code than r_int
+*/
+ARRAY_DEF(r_int2, signed int, M_DEFAULT_OPLIST)
+
+static int
+test_int2(int n)
+{
+  r_int2_t array;
+
+  r_int2_init(array);
+  for(int i = 0; i < n; i++) {
+    r_int2_push_back(array, i);
+  }
+
+  int s = 0;
+  for(int i = 0; i < n; i++) {
+    s += *r_int2_get(array, i);
+  }
+  
+  r_int2_clear(array);
+
+  return s;
+}
+
+
+
+/* Same with type unsigned long long */
+ARRAY_DEF(r_ullong, unsigned long long)
+
+static int
+test_ullong(int n)
+{
+  r_ullong_t array;
+
+  r_ullong_init(array);
+  for(int i = 0; i < n; i++) {
+    r_ullong_push_back(array, i);
+  }
+
+  int s = 0;
+  for(int i = 0; i < n; i++) {
+    s += *r_ullong_get(array, i);
+  }
+  
+  r_ullong_clear(array);
+
+  return s;
+}
+
+
+
+/* Same with type float */
+ARRAY_DEF(r_float, float)
+
+static int
+test_float(int n)
+{
+  r_float_t array;
+
+  r_float_init(array);
+  for(int i = 0; i < n; i++) {
+    r_float_push_back(array, i/4.0);
+  }
+
+  float s = 0;
+  for(int i = 0; i < n; i++) {
+    s += *r_float_get(array, i);
+  }
+  
+  r_float_clear(array);
+
+  return s;
+}
+
+
+
+/* Same with type double and an explicit oplist*/
+ARRAY_DEF(r_double, double, M_DEFAULT_OPLIST)
+
+static int
+test_double(int n)
+{
+  r_double_t array;
+
+  r_double_init(array);
+  for(int i = 0; i < n; i++) {
+    r_double_push_back(array, i/4.0);
+  }
+
+  float s = 0;
+  for(int i = 0; i < n; i++) {
+    s += *r_double_get(array, i);
+  }
+  
+  r_double_clear(array);
+
+  return s;
+}
+
+
+
+/* Helper function strdup */
+static char *my_strdup(const char *p)
+{
+  size_t s = strlen(p);
+  char *d= malloc(s+1);
+  if(!d) abort();
+  strcpy(d, p);
+  return d;
+}
+
+/* Same with type const char *, representing a contant string.
+   We *** need *** an explicit oplist to tell M*LIB
+   to consider the type as a constant string.
+   The oplist to use is M_CSTR_OPLIST.
+   We could have used M_PTR_OPLIST too,
+   but in this case, we won't get proper string order or
+   string equality.
+*/
+ARRAY_DEF(r_cstring, const char *, M_CSTR_OPLIST)
+
+static int
+test_cstring(int n)
+{
+  r_cstring_t array;
+
+  r_cstring_init(array);
+  for(int i = 0; i < n; i++) {
+    char buffer[10];
+    // Create a string from the integer
+    sprintf(buffer, "%d", i);
+    // We need to make an explicit copy of the string
+    // since it is not supported by the basic type.
+    char *p = my_strdup(buffer);
+    // Push the copy in the container.
+    r_cstring_push_back(array, p);
+  }
+
+  int s = 0;
+  for(int i = 0; i < n; i++) {
+    // Get back the string
+    const char *p = *r_cstring_get(array, i);
+    // Convert it to integer
+    int j = atoi(p);
+    s += j;
+  }
+
+  // We also need a special unalloc pass
+  // to free all constant strings we have allocated.
+  for(int i = 0; i < n; i++) {
+    const char *p = *r_cstring_get(array, i);
+    free((void*)(uintptr_t)p);
+  }
+  
+  r_cstring_clear(array);
+
+  return s;
+}
+
+
+
+/* Same with type string_t of M*LIB, representing a variable string.
+   We don't need explicit oplist to tell M*LIB!
+   The oplist to use is STRING_OPLIST,
+   but it has been registered globaly, so we don't need to explicit
+   give it to array_def! */
+ARRAY_DEF(r_string, string_t)
+
+static int
+test_string(int n)
+{
+  r_string_t array;
+  string_t str;
+  
+  r_string_init(array);
+  string_init (str);
+  
+  for(int i = 0; i < n; i++) {
+    // create a string from an integer
+    string_printf(str, "%d", i);
+    // No need to make a copy in the container!
+    r_string_push_back(array, str);
+  }
+
+  int s = 0;
+  for(int i = 0; i < n; i++) {
+    // Get back the string and convert it back to an integer
+    int j = atoi(string_get_cstr(*r_string_get(array, i)));
+    s += j;
+  }
+
+  // No need to explicit dealloc !
+  string_clear(str);
+  r_string_clear(array);
+
+  return s;
+}
+
+
+
+/* Same with type string_t of M*LIB, representing a variable string
+   and its explicit oplist. And said above, it generates exactly the
+   same code. */
+ARRAY_DEF(r_string2, string_t, STRING_OPLIST)
+
+
+
+/* Same with type 'volatile unsigned int *'
+   The array stores pointers to another integer,
+   allocated somewhere else.
+   We need to tell M*LIB to handle the basic type
+   as pointers without caring for what the value of
+   the pointer is.
+   So here, we **need** to specify the oplist of the type
+   as M_PTR_OPLIST.
+ */
+ARRAY_DEF(r_vintptr, volatile unsigned int *, M_PTR_OPLIST)
+
+static int
+test_vintptr(int n)
+{
+  r_vintptr_t array;
+
+  // Allocate a secondary table to store the value.
+  unsigned *tab = calloc(n, sizeof(volatile unsigned int));
+  if (!tab) abort();
+  
+  r_vintptr_init(array);
+  for(int i = 0; i < n; i++) {
+    tab[i] = i*i - i;
+    // Push the pointer to this integer in the array
+    r_vintptr_push_back(array, &tab[i]);
+  }
+
+  int s = 0;
+  for(int i = 0; i < n; i++) {
+    // Get the pointer to the integer.
+    volatile unsigned *p = *r_vintptr_get(array, i);
+    s += *p;
+  }
+  
+  r_vintptr_clear(array);
+  free(tab);
+  
+  return s;
+}
+
+
+
+/* Same with a structure type.
+   We need to tell M*LIB to handle the basic type
+   as POD;
+   So here, we **need** to specify the oplist of the type
+   as M_POD_OPLIST.
+ */
+struct rock_me_out {
+  int n;
+  float other;
+};
+
+ARRAY_DEF(r_rockme, struct rock_me_out, M_POD_OPLIST)
+
+static int
+test_rockme(int n)
+{
+  r_rockme_t array;
+
+  r_rockme_init(array);
+  for(int i = 0; i < n; i++) {
+    struct rock_me_out rock;
+    rock.n = i*i - i;
+    // Push the struct in the array
+    r_rockme_push_back(array, rock);
+  }
+
+  int s = 0;
+  for(int i = 0; i < n; i++) {
+    // Get the pointer to the struct
+    struct rock_me_out *p = r_rockme_get(array, i);
+    s += p->n;
+  }
+  
+  r_rockme_clear(array);
+  
+  return s;
+}
+
+
+
+/* Same with a structure type defined with [1]:
+   We need to tell M*LIB to handle the basic type
+   as a special array;
+   So here, we **need** to specify the oplist of the type
+   as M_A1_OPLIST.
+ */
+typedef struct rock_me_in {
+  int n;
+  float other;
+} rock_me_in[1];
+
+ARRAY_DEF(r_rockme2, rock_me_in, M_A1_OPLIST)
+
+static int
+test_rockme2(int n)
+{
+  r_rockme2_t array;
+
+  r_rockme2_init(array);
+  for(int i = 0; i < n; i++) {
+    rock_me_in rock;
+    rock->n = i*i - i;
+    r_rockme2_push_back(array, rock);
+  }
+
+  int s = 0;
+  for(int i = 0; i < n; i++) {
+    // Get the pointer to the struct.
+    rock_me_in *p = r_rockme2_get(array, i);
+    s += (*p)->n;
+  }
+  
+  r_rockme2_clear(array);
+
+  return s;
+}
+
+
+
+/* Same with a structure type defined with [1] and a global registeration.
+   We need to tell M*LIB to handle the basic type
+   as a special array.
+
+   To do so, we register the oplist of rock_us_t by defining a macro based
+   on M_OPL_ + type name + () which expands with the oplist of the type.
+
+   Then we define the array, giving it only the type.
+   M*LIB will look at the global registered oplist of the type, we don't
+   need to give it explictly.
+
+   Global registeration makes easier code.
+   Registeration should be done when the type is defined.
+ */
+#define M_OPL_rock_me_in() M_A1_OPLIST
+
+ARRAY_DEF(r_rockme2b, rock_me_in)
+
+static int
+test_rockme2b(int n)
+{
+  r_rockme2b_t array;
+
+  r_rockme2b_init(array);
+  for(int i = 0; i < n; i++) {
+    rock_me_in rock;
+    rock->n = i*i - i;
+    r_rockme2b_push_back(array, rock);
+  }
+
+  int s = 0;
+  for(int i = 0; i < n; i++) {
+    // Get the pointer to the struct.
+    rock_me_in *p = r_rockme2b_get(array, i);
+    s += (*p)->n;
+  }
+  
+  r_rockme2b_clear(array);
+  
+  return s;
+}
+
+
+
+/* Same with a structure type defined as a tuple.
+
+   We first define a tuple. No need to specify the oplist as it uses basic C types
+   so M_DEFAULT_OPLIST is used.
+
+   Then we define the array, giving it the oplist definition of the tuple:
+   the macro TUPLE_OPLIST is used to build it based on the tuple name,
+   and the oplists of the tuple.
+ */
+TUPLE_DEF2(rock_you, (n, int), (other, float))
+
+ARRAY_DEF(r_rockme3, rock_you_t, TUPLE_OPLIST(rock_you, M_DEFAULT_OPLIST, M_DEFAULT_OPLIST))
+
+static int
+test_rockme3(int n)
+{
+  r_rockme3_t array;
+  rock_you_t  x;
+  
+  r_rockme3_init(array);
+  rock_you_init(x);
+  
+  for(int i = 0; i < n; i++) {
+    rock_you_set_n(x, i*i - i);
+    r_rockme3_push_back(array, x);
+  }
+
+  int s = 0;
+  for(int i = 0; i < n; i++) {
+    // Get the pointer to the structure containing the integer.
+    rock_you_t *p = r_rockme3_get(array, i);
+    s += (*p)->n;
+  }
+  
+  r_rockme3_clear(array);
+  rock_you_clear(x);
+  
+  return s;
+}
+
+
+
+/* Same with a structure type defined as a tuple using global registeration.
+
+   We first define a tuple. No need to specify the oplist as it uses basic C types
+   so M_DEFAULT_OPLIST is used.
+
+   Then we register the oplist of rock_us_t by defining a macro based
+   on M_OPL_ + type name + () which expands with the oplist of the type.
+
+   Then we define the array, giving it only the type.
+   M*LIB will look at the global registered oplist of the type, we don't
+   need to give it explictly.
+
+   Global registeration makes easier code.
+ */
+TUPLE_DEF2(rock_us, (n, int), (other, float))
+
+#define M_OPL_rock_us_t() TUPLE_OPLIST(rock_us, M_DEFAULT_OPLIST, M_DEFAULT_OPLIST)
+
+ARRAY_DEF(r_rockme4, rock_us_t)
+
+static int
+test_rockme4(int n)
+{
+  r_rockme4_t array;
+  rock_us_t  x;
+  
+  r_rockme4_init(array);
+  rock_us_init(x);
+  
+  for(int i = 0; i < n; i++) {
+    rock_us_set_n(x, i*i - i);
+    r_rockme4_push_back(array, x);
+  }
+
+  int s = 0;
+  for(int i = 0; i < n; i++) {
+    // Get the pointer to the structure containing the integer.
+    rock_us_t *p = r_rockme4_get(array, i);
+    s += (*p)->n;
+  }
+  
+  r_rockme4_clear(array);
+  rock_us_clear(x);
+  
+  return s;
+}
+
+
+int main (int argc, const char *argv[])
+{
+  int n = argc == 1 ? 10 : atoi(argv[1]);
+  int s;
+
+  s = test_bool(n);
+  printf ("S[bool] = %d\n", s);
+
+  s = test_char(n);
+  printf ("S[char] = %d\n", s);
+
+  s = test_int(n);
+  printf ("S[int] = %d\n", s);
+
+  s = test_int2(n);
+  printf ("S[int2] = %d\n", s);
+
+  s = test_ullong(n);
+  printf ("S[ullong] = %d\n", s);
+
+  s = test_float(n);
+  printf ("S[float] = %d\n", s);
+
+  s = test_double(n);
+  printf ("S[double] = %d\n", s);
+
+  s = test_cstring(n);
+  printf ("S[cstring] = %d\n", s);
+
+  s = test_string(n);
+  printf ("S[string] = %d\n", s);
+
+  s = test_vintptr(n);
+  printf ("S[vintptr] = %d\n", s);
+
+  s = test_rockme(n);
+  printf ("S[rockme] = %d\n", s);
+
+  s = test_rockme2(n);
+  printf ("S[rockme2] = %d\n", s);
+
+  s = test_rockme2b(n);
+  printf ("S[rockme2b] = %d\n", s);
+
+  s = test_rockme3(n);
+  printf ("S[rockme3] = %d\n", s);
+
+  s = test_rockme3(n);
+  printf ("S[rockme4] = %d\n", s);
+
+  exit(0);
+}

example/ex-array03.c

@@ -1,14 +1,14 @@
 #include <stdlib.h>
 #include "m-array.h"
 
-// Let's define an array of 'int' named 'int'
+// Let's define an array of 'int' named 'array_int'
 ARRAY_DEF(array_int, int)
 
 const int n = 100000;
 
 int main(void)
 {
-  // Declare and initilize the array
+  // Declare and initialize the array
   array_int_t x;
   array_int_init(x);
 

example/ex-array04.c

@@ -1,9 +1,13 @@
+#if HAVE_GMP
+
 #include <gmp.h>
 
 #include "m-array.h"
 #include "m-algo.h"
 
+/* Define an array of mpz_t */
 ARRAY_DEF(array_mpz, mpz_t, M_CLASSIC_OPLIST(mpz))
+/* Define some algorithm functions on array_mpz_t */
 ALGO_DEF(array_mpz, ARRAY_OPLIST(array_mpz, M_CLASSIC_OPLIST(mpz)))
 
 static inline void my_mpz_inc(mpz_t *d, const mpz_t a){
@@ -19,14 +23,22 @@ int main(void)
   mpz_init_set_ui(z, 1);
   array_mpz_t a;
   array_mpz_init(a);
+
   array_mpz_push_back(a, z);
   for(size_t i = 2 ; i < 1000; i++) {
     mpz_mul_ui(z, z, i);
     array_mpz_push_back(a, z);    
   }
-  /* z = sum (a[i]^2) */
+
+  /* Compute z = sum (a[i]^2) */
   array_mpz_map_reduce (&z, a, my_mpz_inc, my_mpz_sqr);
   gmp_printf ("Z=%Zd\n", z);
+
   array_mpz_clear(a);
   mpz_clear(z);
 }
+
+#else
+// Nothing to do
+int main(void) { return 0; }
+#endif

example/ex-array05.c

@@ -0,0 +1,116 @@
+#include "m-array.h"
+#include "m-string.h"
+
+/* This example show how to use complex structure with array 
+   embedding another library */
+
+/* This is a typical trivial library with its interface */
+typedef struct lib_ext_struct {
+  int id;
+  // Other data may be added
+} lib_ext_struct;
+
+/* Method to create a duplicate of the object.
+   The new object is heap allocated */
+static lib_ext_struct *lib_ext_struct_Duplicate(const lib_ext_struct *obj)
+{
+  lib_ext_struct *p = malloc(sizeof(lib_ext_struct));
+  if (!p) abort();
+  p->id = obj->id;
+  return p;
+}
+
+/* Method to delete any object */
+static void lib_ext_struct_Delete(lib_ext_struct *obj)
+{
+  free(obj);
+}
+
+/* This is the complex structure */
+typedef struct  {
+  uint32_t id;
+  string_t type;
+  lib_ext_struct* properties;
+} data_node;
+
+/* This method shall initialize the object data_node to
+   the init state.
+   It takes as first argument the object to initialize,
+   and since it takes by reference through a pointer,
+   it is compatible with 'API_2' convention for oplist */
+static void data_node_init(data_node *obj)
+{
+  obj->id = 0;
+  string_init(obj->type);
+  obj->properties = NULL;
+}
+
+/* This method shall initialize the object data_node to
+   the same state as the 'src' object (creating a copy, a duplicate) .
+   It takes as first argument the object to initialize,
+   and as second argument the source object.
+   It takes both object by reference through pointers,
+   as such it is compatible with 'API_6' convention for oplist */
+static void data_node_init_set(data_node *obj, const data_node *src)
+{
+  obj->id = src->id;
+  string_init_set(obj->type, src->type);
+  if (src->properties)
+    obj->properties = lib_ext_struct_Duplicate(src->properties);
+  else
+    obj->properties = NULL;
+}
+
+/* This method shall set the object data_node to
+   the same state as the 'src' object (creating a copy, a duplicate) .
+   THe object was already initialized.
+   It takes as first argument the object to initialize,
+   and as second argument the source object.
+   It takes both object by reference through pointers,
+   as such it is compatible with 'API_6' convention for oplist */
+static void data_node_set(data_node *obj, const data_node *src)
+{
+  obj->id = src->id;
+  string_set(obj->type, src->type);
+  if (obj->properties)
+    lib_ext_struct_Delete(obj->properties);    
+  if (src->properties)
+    obj->properties = lib_ext_struct_Duplicate(src->properties);
+  else
+    obj->properties = NULL;
+}
+
+/* This method shall clear the object data_node to
+   the cleared state (aka it shall free any resource).
+   It takes as first argument the object to initialize,
+   and since it takes by reference through a pointer,
+   it is compatible with 'API_2' convention for oplist */
+static void data_node_clear(data_node *obj)
+{
+  string_clear(obj->type);
+  if (obj->properties)
+    lib_ext_struct_Delete(obj->properties);
+}
+
+/* Create a dynamic array of 'data_node' named array_data_node_t
+   and gives the minimum oplist allowing M*LIB to handle
+   properly the object 'data_node' with the API convention
+   to respect for calling the methods.
+*/
+ARRAY_DEF(/* the array prefix */ array_data_node,
+	  /* the object type */ data_node,
+	  /* the object oplist */ (INIT(API_2(data_node_init)),
+				   SET(API_6(data_node_set)),
+				   INIT_SET(API_6(data_node_init_set)),
+				   CLEAR(API_2(data_node_clear))))
+
+/* Define a global array with the created type */
+array_data_node_t global_array;
+
+int main(void)
+{
+  /* Call the created method */
+  array_data_node_init(global_array);
+  /* Do stuff... */
+  array_data_node_clear(global_array);
+}

example/ex-bptree01.c

@@ -0,0 +1,65 @@
+#include "m-bptree.h"
+#include "m-string.h"
+
+// Define a map int -> string named map_employee_id
+// The number 5 is the number of elements in a node of the B+TREE
+BPTREE_DEF2(map_employee_id, 5, int, string_t)
+// Register the oplist of this map globally.
+#define M_OPL_map_employee_id_t() BPTREE_OPLIST2(map_employee_id, M_DEFAULT_OPLIST, STRING_OPLIST)
+
+// Define a map string -> int named map_employee_name
+// The number 5 is the number of elements in a node of the B+TREE
+BPTREE_DEF2(map_employee_name, 5, string_t, int)
+// Register the oplist of this map globally.
+#define M_OPL_map_employee_name_t() BPTREE_OPLIST2(map_employee_name, STRING_OPLIST, M_DEFAULT_OPLIST)
+
+int main(void)
+{
+  map_employee_id_t Employees;
+  map_employee_id_init(Employees);
+
+  // Assign the map with some data
+  map_employee_id_set_at(Employees, 17425, STRING_CTE("Mike"));
+  map_employee_id_set_at(Employees, 7147, STRING_CTE("Tango"));
+  map_employee_id_set_at(Employees, 841, STRING_CTE("Charlie"));
+  map_employee_id_set_at(Employees, 11632, STRING_CTE("John Do"));
+  map_employee_id_set_at(Employees, 852, STRING_CTE("Peter"));
+  map_employee_id_set_at(Employees, 530, STRING_CTE("Amanda"));
+  map_employee_id_set_at(Employees, 4258, STRING_CTE("Elisabeth"));
+
+  printf("Number of employees: %zu\n", map_employee_id_size(Employees));
+
+  // Iterate over the employee list
+  printf("\nList of employees (sorted by id):\n");
+  map_employee_id_it_t it;
+  for(map_employee_id_it(it, Employees); !map_employee_id_end_p(it); map_employee_id_next(it)) {
+    // Get a pointer to this employee from the iterator
+    const map_employee_id_itref_t *e = map_employee_id_cref(it);
+    // Print it
+    printf ("%d: %s\n", *(e->key_ptr), string_get_cstr(*(e->value_ptr)));
+  }
+
+  // Now, let's go using some macros!
+
+  // Let's create a reverse map
+  M_LET(Employees_r, map_employee_name_t) {
+
+    // Let's fill in the reverse map with each employee
+    // (using macro M_EACH)
+    for M_EACH(e, Employees, map_employee_id_t) {
+        map_employee_name_set_at(Employees_r, *(e->value_ptr), *(e->key_ptr));
+      }
+
+    // Iterate over the employee list
+    printf("\nList of employees (sorted by name):\n");
+    for M_EACH(e, Employees_r, map_employee_name_t) {
+        printf ("%d: %s\n", *(e->value_ptr), string_get_cstr(*(e->key_ptr)));
+      }
+
+    // Print
+    printf("\nElisabeth has id = %d\n", *map_employee_name_get(Employees_r, STRING_CTE("Elisabeth")));    
+  } /* Employees_r is cleared beyond this point */
+
+  map_employee_id_clear(Employees);
+  return 0;
+}

example/ex-defer01.c

@@ -0,0 +1,36 @@
+#include "m-core.h"
+
+// Stubs defined for the example. Real code will use soundio library.
+struct SoundIo { int x; };
+struct SoundIoDevice { int x; };
+struct SoundIoOutStream { int x; };
+
+static struct SoundIo *soundio_create(void) { return (struct SoundIo *) malloc(sizeof(struct SoundIo)); }
+static void soundio_destroy(struct SoundIo *s) { free(s); }
+
+static struct SoundIoDevice *soundio_get_device(struct SoundIo *io, int def) { (void) io; (void) def; return (struct SoundIoDevice *) malloc(sizeof(struct SoundIoDevice)); }
+static void soundio_device_unref(struct SoundIoDevice *s) { free(s); }
+
+static struct SoundIoOutStream *soundio_outstream_create(struct SoundIoDevice *device) { (void) device ; return (struct SoundIoOutStream *) malloc(sizeof(struct SoundIoOutStream)); }
+static void soundio_outstream_destroy(struct SoundIoOutStream *s) { free(s); }
+
+static bool soundio_wait_events(struct SoundIo *s) { (void) s; return false; }
+// End of stubs
+
+int main(void)
+{
+  int err = 1;
+
+  /* Example of using M_LET_IF macro to simplify writing error handling code.
+     The following code creates some object, test if the object creation succeeds, register the destructor, and print an error if something went wrong
+  */
+  M_LET_IF( struct SoundIo *soundio = soundio_create(), soundio != 0 , soundio_destroy(soundio) , fprintf(stderr, "out of memory for soundio\n") )
+    M_LET_IF(struct SoundIoDevice *device = soundio_get_device(soundio, -1), device != 0, soundio_device_unref(device),  fprintf(stderr, "out of memory for device\n"))
+    M_LET_IF(struct SoundIoOutStream *outstream = soundio_outstream_create(device), outstream != 0, soundio_outstream_destroy(outstream), fprintf(stderr, "out of memory for stream\n")) {
+    err = 0;
+    bool cont = true;
+    while (cont)
+      cont = soundio_wait_events(soundio);
+  }
+  return err;
+}

example/ex-dict01.c

@@ -5,7 +5,7 @@
 #include "m-string.h"
 
 // Define a dictionnary of string --> int
-// named 'str'
+// named 'dict_str'
 DICT_DEF2(dict_str, string_t, STRING_OPLIST, int, M_DEFAULT_OPLIST)
 
 int main(void)

example/ex-dict03.c

@@ -5,8 +5,9 @@
 #include "m-dict.h"
 #include "m-string.h"
 
-DICT_DEF2(dict_map, char, M_DEFAULT_OPLIST, int, M_DEFAULT_OPLIST)
-              
+// Define a dictionary (hashmap) from 'char' to 'int'
+DICT_DEF2(dict_map, char, int)
+             
 int main(void)
 {
   dict_map_t mp;
@@ -81,7 +82,7 @@ int main(void)
             }
           break;
 
-	case 7:
+        case 6:
           dict_map_clear(mp);
           string_clear (str);
           exit(0);
@@ -89,7 +90,7 @@ int main(void)
           
         default:
           printf("Wrong Choice\n");
+          break;
         }     
     }
 }
-    

example/ex-dict04.c

@@ -5,14 +5,23 @@
 /* program that reads text from standard-input, 
    and prints the total number of distinct words found in the text. 
 */
+
+/* Definition of a set (hashset) of unique string_t */
 DICT_SET_DEF(dict_str, string_t, STRING_OPLIST)
 
 int main(void)
 {
+  // Define word as a string_t
   M_LET(word, STRING_OPLIST)
-    M_LET(wordcount, DICT_SET_OPLIST(dict_str, STRING_OPLIST)) {
-    while (string_fget_word(word, " \t\n,.!;:?", stdin))
+  // Define wordcount as a set of string_t
+  M_LET(wordcount, DICT_SET_OPLIST(dict_str, STRING_OPLIST)) {
+    // Read a word from the standard input
+    while (string_fget_word(word, " \t\n,.!;:?", stdin)) {
+      // Push this word in the set.
+      // Do nothing if it already exists.
       dict_str_push(wordcount, word);
+    }
+    // Print the number of words of the standard input.
     printf ("Words: %zu\n", dict_str_size(wordcount));
   }
 }

example/ex-grep01.c

@@ -3,30 +3,54 @@
 #include "m-array.h"
 #include "m-dict.h"
 
+// Define an array of size_t
 ARRAY_DEF(array_size, size_t)
+// Register the oplist of this array globaly
 #define M_OPL_array_size_t() ARRAY_OPLIST(array_size)
+
+// Define a dictionary (hashmap) of string_t to array of size_t
 DICT_DEF2(map_pos, string_t, array_size_t)
+// Register the oplist of this dictionary (hashmap)
 #define M_OPL_map_pos_t() DICT_OPLIST(map_pos, STRING_OPLIST, ARRAY_OPLIST(array_size))
 
 int main(int argc, const char *argv[])
 {
-   if (argc == 2) {
-     M_LET(word, string_t)
-     M_LET(positions, map_pos_t) {
-        FILE *f = fopen(argv[1], "rt");
-        if (!f) return 1;
-        while (string_fget_word(word, " \t\n\r\"(),=", f)) {
-          array_size_t *array = map_pos_get_at(positions, word);
-          array_size_push_back(*array, (size_t)ftell(f) - string_size(word));
-        }
-        fclose(f);
-
-        for M_EACH(pair, positions, map_pos_t) {
-         string_fputs(stdout, pair->key);
-         for M_EACH(pos, pair->value, array_size_t)
-            printf(" %zu", *pos);
-         printf("\n");
-        }
-     }
+   if (argc != 2) {
+      printf("USAGE: %s filename\n", argv[0]);
+      exit(0);
    }
+
+   // Define word as a string_t
+   M_LET(word, string_t)
+   // Define positions as a map of string_t-->array of size_t
+   M_LET(positions, map_pos_t) {
+      // Open the file
+      FILE *f = fopen(argv[1], "rt");
+      if (!f) {
+         fprintf(stderr, "ERROR: Cannot open %s.\n", argv[1]);
+         return 1;
+      }
+
+      // While it reads some word from the file
+      while (string_fget_word(word, " \t\n\r\"(),=", f)) {
+         // Get the reference to the array of this word in the dictionnary (or create it if needed)
+         array_size_t *array = map_pos_get_at(positions, word);
+         // Push the new offset to this word in the associated array
+         array_size_push_back(*array, (size_t)ftell(f) - string_size(word));
+      }
+
+      // Close the file
+      fclose(f);
+
+      // Print the words and where they are:
+      for M_EACH(pair, positions, map_pos_t) {
+         string_fputs(stdout, pair->key);
+         for M_EACH(pos, pair->value, array_size_t) {
+            printf(" %zu", *pos);
+         }
+         printf("\n");
+         }
+      } // All created objects are destroyed beyond this point
+
+   return 0;
 }

example/ex-mph.c

@@ -24,22 +24,25 @@
 
 /* Define the needed data structure : */
 
-// Define a dictionnary of constant string --> integer
+// Define a dictionnary of constant string --> integer and register it.
 DICT_DEF2(dict_mph, const char *, M_CSTR_OPLIST, uint32_t, M_DEFAULT_OPLIST)
 #define M_OPL_dict_mph_t() DICT_OPLIST(dict_mph, M_CSTR_OPLIST, M_DEFAULT_OPLIST)
 
-// Defin an array of integer
+// Define an array of integer to store the value and register it.
 ARRAY_DEF(array_value, uint32_t) // Start from 1. 0 is 'None'
 #define M_OPL_array_value_t() ARRAY_OPLIST(array_value)
 
-// Defin an array of integer
+// Define an array of integer to store the seed and register it.
 ARRAY_DEF(array_seed, int32_t)
 #define M_OPL_array_seed_t() ARRAY_OPLIST(array_seed)
+// Define algorithms on array_seed
 ALGO_DEF(array_seed, array_seed_t)
 
 // Define an array of constant string that are ordered by their size.
 ARRAY_DEF(array_cstr, const char *, M_CSTR_OPLIST)
+// Register it globally but with a custom CMP operator
 static inline int array_cstr_cmp(const array_cstr_t a, const array_cstr_t b) {
+  // We compare only the size
   size_t sa = array_cstr_size(a);
   size_t sb = array_cstr_size(b);
   return (sa > sb) ? -1 : (sa < sb);
@@ -191,7 +194,11 @@ static void
 dict_read_from_file(dict_mph_t dict, array_string_t arr, const char filename[])
 {
   FILE *f = fopen(filename, "rt");
-  if (!f) abort();
+  if (!f) {
+    fprintf(stderr, "ERROR: Cannot open %s\n", filename);
+    exit(2);
+  }
+
   uint32_t line = 1;
   M_LET(str, string_t) {
     while (!feof(f) && !ferror(f)) {
@@ -234,12 +241,14 @@ test(array_seed_t seed, array_value_t value, dict_mph_t dict)
 
 int main(int argc, const char *argv[])
 {
+  // Create arr as array_string_t, dict as dist_mph_t and seed as array_seed_t
   M_LET(arr, array_string_t) M_LET(dict, dict_mph_t) M_LET(seed, array_seed_t)
+    // and value as array_value_t
     M_LET(value, array_value_t) {
-    const char *filename = (argc > 1) ? argv[1] :"/usr/share/dict/words";
-    dict_read_from_file(dict, arr, filename);
-    CreateMinimalPerfectHash(seed, value, dict);
-    test(seed, value, dict);
+      const char *filename = (argc > 1) ? argv[1] :"/usr/share/dict/words";
+      dict_read_from_file(dict, arr, filename);
+      CreateMinimalPerfectHash(seed, value, dict);
+      test(seed, value, dict);
   }
   
   return 0;

example/ex-multi01.c

@@ -4,6 +4,7 @@
 #include "m-array.h"
 #include "m-string.h"
 
+// Define an array of integer
 ARRAY_DEF(array_int, int)
 
 typedef struct {
@@ -25,7 +26,7 @@ static void tape_devance(tape_t tape) { if (tape->pos > 0) tape->pos--; }
 
 typedef struct {
   string_t code;
-  array_int_t bracket_map; // Should use map when possible.
+  array_int_t bracket_map;
 } program_t[1];
 
 static void program_init(program_t p, string_t text) {
@@ -98,7 +99,11 @@ static void program_run(program_t p){
 
 static void read_file(string_t str, const string_t filename) {
   FILE *f = fopen(string_get_cstr(filename), "rt");
-  if (!f) abort();
+  if (!f) {
+    fprintf(stderr, "ERROR: Cannot open %s\n", string_get_cstr(filename));
+    exit(2); 
+  }
+  // Read the full FILE in the string
   string_fgets (str, f, STRING_READ_FILE);
   fclose(f);
 }

example/ex-multi02.c

@@ -1,3 +1,5 @@
+#if HAVE_GMP
+
 #include <stdio.h>
 #include <gmp.h>
 
@@ -50,14 +52,19 @@ int main(void)
               // Dictionary iterator are pair (key,value)
               if (my_integer_n_p(p->value)) {
                 printf ("It is a long long, value = %lld\n",
-                        *my_integer_get_n(p->value));
+                        *my_integer_cget_n(p->value));
               }
               if (my_integer_z_p(p->value)) {
                 printf ("It is a mpz_t, value =");
-                mpz_out_str(stdout, 10, *my_integer_get_z(p->value));
+                mpz_out_str(stdout, 10, *my_integer_cget_z(p->value));
                 printf("\n");
               }
             }
         }
     } /* All variables are automatically cleared beyond this point */
 }
+
+#else
+// Nothing to do
+int main(void) { return 0; }
+#endif

example/ex-multi04.c

@@ -51,6 +51,9 @@ TUPLE_DEF2(mlib_points, (first_ref, mlib_point_ptr, M_PTR_OPLIST),
 
 static void let2(void)
 {
+  // Initialize p1 as mlib_point_t with (4,4)
+  // and p2 as mlib_point_t with (5,5)
+  // and pair as mlib_point_t with default value
   M_LET((p1, 4, 4), (p2, 5, 5), mlib_point_t) {
     M_LET(pair, mlib_points_t) {
       pair->first_ref = p1;
@@ -68,6 +71,7 @@ static void let2(void)
 
 static void let(void)
 {
+  // Let's initialize all the declared types
   M_LET(s, symbol_t)
     M_LET(l, symbol_list_t)
     M_LET(r,record_t)

example/ex-multi05.c

@@ -0,0 +1,31 @@
+#include <stdio.h>
+
+#include "m-array.h"
+#include "m-string.h"
+
+// Let's create an array of string_t and register it globaly
+ARRAY_DEF(vector_string, string_t)
+#define M_OPL_vector_string_t() ARRAY_OPLIST(vector_string, STRING_OPLIST)
+
+int main(void)
+{
+    // Let's define a new string named str
+    M_LET(str, string_t)
+    // Let's define msg as a vector_array_t
+    M_LET( (msg, STRING_CTE("Hello"), STRING_CTE("C"), STRING_CTE("World!"), STRING_CTE("Let's"), STRING_CTE("discover"), STRING_CTE("M*LIB!")), vector_string_t) {
+        // Iterate over all words of the array msg
+        for M_EACH(word, msg, vector_string_t) {
+            // Cat the current word into the target string
+            string_cat(str, *word);
+            // Also add a space character
+            string_push_back(str, ' ');
+        }
+        // Let's define another string and set it to a formatted value.
+        M_LET( (count, "\nTo display this it uses \"vector\" of %zu strings!", vector_string_size(msg)), string_t) {
+            string_cat(str, count);
+        }
+        // Print the result
+        printf("%s\n", string_get_cstr(str) );
+    }
+    return 0;
+}

example/ex-rbtree01.c

@@ -4,6 +4,15 @@
 
 #include "m-rbtree.h"
 
+// Let's define one utility function.
+void *xmalloc(size_t n);
+void *xmalloc(size_t n)
+{
+  void *p = malloc (n);
+  if (!p) abort();
+  return p;
+}
+
 // Let's define a new type.
 typedef struct {
   int  key;
@@ -12,7 +21,7 @@ typedef struct {
 
 #define SIZE 256
 
-void *xmalloc(size_t n);
+// Let's define the prototypes of the methods of this new type.
 void my_type_init(my_type_t x);
 void my_type_clear(my_type_t x);
 void my_type_init_set(my_type_t x, const my_type_t y);
@@ -24,13 +33,6 @@ void my_type_out_str(FILE *f, const my_type_t x);
 bool my_type_in_str(my_type_t x, FILE *f);
 void my_type_rand(my_type_t x);
 
-void *xmalloc(size_t n)
-{
-  void *p = malloc (n);
-  if (!p) abort();
-  return p;
-}
-
 // Let's define its constructor
 void my_type_init(my_type_t x)
 {

example/ex-string01.c

@@ -0,0 +1,53 @@
+#include <stdio.h>
+#include <string.h>
+
+#include "m-string.h"
+
+#define MAX_COLUMN 80
+
+static void format(FILE *f)
+{
+    string_t s;
+    string_init(s);
+    while (string_fgets(s, f, STRING_READ_PURE_LINE) == true)
+    {
+        size_t n = string_size(s);
+        if (n > 0 && string_get_char(s, n-1) == '\\' && n < MAX_COLUMN) {
+            string_left(s, n-1);
+            while (n < MAX_COLUMN-1) {
+                string_push_back(s, ' ');
+                n++;
+            }
+            string_push_back(s, '\\');
+        }
+        if (n >= MAX_COLUMN && string_get_char(s, n-1) == '\\') {
+            n--;
+            string_left(s, n);
+            while (n >= MAX_COLUMN-2 && string_get_char(s, n-1) == ' ') {
+                n--;
+                string_left(s, n);
+            }
+            string_push_back(s, ' ');
+            string_push_back(s, '\\');
+        }
+        printf("%s\n", string_get_cstr(s));
+    }
+    string_clear(s);
+}
+
+int main(int argc, const char *argv[])
+{
+    if (argc < 2)
+    {
+        fprintf(stderr, "ERROR: Missing argument filename.\nUSAGE: %s filename.h\n", argv[0]);
+        exit(1);
+    }
+    FILE *f = fopen(argv[1], "rt");
+    if (!f) {
+        fprintf(stderr, "ERROR: Cannot open filename '%s' .h\n", argv[1]);
+        exit(2);
+    }
+    format(f);
+    fclose(f);
+    exit(0);
+}

example/ex-string02.c

@@ -0,0 +1,91 @@
+#include "m-array.h"
+#include "m-string.h"
+
+// Define an array of string_t. Since the oplist of string_t is registered globaly
+// there is no need to give it to this definition.
+ARRAY_DEF(str_array, string_t)
+
+// First the verbose way and (nearly) macro free:
+static void main_macrofree(void)
+{
+    str_array_t tab_name;
+    str_array_init(tab_name);
+
+    // Push some elements in the array (long way)
+    str_array_push_back(tab_name, STRING_CTE("My"));
+    str_array_push_back(tab_name, STRING_CTE("CD"));
+    str_array_push_back(tab_name, STRING_CTE("IS"));
+    str_array_push_back(tab_name, STRING_CTE("OUT"));
+
+    // Overwrite element 1 of the array.
+    str_array_set_at(tab_name, 1, STRING_CTE("DVD"));
+
+    // Format some strings and push them back in the array
+    string_t format;
+    string_init_printf(format, "There are %d elements", str_array_size(tab_name));
+    str_array_push_back(tab_name, format);
+    string_printf(format, "There is a capacty of %d", str_array_capacity(tab_name));
+    string_replace_all_str(format, "capacty", "capacity");
+    str_array_push_back(tab_name, format);
+    string_printf(format, "The third element is '%s'", string_get_cstr(*str_array_get(tab_name, 2)));
+    str_array_push_back(tab_name, format);
+    string_clear(format);
+
+    // Display the content of the array.
+    str_array_it_t it;
+    int i = 0;
+    for (str_array_it(it, tab_name) ; !str_array_end_p(it); str_array_next(it)) {
+        printf("item[%d] = '%s'\n", i, string_get_cstr(*str_array_cref(it)) );
+        i++;
+    }
+
+    // Clear the array
+    str_array_clear(tab_name);
+}
+
+// Then the short version with macros. 
+// For this we need to register the oplist of the array of string globally.
+#define M_OPL_str_array_t() ARRAY_OPLIST(str_array, STRING_OPLIST)
+
+static void main_macro(void)
+{
+    // Define and fill an array of string with some elements in it:
+    M_LET( (tab_name, STRING_CTE("My"), STRING_CTE("CD"), STRING_CTE("IS"), STRING_CTE("OUT")), str_array_t) {
+        // Overwrite element 1 of the array.
+        str_array_set_at(tab_name, 1, STRING_CTE("DVD"));
+
+        // Format some strings and push them back in the array
+        M_LET(format, string_t) {
+            string_printf(format, "There are %d elements", str_array_size(tab_name));
+            str_array_push_back(tab_name, format);
+            string_printf(format, "There is a capacty of %d", str_array_capacity(tab_name));
+            string_replace_all_str(format, "capacty", "capacity");
+            str_array_push_back(tab_name, format);
+            string_printf(format, "The third element is '%s'", string_get_cstr(*str_array_get(tab_name, 2)));
+            str_array_push_back(tab_name, format);
+#if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L
+            // Set format to a formated string
+            // In C11, we can mix string_t and char *.
+            // We can also use M_CSTR to create a printf formated string.
+            string_sets(format, "FILE=", getenv("PWD"), "/", *str_array_get(tab_name, 2), M_CSTR("-%d.txt", str_array_size(tab_name) ));
+            str_array_push_back(tab_name, format);
+#endif
+        } // beyond this point format is cleared
+
+        // Display the content of the array.
+        int i = 0;
+        for M_EACH(item, tab_name, str_array_t) {
+            printf("item[%d] = '%s'\n", i, string_get_cstr(*item) );
+            i++;
+        }
+    } // beyond this point tab_name is cleared
+}
+
+int main(void)
+{
+    printf("Version macrofree:\n");
+    main_macrofree();
+    printf("Version macro:\n");
+    main_macro();
+    return 0;
+}

example/ex11-algo01.c

@@ -0,0 +1,37 @@
+/* Based on https://en.cppreference.com/w/cpp/algorithm/for_each
+   Need to be built in C11 mode */
+
+#include <stdio.h>
+#include "m-array.h"
+#include "m-algo.h"
+
+/* Define a dynamic array of int */ 
+ARRAY_DEF(vector_int, int)
+#define M_OPL_vector_int_t() ARRAY_OPLIST(vector_int)
+
+/* Define operator increment on int */
+#define INC(n) (n)++
+
+int main(void)
+{
+  M_LET( (nums, 3, 4, 2, 8, 15, 267), vector_int_t) {
+    // Print the array before
+    printf ("before:");
+    ALGO_FOR_EACH(nums, vector_int_t, M_PRINT, " ");
+    printf ("\n");
+
+    // Increment each element of the array
+    ALGO_FOR_EACH(nums, vector_int_t, INC);
+    
+    // Print the array after
+    printf ("after: ");
+    ALGO_FOR_EACH(nums, vector_int_t, M_PRINT, " ");
+    printf ("\n");
+
+    // Sum the elements of the array
+    int sum = 0;
+    ALGO_REDUCE(sum, nums, vector_int_t, add);
+    M_PRINT("sum = ", sum, "\n");
+  }
+  return 0;
+}

example/ex11-algo02.c

@@ -0,0 +1,91 @@
+#include "m-tuple.h"
+#include "m-array.h"
+#include "m-algo.h"
+#include "m-funcobj.h"
+#include "m-serial-json.h"
+#include "m-string.h"
+
+/* Define the employee */
+TUPLE_DEF2(employee,
+           (name, string_t),
+           (age, int),
+           (idnum, int))
+#define M_OPL_employee_t() TUPLE_OPLIST(employee, STRING_OPLIST, M_DEFAULT_OPLIST, M_DEFAULT_OPLIST)
+
+/* Define an array of employee and some algorithms on it */
+ARRAY_DEF(vector_employee, employee_t)
+#define M_OPL_vector_employee_t() ARRAY_OPLIST(vector_employee, M_OPL_employee_t())
+ALGO_DEF(vector_employee, vector_employee_t)
+
+/* Define the function object to select the sort order
+ * named 'compare_by' which is an instance of the interface
+ * 'vector_employee_cmp_obj' created by ALGO_DEF.
+ */
+FUNC_OBJ_INS_DEF(compare_by /* name of the instance */,
+                 vector_employee_cmp_obj /* name of the interface */,
+                 (a, b) /* name of the input parameters of the function like object. The type are inherited from the interface. */, {
+                   /* code of the function object */
+                   if (string_equal_str_p(self->sort_field, "name"))
+                     return string_cmp(a->name, b->name);
+                   else if (string_equal_str_p(self->sort_field, "age"))
+                     return a->age < b->age ? -1 : a->age > b->age;
+                   else
+                     return a->idnum < b->idnum ? -1 : a->idnum > b->idnum;
+                 },
+                 /* Additional fields stored in the function object */
+                 (sort_field, string_t) )
+#define M_OPL_compare_by_t() FUNC_OBJ_INS_OPLIST(compare_by, STRING_OPLIST)
+
+// Let's read an array of person from the given JSON file
+static void read(vector_employee_t base, const char filename[])
+{
+  m_serial_return_code_t ret;
+
+  // Open the file
+  FILE *f = fopen(filename, "rt");
+  if (!f) {
+    // Handle errors
+    fprintf(stderr, "ERROR: Cannot open file '%s'.\n", filename);
+    exit(2);
+  }
+
+  // Initialize the JSON serializer with this file
+  M_LET( (in,f), m_serial_json_read_t)
+    // Read the JSON file and fill in 'base' with it.
+    ret = vector_employee_in_serial(base, in);
+
+  // Let's handle serialization error
+  if (ret != M_SERIAL_OK_DONE) {
+    fprintf(stderr, "ERROR: Cannot read JSON data from file '%s'.\nParsing stops at:\n", filename);
+    while (!feof(f)) { fputc(fgetc(f), stdout); }
+    fclose(f);
+    exit(2);
+  }
+
+  // Close the FILE
+  fclose(f);
+}
+
+int main(void)
+{
+  M_LET(emps, vector_employee_t) {
+    /* Code to populate database from JSON */
+    read(emps, "ex11-algo02.json");
+    
+    // Sort the database by employee ID number
+    M_LET( (cmp, STRING_CTE("idnum")), compare_by_t )
+      vector_employee_sort_fo(emps, compare_by_as_interface(cmp));
+    printf("Employees sorted by idnum are: ");
+    vector_employee_out_str(stdout, emps);
+
+    // Sort the database by employee name
+    M_LET( (cmp, STRING_CTE("name")), compare_by_t )
+      vector_employee_sort_fo(emps, compare_by_as_interface(cmp));
+    printf("\nEmployees sorted by name are: ");
+    vector_employee_out_str(stdout, emps);
+    printf("\n");
+
+    // End
+  }
+  return 0;
+}

example/ex11-algo02.json

@@ -0,0 +1,9 @@
+[
+    { "name": "John Doe", "age": 32, "idnum": 14528},
+    { "name": "Clint Smith", "age": 31, "idnum": 14529},
+    { "name": "Linda Cameron", "age": 20, "idnum": 14527},
+    { "name": "Cameron Carrey", "age": 25, "idnum": 14526},
+    { "name": "Marty Brown", "age": 26, "idnum": 14525},
+    { "name": "Donald Cow", "age": 45, "idnum": 14520}    
+]
+

example/ex11-json01.c

@@ -0,0 +1,60 @@
+#include "m-serial-json.h"
+#include "m-tuple.h"
+#include "m-array.h"
+
+// Let's define a 'person' composed of several fields.
+TUPLE_DEF2(person,
+           (surname, string_t),
+           (age, int),
+           (present, bool)
+           )
+// Register the oplist of this tuple globaly
+#define M_OPL_person_t() TUPLE_OPLIST(person, M_DEFAULT_OPLIST, STRING_OPLIST, M_DEFAULT_OPLIST )
+
+// Let's define an array of person
+ARRAY_DEF(base, person_t)
+// Register the oplist of this array globaly
+#define M_OPL_base_t() ARRAY_OPLIST(base, M_OPL_person_t())
+
+// Let's read an array of person from the given JSON file
+static void read(base_t base, const char filename[])
+{
+  m_serial_read_t  in;
+  m_serial_return_code_t ret;
+
+  // Open the file
+  FILE *f = fopen(filename, "rt");
+  if (!f) {
+    fprintf(stderr, "ERROR: Cannot open file '%s'.\n", filename);
+    exit(2);
+  }
+
+  // Initialize the serializer with the file
+  m_serial_json_read_init(in, f);
+  // Read the array
+  ret = base_in_serial(base, in);
+  if (ret != M_SERIAL_OK_DONE) {
+    fprintf(stderr, "ERROR: Cannot read JSON data from file '%s'.\n", filename);
+    exit(2);
+  }
+  // Let's close & clear all
+  m_serial_json_read_clear(in);
+  fclose(f);
+}
+
+int main(void)
+{
+  // Let's have base as a base_t
+  M_LET(base, base_t) {
+    // Read the JSON file and fill-in base
+    read(base, "ex11-json01.json");
+    // Print the contents of base:
+    printf ("List of presents:\n");
+    for M_EACH(el, base, base_t) {
+      if ((*el)->present) {
+        printf("%s\n", string_get_cstr((*el)->surname));
+      }
+    }
+  }
+  exit(0);    
+}

example/ex11-json01.json

@@ -0,0 +1,7 @@
+[
+    { "surname": "Angel", "age": 1, "present": false},
+    { "surname": "Snake", "age": 2, "present": true},
+    { "surname": "BallOfBase", "age": 5, "present": true}
+]
+
+    

example/ex11-section.c

@@ -1,5 +1,3 @@
-#if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L
-
 #include <stdio.h>
 
 #include "m-array.h"
@@ -7,12 +5,15 @@
 #include "m-dict.h"
 #include "m-string.h"
 
+// Let's define a tuple composed of (offset, value) and register it
 TUPLE_DEF2(symbol, (offset, long), (value, long))
 #define M_OPL_symbol_t() TUPLE_OPLIST(symbol, M_DEFAULT_OPLIST, M_DEFAULT_OPLIST)
 
+// Let's define an array of such tuple and register it
 ARRAY_DEF(array_symbol, symbol_t)
 #define M_OPL_array_symbol_t() ARRAY_OPLIST(array_symbol, M_OPL_symbol_t())
 
+// Let's define a dictionnary associating a string_t to such an array and register it
 DICT_DEF2(sections, string_t, array_symbol_t)
 #define M_OPL_sections_t() DICT_OPLIST(sections, STRING_OPLIST, M_OPL_array_symbol_t())
 
@@ -20,13 +21,21 @@ int main(int argc, const char *argv[])
 {
   if (argc < 2) abort();
   FILE *f = fopen(argv[1], "rt");
-  if (!f) abort();
+  if (!f) {
+    fprintf(stderr, "ERROR: Cannot open %s\n", argv[1]);
+    return 2;
+  }
+
+  // Create & initialize sc as sections_t
   M_LET(sc, sections_t) {
+    // Read the section from the FILE
     sections_in_str(sc, f);
+    // Get the section named .text
     array_symbol_t *a = sections_get(sc, STRING_CTE(".text"));
     if (a == NULL) {
       printf("There is no .text section.");
     } else {
+      // Print its content
       printf("Section .text is :");
       array_symbol_out_str(stdout, *a);
       printf("\n");
@@ -34,7 +43,3 @@ int main(int argc, const char *argv[])
   }
   return 0;
 }
-
-#else
-int main(void) { return 0; }
-#endif

m-atomic.h

@@ -1,7 +1,7 @@
 /*
  * M*LIB - Thin stdatomic wrapper for C++ compatibility
  *
- * Copyright (c) 2017-2019, Patrick Pelissier
+ * Copyright (c) 2017-2021, Patrick Pelissier
  * All rights reserved.
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -26,14 +26,17 @@
 #define MSTARLIB_ATOMIC_H
 
 /* NOTE: Due to the C++ not having recognized stdatomic.h officialy,
-   it is hard to use this header directly with a C++ compiler like 
-   g++ or MSVC.
-   (See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=60932 ).
-   clang has no issue with this header.
-   GCC 4.9 doesn't have a working implementation of 'atomic'
+   it is hard to use this header directly with a C++ compiler.
+   See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=60932
+   clang++ has no issue with this header but if someone includes 
+   atomic from C++, there is incompatibility between atomic & stdatomic.
+   Moreover some compilers lack a working stdatomic header.
+   GCC 4.9 doesn't have a working implementation of 'atomic'.
+   APPLE Clang defines __GNUC__ to be only 4 despite having full support
+   for atomic.
 */
-#if defined(__cplusplus) && __cplusplus >= 201103L	\
-  && !defined(__clang__) && !(defined(__GNUC__) && __GNUC__ < 5)
+#if defined(__cplusplus) && __cplusplus >= 201103L                            \
+  && !(defined(__GNUC__) && __GNUC__ < 5 && !defined(__APPLE__))
 
 /* NOTE: This is what the stdatomic.h header shall do in C++ mode. */
 #include <atomic>
@@ -96,14 +99,38 @@ using std::memory_order_release;
 using std::memory_order_acq_rel;
 using std::memory_order_seq_cst;
 
+/* CLANG provides a warning on defining _Atomic as it sees it 
+ * as a reserved system macro. It is true. However, the goal of this
+ * header is to provide stdatomic semantic, so it needs to define
+ * _Atomic macro.
+ *
+ * So, this warning has to be ignored.
+ *
+ * It cannot use M_BEGIN_PROTECTED_CODE as this header is normally
+ * independent of m-core.h
+ */
+#if defined(__clang__) && __clang_major__ >= 4
+  _Pragma("clang diagnostic push")
+  _Pragma("clang diagnostic ignored \"-Wreserved-id-macro\"")
+#endif
+
 #define _Atomic(T) std::atomic< T >
 
-#elif (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L)        \
-  || ( defined(__GNUC__) && !defined(__clang__) && !defined(__cplusplus) && (__GNUC__*100 + __GNUC_MINOR__) >= 409) \
-  || (defined(__clang__) && __clang_major__ >= 4)
+#if defined(__clang__) && __clang_major__ >= 4
+  _Pragma("clang diagnostic pop")
+#endif
+
+/* C11 with working stdatomic
+   STDATOMIC doesn't work with C++ except for clang but is incompatible with atomic.
+   GCC < 4.9 doesn't provide a compliant stdatomic.h
+   CLANG 3.5 has issues with GCC's stdatomic.h and doesn't provide its own
+   ICC < 18 doesn't provide a compliant stdatomic.h
+*/
+#elif (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L && !defined(__STDC_NO_ATOMICS__) ) \
+  || (defined(__GNUC__) && !defined(__clang__) && !defined(__INTEL_COMPILER) && !defined(__cplusplus) && (__GNUC__*100 + __GNUC_MINOR__) >= 409) \
+  || (defined(__clang__) && (__clang_major__ * 100 + __clang_minor__) >= 308) \
+  || (defined(__INTEL_COMPILER) && __INTEL_COMPILER >= 1800)
 
-/* CLANG 3.5 has issues with GCC's stdatomic.h
-   and doesn't provide its own stdatomic.h */
 #include <stdatomic.h>
 
 /* MSYS2 has a conflict between cdefs.h which defines a _Atomic macro (if not C11)
@@ -118,32 +145,38 @@ using std::memory_order_seq_cst;
 # undef _Atomic
 #endif
 
-#else
-
-/* Non working atomic.h, nor working stdatomic.h found.
+/* Non working C++ atomic header, nor working stdatomic.h found.
    Write a compatible layer using mutex as slin as possible.
    Supports only up to 64-bits atomic (sizeof long long to be more precise).
    The locks are never properly cleared and remain active until
    the end of the program.
-   We also assume that the call to the atomic_* interface is "clean".
+   We also assume that the call to the atomic_* interface is "macro clean".
 */
-#include "m-mutex.h"
+#else
 
-/* The structure is quite large:
+#include "m-mutex.h"
+#include "m-core.h"
+
+M_BEGIN_PROTECTED_CODE
+
+/* _Atomic qualifier for a type (emulation).
+  The structure is quite large:
    _val     : value of the atomic type,
    _zero    : zero value of the atomic type (constant),
    _previous: temporary value used within the mutex lock,
    _lock    : the mutex lock.
+  Support up to sizeof (long long) type.
  */
-#define	_Atomic(T)                              \
-  struct {                                      \
-    T volatile _val;                            \
-    T          _zero;                           \
-    T          _previous;                       \
-    m_mutex_t  _lock;                           \
+#define        _Atomic(T)                                                     \
+  struct {                                                                    \
+    T volatile _val;                                                          \
+    T          _zero;                                                         \
+    T          _previous;                                                     \
+    m_mutex_t  _lock;                                                         \
   }
 
-/* Even if memory order is defined, only the strongest constraint is used */
+/* Define the supported memory order.
+   Even if memory order is defined, only the strongest constraint is used */
 typedef enum {
   memory_order_relaxed,
   memory_order_consume,
@@ -184,76 +217,96 @@ typedef _Atomic(ptrdiff_t)          atomic_ptrdiff_t;
 #endif
 
 /* Detect if stdint.h was included */
-#if (defined (INTMAX_C) && defined (UINTMAX_C) && !defined(__cplusplus)) || \
-  defined (_STDINT_H) || defined (_STDINT_H_) || defined (_STDINT) ||   \
+#if (defined (INTMAX_C) && defined (UINTMAX_C) && !defined(__cplusplus)) ||   \
+  defined (_STDINT_H) || defined (_STDINT_H_) || defined (_STDINT) ||         \
   defined (_SYS_STDINT_H_)
+/* Define additional atomic types */
 typedef _Atomic(intmax_t)           atomic_intmax_t;
 typedef _Atomic(uintmax_t)          atomic_uintmax_t;
 #endif
 
-/* Unlock the mutex and return the given value */
+/* (INTERNAL) Unlock the mutex and return the given value */
 static inline long long atomic_fetch_unlock (m_mutex_t *lock, long long val)
 {
   m_mutex_unlock (*lock);
   return val;
 }
 
-/* This is the heart of the wrapper:
+/* (INTERNAL) This is the heart of the wrapper:
    lock the atomic value, read it and returns the value.
    In order to avoid any compiler extension, we need to transform the
    atomic type into 'long long' then convert it back to its value.
    This is because _previous can't be read after the lock, and we can't
    generate temporary variable within a macro.
    The trick is computing _val - _zero within the lock, then
-   returns retvalue + _zero after the lock.
+   returns retvalue + _zero after the release of the lock.
 */
-#define atomic_fetch_op(ptr, val, op)                                   \
-  (m_mutex_lock((ptr)->_lock),                                          \
-   (ptr)->_previous = (ptr)->_val,                                      \
-   (ptr)->_val op (val),                                                \
-   atomic_fetch_unlock(&(ptr)->_lock, (ptr)->_previous-(ptr)->_zero)+(ptr)->_zero)
+#define atomic_fetch_op(ptr, val, op)                                         \
+  (m_mutex_lock((ptr)->_lock),                                                \
+   (ptr)->_previous = (ptr)->_val,                                            \
+   (ptr)->_val op (val),                                                      \
+   atomic_fetch_unlock(&(ptr)->_lock, (long long)((ptr)->_previous-(ptr)->_zero))+(ptr)->_zero)
 
+/* Perform an atomic add (EMULATION) */
 #define atomic_fetch_add(ptr, val) atomic_fetch_op(ptr, val, +=)
+/* Perform an atomic sub (EMULATION) */
 #define atomic_fetch_sub(ptr, val) atomic_fetch_op(ptr, val, -=)
+/* Perform an atomic or (EMULATION) */
 #define atomic_fetch_or(ptr, val)  atomic_fetch_op(ptr, val, |=)
+/* Perform an atomic xor (EMULATION) */
 #define atomic_fetch_xor(ptr, val) atomic_fetch_op(ptr, val, ^=)
+/* Perform an atomic and (EMULATION) */
 #define atomic_fetch_and(ptr, val) atomic_fetch_op(ptr, val, &=)
+/* Perform an atomic exchange (EMULATION) */
 #define atomic_exchange(ptr, val)  atomic_fetch_op(ptr, val, =)
 
+/* Initialize an atomic GLOBAL variable */
 #define ATOMIC_VAR_INIT(val) { val, 0, 0, M_MUTEXI_INIT_VALUE }
 
-#define atomic_init(ptr, val)                                           \
+/* Initialize an atomic variable */
+#define atomic_init(ptr, val)                                                 \
   (m_mutex_init((ptr)->_lock), (ptr)->_val = val, (ptr)->_zero = 0)
 
-#define atomic_load_lock(ptr)                                           \
-  (m_mutex_lock((ptr)->_lock),                                          \
-   (ptr)->_previous = (ptr)->_val,                                      \
-   atomic_fetch_unlock(&(ptr)->_lock, (ptr)->_previous-(ptr)->_zero)+(ptr)->_zero)
+/* (INTERNAL) Load an atomic variable within a lock
+   (needed for variable greater than CPU atomic size) */
+#define atomic_load_lock(ptr)                                                 \
+  (m_mutex_lock((ptr)->_lock),                                                \
+   (ptr)->_previous = (ptr)->_val,                                            \
+   atomic_fetch_unlock(&(ptr)->_lock, (long long) ((ptr)->_previous-(ptr)->_zero))+(ptr)->_zero)
 
-#define atomic_store_lock(ptr, val)                                     \
-  (m_mutex_lock((ptr)->_lock),                                          \
-   (ptr)->_val = (val),                                                 \
+/* (INTERNAL) Store an atomic variable within a lock
+   (needed for variable greater than CPU atomic size) */
+#define atomic_store_lock(ptr, val)                                           \
+  (m_mutex_lock((ptr)->_lock),                                                \
+   (ptr)->_val = (val),                                                       \
    m_mutex_unlock((ptr)->_lock))
 
-#define atomic_load(ptr)                                                \
-  ( sizeof ((ptr)->_val) <= ATOMICI_MIN_RW_SIZE                         \
-    ? (ptr)->_val                                                       \
+/* Atomic load of a variable (EMULATION)
+   If the atomic type size is not greater than the CPU atomic size,
+   we can perform a direct read of the variable (much faster) */
+#define atomic_load(ptr)                                                      \
+  ( sizeof ((ptr)->_val) <= ATOMICI_MIN_RW_SIZE                               \
+    ? (ptr)->_val                                                             \
     : atomic_load_lock(ptr))
   
-#define atomic_store(ptr, val) do {                                     \
-    if ( sizeof ((ptr)->_val) <= ATOMICI_MIN_RW_SIZE) {                 \
-      (ptr)->_val = (val);                                              \
-    } else {                                                            \
-      long long _offset = (val) - (ptr)->_zero;                         \
-      atomic_store_lock(ptr, (ptr)->_zero + _offset);                   \
-    }                                                                   \
+/* Atomic store of a variable (EMULATION)
+   If the atomic type size is not greater than the CPU atomic size,
+   we can perform a direct write of the variable (much faster) */
+#define atomic_store(ptr, val) do {                                           \
+    if ( sizeof ((ptr)->_val) <= ATOMICI_MIN_RW_SIZE) {                       \
+      (ptr)->_val = (val);                                                    \
+    } else {                                                                  \
+      long long _offset = (long long) ((val) - (ptr)->_zero);                 \
+      atomic_store_lock(ptr, (ptr)->_zero + _offset);                         \
+    }                                                                         \
   } while (0)
 
-#define atomic_compare_exchange_strong(ptr, exp, val)                  \
-  (m_mutex_lock((ptr)->_lock),                                         \
-   atomic_fetch_unlock(&(ptr)->_lock,                                  \
-                       (ptr)->_val == *(exp)                           \
-                       ? ((ptr)->_val = (val), true)                   \
+/* Perform a CAS (Compare and swap) operation (EMULATION) */
+#define atomic_compare_exchange_strong(ptr, exp, val)                         \
+  (m_mutex_lock((ptr)->_lock),                                                \
+   atomic_fetch_unlock(&(ptr)->_lock,                                         \
+                       (ptr)->_val == *(exp)                                  \
+                       ? ((ptr)->_val = (val), true)                          \
                        : (*(exp) = (ptr)->_val, false)))
 
   
@@ -273,7 +326,9 @@ static inline long long atomic_fetch_unlock (m_mutex_t *lock, long long val)
 #define atomic_compare_exchange_weak_explicit(ptr, exp, val, mem1, mem2)   atomic_compare_exchange_strong(ptr, exp, val)
 #define atomic_compare_exchange_weak(ptr, exp, val)                        atomic_compare_exchange_strong(ptr, exp, val)
 
-/* TODO: Missing atomic_flag. Problem: it needs to be lock free! */
+/* TODO: Missing atomic_flag. Problem: it is supposed to be lock free! */
+
+M_END_PROTECTED_CODE
 
 #endif
 

m-bitset.h

@@ -1,7 +1,7 @@
 /*
  * M*LIB - BITSET module
  *
- * Copyright (c) 2017-2019, Patrick Pelissier
+ * Copyright (c) 2017-2021, Patrick Pelissier
  * All rights reserved.
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -30,10 +30,12 @@
 
 /********************************** INTERNAL ************************************/
 
-// Define the limb of a bitset
-typedef uint64_t bitset_limb;
-// And its size
-#define BITSET_LIMB_BIT (sizeof(bitset_limb) * CHAR_BIT)
+M_BEGIN_PROTECTED_CODE
+
+// Define the basic limb of a bitset
+typedef uint64_t bitset_limb_ct;
+// And its size in bits
+#define BITSET_LIMB_BIT (sizeof(bitset_limb_ct) * CHAR_BIT)
 
 // bitset grow policy. n is limb size
 #define BITSETI_INC_ALLOC_SIZE(n) ((n) < 4 ? 4 : (n) * 2)
@@ -45,43 +47,51 @@ typedef uint64_t bitset_limb;
 #define BITSETI_FROM_ALLOC(n)     ((n) * BITSET_LIMB_BIT)
 
 // Contract of a bitset
-#define BITSETI_CONTRACT(t) do {					\
-    assert (t != NULL);							\
-    assert (t->size <= BITSETI_FROM_ALLOC (t->alloc));			\
-    assert (t->alloc <= ((size_t)-1) / BITSET_LIMB_BIT);		\
-    assert (t->size < ((size_t)-1) - BITSET_LIMB_BIT);			\
-    assert (t->size == 0 || t->ptr != NULL);				\
+#define BITSETI_CONTRACT(t) do {                                              \
+    M_ASSERT (t != NULL);                                                     \
+    M_ASSERT (t->size <= BITSETI_FROM_ALLOC (t->alloc));                      \
+    M_ASSERT (t->alloc <= ((size_t)-1) / BITSET_LIMB_BIT);                    \
+    M_ASSERT (t->size < ((size_t)-1) - BITSET_LIMB_BIT);                      \
+    M_ASSERT (t->size == 0 || t->ptr != NULL);                                \
+    M_ASSERT (t->alloc == 0 || t->ptr != NULL);                               \
   } while (0)
 
 
 /********************************** EXTERNAL ************************************/
 
+/* Define a type of variable 'bits' or array of packed booleans */
 typedef struct bitset_s {
   size_t size;            // Size is the number of bits
   size_t alloc;           // Alloc is the number of allocated limbs
-  bitset_limb *ptr;       // Pointer to the allocated limbs
+  bitset_limb_ct *ptr;    // Pointer to the allocated limbs
 } bitset_t[1];
 
+/* Pointer to a bitset_t */
 typedef struct bitset_s *bitset_ptr;
+
+/* Constant Pointer to a bitset_t */
 typedef const struct bitset_s *bitset_srcptr;
 
+/* Iterator on a bitset */
 typedef struct bitset_it_s {
   size_t index;           // index to the array of bit
   bool   value;           // value used for _ref & _cref to store the value
   struct bitset_s *set;   // the associated bitset
 } bitset_it_t[1];
 
+/* Initialize a bitset (CONSTRUCTOR) */
 static inline void
 bitset_init(bitset_t t)
 {
-  assert (t != NULL);
-  assert (M_POWEROF2_P(BITSET_LIMB_BIT));
+  M_ASSERT (t != NULL);
+  M_STATIC_ASSERT (M_POWEROF2_P(BITSET_LIMB_BIT), MLIB_INTERNAL, "M*LIB: BITSET LIMB shall be a power of 2.");
   t->size = 0;
   t->alloc = 0;
   t->ptr = NULL;
   BITSETI_CONTRACT(t);
 }
 
+/* Clean a bitset */
 static inline void
 bitset_clean(bitset_t t)
 {
@@ -89,16 +99,20 @@ bitset_clean(bitset_t t)
   t->size = 0;
 }
 
+/* Clear a bitset (DESTRUCTOR) */
 static inline void
 bitset_clear(bitset_t t)
 {
   bitset_clean(t);
   M_MEMORY_FREE(t->ptr);
   // This is not really needed, but is safer
-  t->alloc = 0;
+  // This representation is invalid and will be detected by the contract.
+  // A C compiler should be able to optimize out theses initializations.
+  t->alloc = 1;
   t->ptr = NULL;
 }
 
+/* Set a bitset to another one */
 static inline void
 bitset_set(bitset_t d, const bitset_t s)
 {
@@ -107,7 +121,7 @@ bitset_set(bitset_t d, const bitset_t s)
   if (M_UNLIKELY (d == s)) return;
   const size_t needAlloc = BITSETI_TO_ALLOC (s->size);
   if (s->size > BITSETI_FROM_ALLOC (d->alloc)) {
-    bitset_limb *ptr = M_MEMORY_REALLOC (bitset_limb, d->ptr, needAlloc);
+    bitset_limb_ct *ptr = M_MEMORY_REALLOC (bitset_limb_ct, d->ptr, needAlloc);
     if (M_UNLIKELY (ptr == NULL)) {
       M_MEMORY_FULL(needAlloc);
       return ;
@@ -115,19 +129,21 @@ bitset_set(bitset_t d, const bitset_t s)
     d->ptr = ptr;
     d->alloc = needAlloc;
   }
-  memcpy (d->ptr, s->ptr, needAlloc * sizeof(bitset_limb) );
+  memcpy (d->ptr, s->ptr, needAlloc * sizeof(bitset_limb_ct) );
   d->size = s->size;
   BITSETI_CONTRACT(d);
 }
 
+/* Initialize & set a bitset to another one (CONSTRUCTOR) */
 static inline void
 bitset_init_set(bitset_t d, const bitset_t s)
 {
-  assert (d != s);
+  M_ASSERT (d != s);
   bitset_init(d);
   bitset_set(d, s);
 }
 
+/* Initialize & move a bitset (CONSTRUCTOR) from another one (DESTRUCTOR) */
 static inline void
 bitset_init_move(bitset_t d, bitset_t s)
 {
@@ -140,6 +156,7 @@ bitset_init_move(bitset_t d, bitset_t s)
   BITSETI_CONTRACT(d);  
 }
 
+/* Move a bitset from another one (DESTRUCTOR) */
 static inline void
 bitset_move(bitset_t d, bitset_t s)
 {
@@ -147,46 +164,52 @@ bitset_move(bitset_t d, bitset_t s)
   bitset_init_move (d, s);
 }
 
+/* Set the bit 'i' in the bitset to the value 'x' */
 static inline void
 bitset_set_at(bitset_t v, size_t i, bool x)
 {
   BITSETI_CONTRACT(v);
-  assert (i < v->size && v->ptr != NULL);
+  M_ASSERT (v->ptr != NULL);
+  M_ASSERT_INDEX(i, v->size);
   const size_t offset = i / BITSET_LIMB_BIT;
   const size_t index  = i % BITSET_LIMB_BIT;
   // This is a branchless version as x can only be 0 or 1 with only one variable shift.
-  const bitset_limb mask = ((bitset_limb)1)<<index;
-  v->ptr[offset] = (v->ptr[offset] & ~mask) | (mask & (-(bitset_limb)x));
+  const bitset_limb_ct mask = ((bitset_limb_ct)1)<<index;
+  v->ptr[offset] = (v->ptr[offset] & ~mask) | (mask & (0-(bitset_limb_ct)x));
   BITSETI_CONTRACT (v);
 }
 
+/* Flip the bit 'i' in the bitset */
 static inline void
 bitset_flip_at(bitset_t v, size_t i)
 {
   BITSETI_CONTRACT(v);
-  assert (i < v->size && v->ptr != NULL);
+  M_ASSERT (v->ptr != NULL);
+  M_ASSERT_INDEX(i, v->size);
   size_t offset = i / BITSET_LIMB_BIT;
   size_t index  = i % BITSET_LIMB_BIT;
-  v->ptr[offset] ^= ((bitset_limb)1)<<index;
+  v->ptr[offset] ^= ((bitset_limb_ct)1)<<index;
   BITSETI_CONTRACT (v);
 }
 
+/* Push back the boolean 'x' in the bitset (increasing the bitset) */
 static inline void
 bitset_push_back (bitset_t v, bool x)
 {
   BITSETI_CONTRACT (v);
   if (v->size >= BITSETI_FROM_ALLOC (v->alloc)) {
+    // Compute the needed allocation.
     const size_t needAlloc = BITSETI_INC_ALLOC_SIZE(v->alloc);
     // Check for integer overflow
     if (M_UNLIKELY (needAlloc <= v->alloc)) {
-      M_MEMORY_FULL(needAlloc * sizeof(bitset_limb));
+      M_MEMORY_FULL(needAlloc * sizeof(bitset_limb_ct));
       return;
     }
     // Alloc memory
-    bitset_limb *ptr = M_MEMORY_REALLOC (bitset_limb, v->ptr, needAlloc);
+    bitset_limb_ct *ptr = M_MEMORY_REALLOC (bitset_limb_ct, v->ptr, needAlloc);
     // Check if success
     if (M_UNLIKELY (ptr == NULL) ) {
-      M_MEMORY_FULL(needAlloc * sizeof(bitset_limb));
+      M_MEMORY_FULL(needAlloc * sizeof(bitset_limb_ct));
       return;
     }
     // Clear allocated memory
@@ -196,11 +219,12 @@ bitset_push_back (bitset_t v, bool x)
     v->ptr = ptr;
     v->alloc = needAlloc;
   }
-  assert(v->ptr != NULL);
+  M_ASSERT(v->ptr != NULL);
   v->size ++;
   bitset_set_at (v, v->size - 1, x);
 }
 
+/* Resize the bitset to have exactly 'size' bits */
 static inline void
 bitset_resize (bitset_t v, size_t size)
 {
@@ -210,18 +234,19 @@ bitset_resize (bitset_t v, size_t size)
     M_MEMORY_FULL((size_t) -1);
     return;
   }
+  // Compute the needed allocation.
   size_t newAlloc = BITSETI_TO_ALLOC (size);
   if (newAlloc > v->alloc) {
-    bitset_limb *ptr = M_MEMORY_REALLOC (bitset_limb, v->ptr, newAlloc);
+    bitset_limb_ct *ptr = M_MEMORY_REALLOC (bitset_limb_ct, v->ptr, newAlloc);
     if (M_UNLIKELY (ptr == NULL) ) {
-      M_MEMORY_FULL(newAlloc * sizeof(bitset_limb));
+      M_MEMORY_FULL(newAlloc * sizeof(bitset_limb_ct));
       return;
     }
     v->ptr = ptr;
     v->alloc = newAlloc;
   }
-  //FIXME: Last bit are not cleared. if new size is lower than org size
-  //TODO: More efficient!
+  //FIXME: Last bit are not cleared if new size is lower than org size. Needed?
+  //TODO: Implement a more efficient version when needed.
   size_t i = v->size;
   v->size = size;
   for( ; i < size; i++)
@@ -229,6 +254,7 @@ bitset_resize (bitset_t v, size_t size)
   BITSETI_CONTRACT (v);
 }
 
+/* Reserve allocation in the bitset to accomodate at least 'size' bits without reallocation */
 static inline void
 bitset_reserve (bitset_t v, size_t size)
 {
@@ -243,9 +269,9 @@ bitset_reserve (bitset_t v, size_t size)
     v->size = v->alloc = 0;
     v->ptr = NULL;
   } else {
-    bitset_limb *ptr = M_MEMORY_REALLOC (bitset_limb, v->ptr, newAlloc);
+    bitset_limb_ct *ptr = M_MEMORY_REALLOC (bitset_limb_ct, v->ptr, newAlloc);
     if (M_UNLIKELY (ptr == NULL) ) {
-      M_MEMORY_FULL(newAlloc * sizeof(bitset_limb));
+      M_MEMORY_FULL(newAlloc * sizeof(bitset_limb_ct));
       return;
     }
     v->ptr = ptr;
@@ -254,24 +280,30 @@ bitset_reserve (bitset_t v, size_t size)
   BITSETI_CONTRACT (v);
 }
 
-// NOTE: Interface is a little bit different:
-// It doesn't return a pointer to the data, but the data itself.
+/* Return the value of the boolean at index 'i'.    
+ * NOTE: Interface is a little bit different:
+ * It doesn't return a pointer to the data, but the data itself.
+ */
 static inline bool
 bitset_get(const bitset_t v, size_t i)
 {
   BITSETI_CONTRACT(v);
-  assert (v->ptr != NULL && i < v->size);
+  M_ASSERT (v->ptr != NULL);
+  M_ASSERT_INDEX(i, v->size);
   size_t offset = i / BITSET_LIMB_BIT;
   size_t index  = i % BITSET_LIMB_BIT;
-  return ( v->ptr[offset] & (((bitset_limb)1) << index) ) != 0;
+  return ( v->ptr[offset] & (((bitset_limb_ct)1) << index) ) != 0;
 }
+
+/* bitset_cget is the exact same service than bitset_get */
 #define bitset_cget bitset_get
 
+/* Pop back the last bit in the bitset */
 static inline void
 bitset_pop_back(bool *dest, bitset_t v)
 {
   BITSETI_CONTRACT (v);
-  assert (v->size > 0);
+  M_ASSERT_INDEX (0, v->size);
   if (dest) {
     *dest = bitset_get (v, v->size - 1);
   }
@@ -280,22 +312,25 @@ bitset_pop_back(bool *dest, bitset_t v)
   BITSETI_CONTRACT (v);
 }
 
+/* Return the front bit value in the bitset */
 static inline bool
 bitset_front(bitset_t v)
 {
   BITSETI_CONTRACT (v);
-  assert(v->size > 0);
+  M_ASSERT_INDEX (0, v->size);
   return bitset_get(v, 0);
 }
 
+/* Return the back bit value in the bitset */
 static inline bool
 bitset_back(bitset_t v)
 {
   BITSETI_CONTRACT (v);
-  assert(v->size > 0);
+  M_ASSERT_INDEX (0, v->size);
   return bitset_get(v, v->size-1);
 }
 
+/* Test if the bitset is empty (no bits stored)*/
 static inline bool
 bitset_empty_p(bitset_t v)
 {
@@ -303,6 +338,7 @@ bitset_empty_p(bitset_t v)
   return v->size == 0;
 }
 
+/* Return the number of bits of the bitset */
 static inline size_t
 bitset_size(bitset_t v)
 {
@@ -310,6 +346,7 @@ bitset_size(bitset_t v)
   return v->size;
 }
 
+/* Return the capacity in limbs of the bitset */
 static inline size_t
 bitset_capacity(bitset_t v)
 {
@@ -317,11 +354,14 @@ bitset_capacity(bitset_t v)
   return BITSETI_FROM_ALLOC (v->alloc);
 }
 
+/* Swap the bit at index i and j of the bitset */
 static inline void
 bitset_swap_at (bitset_t v, size_t i, size_t j)
 {
   BITSETI_CONTRACT (v);
-  assert (i < v->size && j < v->size);
+  M_ASSERT_INDEX(i, v->size);
+  M_ASSERT_INDEX(j, v->size);
+
   bool i_val = bitset_get(v, i);
   bool j_val = bitset_get(v, j);
   bitset_set_at (v, i, j_val);
@@ -329,6 +369,7 @@ bitset_swap_at (bitset_t v, size_t i, size_t j)
   BITSETI_CONTRACT (v);
 }
 
+/* Swap the bitsets */
 static inline void
 bitset_swap (bitset_t v1, bitset_t v2)
 {
@@ -336,59 +377,74 @@ bitset_swap (bitset_t v1, bitset_t v2)
   BITSETI_CONTRACT (v2);
   M_SWAP (size_t, v1->size, v2->size);
   M_SWAP (size_t, v1->alloc, v2->alloc);
-  M_SWAP (bitset_limb *, v1->ptr, v2->ptr);
+  M_SWAP (bitset_limb_ct *, v1->ptr, v2->ptr);
 }
 
-static inline bitset_limb
-bitseti_lshift(bitset_limb ptr[], size_t n, bitset_limb carry)
+/* (INTERNAL) Left shift of the bitset (ptr+size) by 1 bit,
+ * integrating the carry in the lowest position.
+ * Return the new carry.
+ */
+static inline bitset_limb_ct
+bitseti_lshift(bitset_limb_ct ptr[], size_t n, bitset_limb_ct carry)
 {
   for(size_t i = 0; i < n; i++) {
-    bitset_limb v = ptr[i];
+    bitset_limb_ct v = ptr[i];
     ptr[i] = (v << 1) | carry;
     carry = (v >> (BITSET_LIMB_BIT-1) );
   }
   return carry;
 }
 
-static inline bitset_limb
-bitseti_rshift(bitset_limb ptr[], size_t n, bitset_limb carry)
+/* (INTERNAL) Right shift of the bitset (ptr+size) by 1 bit,
+ * integrating the carry in the lowest position.
+ * Return the new carry.
+ */
+static inline bitset_limb_ct
+bitseti_rshift(bitset_limb_ct ptr[], size_t n, bitset_limb_ct carry)
 {
   for(size_t i = n - 1; i < n; i--) {
-    bitset_limb v = ptr[i];
+    bitset_limb_ct v = ptr[i];
     v = (v >> 1) | (carry << (BITSET_LIMB_BIT-1) );
     carry = v & 1;
   }
   return carry;
 }
 
+/* Insert a new bit at position 'key' of value 'value' in the bitset */
 static inline void
 bitset_push_at(bitset_t set, size_t key, bool value)
 {
   BITSETI_CONTRACT (set);
   // First push another value to extend the array to the right size
   bitset_push_back(set, false);
-  assert (set->ptr != NULL && key < set->size);
+  M_ASSERT (set->ptr != NULL);
+  M_ASSERT_INDEX(key, set->size);
+
   // Then shift it
   size_t offset = key / BITSET_LIMB_BIT;
   size_t index  = key % BITSET_LIMB_BIT;
-  bitset_limb v = set->ptr[offset];
-  bitset_limb mask = (((bitset_limb)1)<<index)-1;
-  bitset_limb carry = (v >> (BITSET_LIMB_BIT-1) );
-  v = (v & mask) | (value << index) | ((v & ~mask) << 1);
+  bitset_limb_ct v = set->ptr[offset];
+  bitset_limb_ct mask = (((bitset_limb_ct)1)<<index)-1;
+  bitset_limb_ct carry = (v >> (BITSET_LIMB_BIT-1) );
+  v = (v & mask) | ((unsigned int) value << index) | ((v & ~mask) << 1);
   set->ptr[offset] = v;
   size_t size = (set->size + BITSET_LIMB_BIT - 1) / BITSET_LIMB_BIT;
-  assert (size >= offset + 1);
+  M_ASSERT (size >= offset + 1);
   v = bitseti_lshift(&set->ptr[offset+1], size - offset - 1, carry);
   // v is unused.
   (void) v;
   BITSETI_CONTRACT (set);
 }
 
+/* Pop a new bit at position 'key' in the bitset 
+ * and return in *dest its value if *dest exists */
 static inline void
 bitset_pop_at(bool *dest, bitset_t set, size_t key)
 {
    BITSETI_CONTRACT (set);
-   assert (set->ptr != NULL && key < set->size);
+  M_ASSERT (set->ptr != NULL);
+  M_ASSERT_INDEX(key, set->size);
+
    if (dest) {
      *dest = bitset_get (set, key);
    }
@@ -396,10 +452,10 @@ bitset_pop_at(bool *dest, bitset_t set, size_t key)
    size_t offset = key / BITSET_LIMB_BIT;
    size_t index  = key % BITSET_LIMB_BIT;
    size_t size = (set->size + BITSET_LIMB_BIT - 1) / BITSET_LIMB_BIT;
-   bitset_limb v, mask, carry;
+   bitset_limb_ct v, mask, carry;
    carry = bitseti_rshift(&set->ptr[offset+1], size - offset - 1, false);
    v = set->ptr[offset];
-   mask = (((bitset_limb)1)<<index)-1;
+   mask = (((bitset_limb_ct)1)<<index)-1;
    v = (v & mask) | ((v>>1) & ~mask) | (carry << (BITSET_LIMB_BIT-1)) ;
    set->ptr[offset] = v;
    // Decrease size
@@ -407,6 +463,7 @@ bitset_pop_at(bool *dest, bitset_t set, size_t key)
    BITSETI_CONTRACT (set);
 }
 
+/* Test if two bitsets are equal */
 static inline bool
 bitset_equal_p (const bitset_t set1, const bitset_t set2)
 {
@@ -423,13 +480,14 @@ bitset_equal_p (const bitset_t set1, const bitset_t set2)
   /* Compare the last limb if needed */
   const size_t index = set1->size % BITSET_LIMB_BIT;
   if (index > 0) {
-    const bitset_limb mask = (((bitset_limb)1) << index) - 1;
+    const bitset_limb_ct mask = (((bitset_limb_ct)1) << index) - 1;
     if ((set1->ptr[limbSize] & mask) != (set2->ptr[limbSize] & mask))
       return false;
   }
   return true;
 }
 
+/* Initialize an iterator to the first bit of the biset */
 static inline void
 bitset_it(bitset_it_t it, bitset_t set)
 {
@@ -438,14 +496,16 @@ bitset_it(bitset_it_t it, bitset_t set)
    it->set = set;
 }
 
+/* Initialize an iterator to reference the same bit as the given one*/
 static inline void
 bitset_it_set(bitset_it_t it, const bitset_it_t itorg)
 {
-  assert (it != NULL && itorg != NULL);
+  M_ASSERT (it != NULL && itorg != NULL);
   it->index = itorg->index;
   it->set = itorg->set;
 }
 
+/* Initialize an iterator to reference the last bit of the bitset*/
 static inline void
 bitset_it_last(bitset_it_t it, bitset_t set)
 {
@@ -454,6 +514,7 @@ bitset_it_last(bitset_it_t it, bitset_t set)
    it->set = set;
 }
 
+/* Initialize an iterator to reference no valid bit of the bitset*/
 static inline void
 bitset_it_end(bitset_it_t it, bitset_t set)
 {
@@ -462,55 +523,66 @@ bitset_it_end(bitset_it_t it, bitset_t set)
    it->set = set;
 }
 
+/* Test if an iterator references no valid bit of the bitset anymore */
 static inline bool
 bitset_end_p(const bitset_it_t it)
 {
-  assert (it != NULL && it->set != NULL);
+  M_ASSERT (it != NULL && it->set != NULL);
   return (it->index) >= (it->set->size);
 }
 
+/* Test if an iterator references the last (or end) bit of the bitset anymore */
 static inline bool
 bitset_last_p(const bitset_it_t it)
 {
-  assert (it != NULL && it->set != NULL);
-  return (it->index) >= (it->set->size)-1;
+  M_ASSERT (it != NULL && it->set != NULL);
+  /* NOTE: Can not compute 'size-1' due to potential overflow
+     if size is 0 */
+  return (it->index+1) >= (it->set->size);
 }
 
+/* Test if both iterators reference the same bit */
 static inline bool
 bitset_it_equal_p(const bitset_it_t it1, const bitset_it_t it2)
 {
-  assert (it1 != NULL && it2 != NULL);
+  M_ASSERT (it1 != NULL && it2 != NULL);
   return it1->index == it2->index && it1->set == it2->set;
 }
 
+/* Move the iterator to the next bit */
 static inline void
 bitset_next(bitset_it_t it)
 {
-  assert (it != NULL && it->set != NULL);
+  M_ASSERT (it != NULL && it->set != NULL);
   it->index++;
 }
 
+/* Move the iterator to the previous bit */
 static inline void
 bitset_previous(bitset_it_t it)
 {
-  assert (it != NULL && it->set != NULL);
+  M_ASSERT (it != NULL && it->set != NULL);
   it->index--;
 }
 
 // There is no _ref as it is not possible to modify the value using the IT interface
+
+/* Return a pointer to the bit referenced by the iterator 
+ * Only one reference is possible at a time per iterator */
 static inline const bool *
 bitset_cref(bitset_it_t it)
 {
-  assert (it != NULL && it->set != NULL);
+  M_ASSERT (it != NULL && it->set != NULL);
   it->value = bitset_get(it->set, it->index);
   return &it->value;
 }
 
+/* Output the bitset as a formatted text in a FILE */
 static inline void
 bitset_out_str(FILE *file, const bitset_t set)
 {
   BITSETI_CONTRACT (set);
-  assert(file != NULL);
+  M_ASSERT(file != NULL);
   fputc ('[', file);
   for(size_t i = 0; i < set->size; i++) {
     const bool b = bitset_get (set, i);
@@ -520,11 +592,12 @@ bitset_out_str(FILE *file, const bitset_t set)
   fputc (']', file);
 }
 
+/* Input the bitset from a formatted text in a FILE */
 static inline bool
 bitset_in_str(bitset_t set, FILE *file)
 {
   BITSETI_CONTRACT (set);
-  assert(file != NULL);
+  M_ASSERT(file != NULL);
   bitset_clean(set);
   int c = fgetc(file);
   if (c != '[') return false;
@@ -538,11 +611,12 @@ bitset_in_str(bitset_t set, FILE *file)
   return c == ']';
 }
 
+/* Parse the bitset from a formatted text in a C string */
 static inline bool
 bitset_parse_str(bitset_t set, const char str[], const char **endptr)
 {
   BITSETI_CONTRACT (set);
-  assert(str != NULL);
+  M_ASSERT(str != NULL);
   bool success = false;
   bitset_clean(set);
   char c = *str++;
@@ -561,12 +635,15 @@ bitset_parse_str(bitset_t set, const char str[], const char **endptr)
   return success;
 }
 
+/* Set the bitset from a formatted text in a C string */
 static inline bool
 bitset_set_str(bitset_t dest, const char str[])
 {
   return bitset_parse_str(dest, str, NULL);
 }
 
+/* Perform an AND operation between the bitsets,
+ * up to the minimum size of both bitsets */
 static inline void
 bitset_and(bitset_t dest, const bitset_t src)
 {
@@ -578,13 +655,15 @@ bitset_and(bitset_t dest, const bitset_t src)
   for(size_t i = 0 ; i < n; i++)
     dest->ptr[i] &= src->ptr[i];
   if (m) {
-    bitset_limb mask = (((bitset_limb)1) << m) - 1;
+    bitset_limb_ct mask = (((bitset_limb_ct)1) << m) - 1;
     dest->ptr[n] = (dest->ptr[n] & src->ptr[n]) & mask;
   }
   dest->size = s;
   BITSETI_CONTRACT(dest);
 }
 
+/* Perform an OR operation between the bitsets,
+ * up to the minimum size of both bitsets */
 static inline void
 bitset_or(bitset_t dest, const bitset_t src)
 {
@@ -596,13 +675,15 @@ bitset_or(bitset_t dest, const bitset_t src)
   for(size_t i = 0 ; i < n; i++)
     dest->ptr[i] |= src->ptr[i];
   if (m) {
-    bitset_limb mask = (((bitset_limb)1) << m) - 1;
+    bitset_limb_ct mask = (((bitset_limb_ct)1) << m) - 1;
     dest->ptr[n] = (dest->ptr[n] | src->ptr[n]) & mask;
   }
   dest->size = s;
   BITSETI_CONTRACT(dest);
 }
 
+/* Perform an XOR operation between the bitsets,
+ * up to the minimum size of both bitsets */
 static inline void
 bitset_xor(bitset_t dest, const bitset_t src)
 {
@@ -614,13 +695,14 @@ bitset_xor(bitset_t dest, const bitset_t src)
   for(size_t i = 0 ; i < n; i++)
     dest->ptr[i] ^= src->ptr[i];
   if (m) {
-    bitset_limb mask = (((bitset_limb)1) << m) - 1;
+    bitset_limb_ct mask = (((bitset_limb_ct)1) << m) - 1;
     dest->ptr[n] = (dest->ptr[n] ^ src->ptr[n]) & mask;
   }
   dest->size = s;
   BITSETI_CONTRACT(dest);
 }
 
+/* Perform a NOT operation of the bitset */
 static inline void
 bitset_not(bitset_t dest)
 {
@@ -631,13 +713,14 @@ bitset_not(bitset_t dest)
   for(size_t i = 0 ; i < n; i++)
     dest->ptr[i] = ~ (dest->ptr[i]);
   if (m) {
-    bitset_limb mask = (((bitset_limb)1) << m) - 1;
+    bitset_limb_ct mask = (((bitset_limb_ct)1) << m) - 1;
     dest->ptr[n] = (~ dest->ptr[n]) & mask;
   }
   dest->size = s;
   BITSETI_CONTRACT(dest);
 }
 
+/* Copute a hash of the bitset */
 static inline size_t
 bitset_hash(const bitset_t set)
 {
@@ -649,23 +732,24 @@ bitset_hash(const bitset_t set)
   for(size_t i = 0 ; i < n; i++)
     M_HASH_UP(hash, set->ptr[i]);
   if (m) {
-    bitset_limb mask = (((bitset_limb)1) << m) - 1;
+    bitset_limb_ct mask = (((bitset_limb_ct)1) << m) - 1;
     M_HASH_UP(hash, (set->ptr[n] & mask));
   }
   return M_HASH_FINAL (hash);
 }
 
+/* Count the number of leading zero */
 static inline size_t
 bitset_clz(const bitset_t set)
 {
   BITSETI_CONTRACT(set);
   size_t s = set->size;
-  assert (s > 0);
+  M_ASSERT_INDEX (0, s);                            // TBC: Special case to handle?
   size_t n = (s -1) / BITSET_LIMB_BIT;
   size_t m = s % BITSET_LIMB_BIT;
-  bitset_limb limb = set->ptr[n];
+  bitset_limb_ct limb = set->ptr[n];
   if (m) {
-    bitset_limb mask = (((bitset_limb)1) << m) - 1;
+    bitset_limb_ct mask = (((bitset_limb_ct)1) << m) - 1;
     limb &= mask;
   } else {
     m = BITSET_LIMB_BIT;
@@ -680,39 +764,40 @@ bitset_clz(const bitset_t set)
   return s;
 }
 
-#define BITSET_OPLIST                                                   \
-  (INIT(bitset_init)                                                    \
-   ,INIT_SET(bitset_init_set)                                           \
-   ,INIT_WITH(API_1(M_INIT_VAI))                                        \
-   ,SET(bitset_set)                                                     \
-   ,CLEAR(bitset_clear)                                                 \
-   ,INIT_MOVE(bitset_init_move)                                         \
-   ,MOVE(bitset_move)                                                   \
-   ,SWAP(bitset_swap)                                                   \
-   ,TYPE(bitset_t)                                                      \
-   ,SUBTYPE(bool)                                                       \
-   ,TEST_EMPTY(bitset_empty_p),                                         \
-   ,GET_SIZE(bitset_size)                                               \
-   ,IT_TYPE(bitset_it_t)                                                \
-   ,IT_FIRST(bitset_it)                                                 \
-   ,IT_SET(bitset_it_set)                                               \
-   ,IT_LAST(bitset_it_last)                                             \
-   ,IT_END(bitset_it_end)                                               \
-   ,IT_END_P(bitset_end_p)                                              \
-   ,IT_LAST_P(bitset_last_p)                                            \
-   ,IT_EQUAL_P(bitset_it_equal_p)                                       \
-   ,IT_NEXT(bitset_next)                                                \
-   ,IT_PREVIOUS(bitset_previous)                                        \
-   ,IT_CREF(bitset_cref)                                                \
-   ,CLEAN(bitset_clean)                                                 \
-   ,PUSH(bitset_push_back)                                              \
-   ,POP(bitset_pop_back)                                                \
-   ,HASH(bitset_hash)                                                   \
-   ,GET_STR(bitset_get_str)                                             \
-   ,OUT_STR(bitset_out_str)                                             \
-   ,PARSE_STR(bitset_parse_str)                                         \
-   ,IN_STR(bitset_in_str)                                               \
-   ,EQUAL(bitset_equal_p)                                               \
+/* Oplist for a bitset */
+#define BITSET_OPLIST                                                         \
+  (INIT(bitset_init)                                                          \
+   ,INIT_SET(bitset_init_set)                                                 \
+   ,INIT_WITH(API_1(M_INIT_VAI))                                              \
+   ,SET(bitset_set)                                                           \
+   ,CLEAR(bitset_clear)                                                       \
+   ,INIT_MOVE(bitset_init_move)                                               \
+   ,MOVE(bitset_move)                                                         \
+   ,SWAP(bitset_swap)                                                         \
+   ,TYPE(bitset_t)                                                            \
+   ,SUBTYPE(bool)                                                             \
+   ,EMPTY_P(bitset_empty_p),                                                  \
+   ,GET_SIZE(bitset_size)                                                     \
+   ,IT_TYPE(bitset_it_t)                                                      \
+   ,IT_FIRST(bitset_it)                                                       \
+   ,IT_SET(bitset_it_set)                                                     \
+   ,IT_LAST(bitset_it_last)                                                   \
+   ,IT_END(bitset_it_end)                                                     \
+   ,IT_END_P(bitset_end_p)                                                    \
+   ,IT_LAST_P(bitset_last_p)                                                  \
+   ,IT_EQUAL_P(bitset_it_equal_p)                                             \
+   ,IT_NEXT(bitset_next)                                                      \
+   ,IT_PREVIOUS(bitset_previous)                                              \
+   ,IT_CREF(bitset_cref)                                                      \
+   ,CLEAN(bitset_clean)                                                       \
+   ,PUSH(bitset_push_back)                                                    \
+   ,POP(bitset_pop_back)                                                      \
+   ,HASH(bitset_hash)                                                         \
+   ,GET_STR(bitset_get_str)                                                   \
+   ,OUT_STR(bitset_out_str)                                                   \
+   ,PARSE_STR(bitset_parse_str)                                               \
+   ,IN_STR(bitset_in_str)                                                     \
+   ,EQUAL(bitset_equal_p)                                                     \
    )
 
 /* Register the OPLIST as a global one */
@@ -723,15 +808,15 @@ bitset_clz(const bitset_t set)
 #endif
 
 // NOTE: Define this function only if m-string has been included
-#ifndef MSTARLIB_BITSET_STRING_H
-#ifdef  MSTARLIB_STRING_H
+#if !defined(MSTARLIB_BITSET_STRING_H) && defined(MSTARLIB_STRING_H)
 #define MSTARLIB_BITSET_STRING_H
 
+/* Output to a string_t the formatted text representation of a bitset */
 static inline void
 bitset_get_str(string_t str, const bitset_t set, bool append)
 {
   BITSETI_CONTRACT (set);
-  assert(str != NULL);
+  M_ASSERT(str != NULL);
   (append ? string_cat_str : string_set_str) (str, "[");
   for(size_t i = 0; i < set->size; i++) {
     const bool b = bitset_get (set, i);
@@ -741,5 +826,6 @@ bitset_get_str(string_t str, const bitset_t set, bool append)
   string_push_back (str, ']');
 }
 
-#endif
+M_END_PROTECTED_CODE
+
 #endif

m-funcobj.h

@@ -0,0 +1,402 @@
+/*
+ * M*LIB - Function Object module
+ *
+ * Copyright (c) 2017-2021, Patrick Pelissier
+ * All rights reserved.
+ * 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 REGENTS 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 REGENTS AND 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.
+*/
+#ifndef MSTARLIB_FUNCOBJ_H
+#define MSTARLIB_FUNCOBJ_H
+
+#include "m-core.h"
+
+/* Define a function object interface of name 'name'
+ * with a function like retcode, type of param1, type of param 2, ...
+ * USAGE:
+ *    FUNC_OBJ_ITF_DEF(name, retcode type, type of param1, type of param 2, ...)
+ */
+#define FUNC_OBJ_ITF_DEF(name, ...)                                           \
+  M_BEGIN_PROTECTED_CODE                                                      \
+  M_IF_NARGS_EQ1(__VA_ARGS__)(FUNCOBJI_ITF_NO_PARAM_DEF, FUNCOBJI_ITF_PARAM_DEF)(name, M_C(name, _t), __VA_ARGS__) \
+  M_END_PROTECTED_CODE
+
+
+/* Define a function object interface of name 'name'
+ * as the given name name_t
+ * USAGE:
+ *    FUNC_OBJ_ITF_DEF_AS(name, name_t, retcode type, type of param1, type of param 2, ...)
+ */
+#define FUNC_OBJ_ITF_DEF_AS(name, name_t, ...)                                \
+  M_BEGIN_PROTECTED_CODE                                                      \
+  M_IF_NARGS_EQ1(__VA_ARGS__)(FUNCOBJI_ITF_NO_PARAM_DEF, FUNCOBJI_ITF_PARAM_DEF)(name, name_t, __VA_ARGS__) \
+  M_END_PROTECTED_CODE
+
+
+/* Define a function object instance of name 'name' based on the interface 'base_name'
+ * The function is defined using:
+ * - the prototype of the inherited interface
+ * - the parameters of the function are named as per the list param_list
+ * - the core of the function given in 'callback_core'
+ * - optionals member attributes of the function object can be defined after the core
+ * (just like for tuple & variant: (name, type [, oplist])
+ * 
+ * In the core of the function, parameters are accessible just like a normal function.
+ * A special variable named 'self' that refers to the function object itself
+ * can be used to access member attributes using the syntax self->param1, ...
+ * 
+ * There shall be **exactly** the same number of parameters in 'param_list' than
+ * the number of parameters of the interface 'base_name'
+ *
+ * USAGE/EXAMPLE:
+ *   FUNC_OBJ_INS_DEF(name, base_name, (param1, ...), { return param1 * self->member1 }, (member1, int), ...)
+ */
+#define FUNC_OBJ_INS_DEF(name, base_name, param_list, ...)                    \
+  M_BEGIN_PROTECTED_CODE                                                      \
+  M_IF_NARGS_EQ1(__VA_ARGS__)(FUNCOBJI_INS_NO_ATTR_DEF, FUNCOBJI_INS_ATTR_DEF)(name, M_C(name, _t), base_name, param_list, __VA_ARGS__) \
+  M_END_PROTECTED_CODE
+
+
+/* Define a function object instance of name 'name' based on the interface 'base_name'
+ * as the given name name_t.
+ * See FUNC_OBJ_INS_DEF for additional details.
+ * 
+ * USAGE/EXAMPLE:
+ *   FUNC_OBJ_INS_DEF_AS(name, name_t, base_name, (param1, ...), { return param1 * self->member1 }, (member1, int), ...)
+ */
+#define FUNC_OBJ_INS_DEF_AS(name, name_t, base_name, param_list, ...)         \
+  M_BEGIN_PROTECTED_CODE                                                      \
+  M_IF_NARGS_EQ1(__VA_ARGS__)(FUNCOBJI_INS_NO_ATTR_DEF, FUNCOBJI_INS_ATTR_DEF)(name, name_t, base_name, param_list, __VA_ARGS__) \
+  M_END_PROTECTED_CODE
+
+
+/* OPLIST of the instanced function object
+ * USAGE:
+ *  FUNC_OBJ_INS_OPLIST(name, oplist of the attr1, ...)
+ */
+#define FUNC_OBJ_INS_OPLIST(...)                                              \
+  M_IF_NARGS_EQ1(__VA_ARGS__)(FUNCOBJI_INS_NO_ATTR_OPLIST, FUNCOBJI_INS_ATTR_OPLIST_P1)( __VA_ARGS__)
+
+
+
+/********************************************************************************/
+/********************************** INTERNAL ************************************/
+/********************************************************************************/
+
+/* To be used by M_IF_FUNCOBJ macro defined in m-core.
+   NOTE: It is reversed (0 instead of 1) so that it can be used in M_IF reliabely.
+*/
+#define M_FUNCOBJ_IS_NOT_DEFINED 0
+
+/* Design Constraints:
+ *  callback SHALL be the first member of the structures in all the definitions.
+ *
+ * Structure definitions are specialized in function of the presence or not
+ * of parameters and/or attributes 
+ * FIXME: How to factorize reasonnably well between the definitions?
+ */
+
+/* Specialization of the OPLIST in function if there is at least one member or not */
+#define FUNCOBJI_INS_NO_ATTR_OPLIST(name) (                                   \
+  NAME(name),                                                                 \
+  TYPE(M_C(name, _ct)),                                                       \
+  CLEAR(M_C(name, _clear)),                                                   \
+  INIT(M_C(name,_init))                                                       \
+  )
+
+/* Validate the oplist before going further */
+#define FUNCOBJI_INS_ATTR_OPLIST_P1(name, ...)                                \
+  M_IF(M_REDUCE(M_OPLIST_P, M_AND, __VA_ARGS__))(FUNCOBJI_INS_ATTR_OPLIST_P3, FUNCOBJI_INS_ATTR_OPLIST_FAILURE)(name, __VA_ARGS__)
+
+/* Prepare a clean compilation failure */
+#define FUNCOBJI_INS_ATTR_OPLIST_FAILURE(name, ...)                           \
+  ((M_LIB_ERROR(ONE_ARGUMENT_OF_FUNC_OBJ_INS_OPLIST_IS_NOT_AN_OPLIST, name, __VA_ARGS__)))
+
+/* Define the oplist of the instance */
+#define FUNCOBJI_INS_ATTR_OPLIST_P3(name, ...) (                              \
+  NAME(name),                                                                 \
+  TYPE(M_C(name, _ct)),                                                       \
+  INIT_WITH(M_C(name, _init_with)),                                           \
+  CLEAR(M_C(name, _clear)),                                                   \
+  M_IF_METHOD_ALL(INIT, __VA_ARGS__)(INIT(M_C(name,_init)),),                 \
+  )
+
+
+/* Specialization of the definition a function object interface of name 'name'
+ * with a function like "retcode (void)" that doesn't have any input parameters.
+ * Define the following types to be used by instance:
+ * - M_C(name, _retcode_ct): internal type of the return code
+ * - M_C(name, _callback_ct): internal type of the callback.
+ * - M_C(name, _ct): synonym of main type used by oplist.
+ */
+#define FUNCOBJI_ITF_NO_PARAM_DEF(name, interface_t, retcode)                 \
+                                                                              \
+  /* Forward declaration */                                                   \
+  struct M_C(name, _s);                                                       \
+                                                                              \
+  /* Internal type for instance */                                            \
+  typedef retcode M_C(name, _retcode_ct);                                     \
+  /* No parameters to the callback */                                         \
+  typedef retcode(*M_C(name, _callback_ct))(struct M_C(name, _s) *);          \
+                                                                              \
+  typedef struct M_C(name, _s) {                                              \
+     M_C(name, _callback_ct) callback;                                        \
+  } interface_t[1];                                                           \
+                                                                              \
+  /* Internal type for oplist & instance */                                   \
+  typedef interface_t M_C(name, _ct);                                         \
+                                                                              \
+  static inline retcode                                                       \
+  M_C(name, _call)(interface_t funcobj)                                       \
+  {                                                                           \
+    M_IF(M_KEYWORD_P(void, retcode)) ( /* nothing */,return)                  \
+      funcobj->callback(funcobj);                                             \
+  }
+
+
+/* Specialization of the definition a function object interface of name 'name'
+ * with a function like retcode, type of param1, type of param 2, ...
+ * with mandatory input parameters.
+ * Define the following types to be used by instance:
+ * - M_C(name, _retcode_ct): internal type of the return code
+ * - M_C(name, _callback_ct): internal type of the callback.
+ * - M_C4(name, _param_, num, _ct) for each parameter defined
+ * - M_C(name, _ct): synonym of main type used by oplist.
+ */
+#define FUNCOBJI_ITF_PARAM_DEF(name, interface_t, retcode, ...)               \
+                                                                              \
+  /* Forward declaration */                                                   \
+  struct M_C(name, _s);                                                       \
+                                                                              \
+  /* Internal types for instance */                                           \
+  typedef retcode M_C(name, _retcode_ct);                                     \
+  /* Define types for all parameters */                                       \
+  M_MAP3(FUNCOBJI_BASE_TYPE, name, __VA_ARGS__)                               \
+  /* Define callback type with all parameters */                              \
+  typedef retcode(*M_C(name, _callback_ct))(struct M_C(name, _s) *, __VA_ARGS__); \
+                                                                              \
+  typedef struct M_C(name, _s) {                                              \
+     M_C(name, _callback_ct) callback;                                        \
+  } interface_t[1];                                                           \
+                                                                              \
+  /* Internal type for oplist & instance */                                   \
+  typedef interface_t M_C(name, _ct);                                         \
+                                                                              \
+  static inline retcode                                                       \
+  M_C(name, _call)(interface_t funcobj                                        \
+                   M_MAP3(FUNCOBJI_BASE_ARGLIST, name, __VA_ARGS__) )         \
+  {                                                                           \
+    /* If the retcode is 'void', don't return the value of the callback */    \
+    M_IF(M_KEYWORD_P(void, retcode)) ( /* nothing */,return)                  \
+      funcobj->callback(funcobj M_MAP3(FUNCOBJI_BASE_ARGCALL, name, __VA_ARGS__) ); \
+  }
+
+
+/* Specialization of the definition a function object instance of name 'name'
+ * with no member attribute.
+ */
+#define FUNCOBJI_INS_NO_ATTR_DEF(name, instance_t, base_name, param_list, callback_core) \
+  typedef struct M_C(name, _s) {                                              \
+    M_C(base_name, _callback_ct) callback;                                    \
+  } instance_t[1];                                                            \
+                                                                              \
+  /* Internal type for oplist */                                              \
+  typedef instance_t M_C(name, _ct);                                          \
+                                                                              \
+  static inline M_C(base_name, _retcode_ct)                                   \
+  M_C(name, _callback)(M_C(base_name, _ct) _self                              \
+                      M_IF_EMPTY(M_OPFLAT param_list)(                        \
+                          /* No param */,                                     \
+                          M_MAP3(FUNCOBJI_INS_ARGLIST, base_name, M_OPFLAT param_list) \
+                                                                    )         \
+                      )                                                       \
+  {                                                                           \
+    struct M_C(name, _s) *self = (struct M_C(name, _s) *)_self;               \
+    (void) self; /* maybe unused */                                           \
+    callback_core;                                                            \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _init_with)(instance_t obj)                                       \
+  {                                                                           \
+    obj->callback = M_C(name, _callback);                                     \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _clear)(instance_t obj)                                           \
+  {                                                                           \
+    (void) obj; /* nothing to do */                                           \
+  }                                                                           \
+                                                                              \
+  static inline struct M_C(base_name, _s) *                                   \
+  M_C(name, _as_interface)(instance_t obj)                                    \
+  {                                                                           \
+    return (struct M_C(base_name, _s) *) obj;                                 \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _init)(instance_t obj)                                            \
+  {                                                                           \
+    obj->callback = M_C(name, _callback);                                     \
+  }                                                                           \
+   
+
+/* Specialization of the definition a function object instance of name 'name'
+ * with mandatory member attribute.
+ * First inject oplist in member attributes.
+ */
+#define FUNCOBJI_INS_ATTR_DEF(name, instance_t, base_name, param_list, callback_core, ...) \
+  FUNCOBJI_INS_ATTR_DEF_P2(name, instance_t, base_name, param_list, callback_core, FUNCOBJI_INJECT_GLOBAL(__VA_ARGS__) )
+
+/* Inject the oplist within the list of arguments */
+#define FUNCOBJI_INJECT_GLOBAL(...)                                           \
+  M_MAP_C(FUNCOBJI_INJECT_OPLIST_A, __VA_ARGS__)
+
+/* Transform (x, type) into (x, type, oplist) if there is global registered oplist 
+   or (x, type, M_DEFAULT_OPLIST) if there is no global one,
+   or keep (x, type, oplist) if oplist was already present */
+#define FUNCOBJI_INJECT_OPLIST_A( duo_or_trio )                               \
+  FUNCOBJI_INJECT_OPLIST_B duo_or_trio
+#define FUNCOBJI_INJECT_OPLIST_B( f, ... )                                    \
+  M_IF_NARGS_EQ1(__VA_ARGS__)( (f, __VA_ARGS__, M_GLOBAL_OPLIST_OR_DEF(__VA_ARGS__)()), (f, __VA_ARGS__) )
+
+// Test if all third argument of all arguments is an oplist
+#define FUNCOBJI_IF_ALL_OPLIST(...)                                           \
+  M_IF(M_REDUCE(FUNCOBJI_IS_OPLIST_P, M_AND, __VA_ARGS__))
+// Test if the third argument is an oplist. a is a trio (name, type, oplist)
+#define FUNCOBJI_IS_OPLIST_P(a)                                               \
+  M_OPLIST_P(M_RET_ARG3 a)
+
+/* Validate the oplist before going further */
+#define FUNCOBJI_INS_ATTR_DEF_P2(name, instance_t, base_name, param_list, callback_core, ...) \
+  FUNCOBJI_IF_ALL_OPLIST(__VA_ARGS__)(FUNCOBJI_INS_ATTR_DEF_P3, FUNCOBJI_INS_ATTR_DEF_FAILURE)(name, instance_t, base_name, param_list, callback_core, __VA_ARGS__)
+
+/* Stop processing with a compilation failure */
+#define FUNCOBJI_INS_ATTR_DEF_FAILURE(name, instance_t, base_name, param_list, callback_core, ...) \
+  M_STATIC_FAILURE(M_LIB_NOT_AN_OPLIST, "(FUNC_OBJ_INS_DEF): at least one of the given argument is not a valid oplist: " #__VA_ARGS__)
+
+/* Expand the Function Object with members */
+#define FUNCOBJI_INS_ATTR_DEF_P3(name, instance_t, base_name, param_list, callback_core, ...) \
+  typedef struct M_C(name, _s) {                                              \
+    /* Callback is the mandatory first argument */                            \
+    M_C(base_name, _callback_ct) callback;                                    \
+    /* All the member attribute of the Function Object */                     \
+    M_MAP(FUNCOBJI_INS_ATTR_STRUCT, __VA_ARGS__)                              \
+   } instance_t[1];                                                           \
+                                                                              \
+  /* Internal type for oplist */                                              \
+  typedef instance_t M_C(name, _ct);                                          \
+                                                                              \
+  FUNCOBJI_CONTROL_ALL_OPLIST(name, __VA_ARGS__)                              \
+                                                                              \
+  static inline M_C(base_name, _retcode_ct)                                   \
+  M_C(name, _callback)(M_C(base_name, _ct) _self                              \
+                      M_IF_EMPTY(M_OPFLAT param_list)(                        \
+                        /* No param */,                                       \
+                        M_MAP3(FUNCOBJI_INS_ARGLIST, base_name, M_OPFLAT param_list) \
+                                                                    )         \
+                      )                                                       \
+  {                                                                           \
+    struct M_C(name, _s) *self = (struct M_C(name, _s) *)(void*)_self;	       \
+    (void) self; /* maybe unused */                                           \
+    callback_core;                                                            \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _init_with)(instance_t obj M_MAP(FUNCOBJI_INS_ATTR_LIST, __VA_ARGS__)) \
+  {                                                                           \
+    obj->callback = M_C(name, _callback);                                     \
+    M_MAP(FUNCOBJI_INS_ATTR_INIT_SET, __VA_ARGS__);                           \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _clear)(instance_t obj)                                           \
+  {                                                                           \
+    M_MAP(FUNCOBJI_INS_ATTR_CLEAR, __VA_ARGS__);                              \
+  }                                                                           \
+                                                                              \
+  static inline struct M_C(base_name, _s) *                                   \
+  M_C(name, _as_interface)(instance_t obj)                                    \
+  {                                                                           \
+    return (struct M_C(base_name, _s) *) obj;                                 \
+  }                                                                           \
+                                                                              \
+  M_IF(FUNCOBJI_TEST_METHOD_P(INIT, __VA_ARGS))                               \
+  (                                                                           \
+  static inline void                                                          \
+  M_C(name, _init)(instance_t obj)                                            \
+  {                                                                           \
+    obj->callback = M_C(name, _callback);                                     \
+    M_MAP(FUNCOBJI_INS_ATTR_INIT, __VA_ARGS__);                               \
+  }                                                                           \
+  , /* END OF INIT METHOD */ )                                                \
+
+
+
+/* Define a numbered type of a parameter of the callback*/
+#define FUNCOBJI_BASE_TYPE(name, num, type)                                   \
+  typedef type M_C4(name, _param_, num, _ct);
+
+/* Define a list of the type of arguments for a function definition */
+#define FUNCOBJI_BASE_ARGLIST(name, num, type)                                \
+  M_DEFERRED_COMMA type M_C(param_, num)
+
+/* Define a list of arguments for a function call */
+#define FUNCOBJI_BASE_ARGCALL(name, num, type)                                \
+  M_DEFERRED_COMMA M_C(param_, num)
+
+
+/* Helper macros */
+/* arg = (name, type [, oplist]) */
+#define FUNCOBJI_INS_ATTR_STRUCT(arg)                                         \
+  M_RET_ARG2 arg M_RET_ARG1 arg;
+
+#define FUNCOBJI_INS_ATTR_LIST(arg)                                           \
+  M_DEFERRED_COMMA M_RET_ARG2 arg const M_RET_ARG1 arg
+
+#define FUNCOBJI_INS_ATTR_INIT(arg)                                           \
+  M_CALL_INIT(M_RET_ARG3 arg, obj -> M_RET_ARG1 arg);
+
+#define FUNCOBJI_INS_ATTR_INIT_SET(arg)                                       \
+  M_CALL_INIT_SET(M_RET_ARG3 arg, obj -> M_RET_ARG1 arg, M_RET_ARG1 arg);
+
+#define FUNCOBJI_INS_ATTR_CLEAR(arg)                                          \
+  M_CALL_CLEAR(M_RET_ARG3 arg, obj -> M_RET_ARG1 arg);
+
+/* Define the list of arguments of the instance of the callback */
+#define FUNCOBJI_INS_ARGLIST(name, num, param)                                \
+  M_DEFERRED_COMMA M_C4(name, _param_, num, _ct) param
+
+
+/* Macros for testing for a method presence in all the attributes */
+#define FUNCOBJI_TEST_METHOD2_P(method, op)                                   \
+  M_TEST_METHOD_P(method, op)
+#define FUNCOBJI_TEST_METHOD1_P(method, arg)                                  \
+  M_APPLY(FUNCOBJI_TEST_METHOD2_P, method, M_RET_ARG3 arg)
+#define FUNCOBJI_TEST_METHOD_P(method, ...)                                   \
+  M_IF(M_REDUCE2(FUNCOBJI_TEST_METHOD1_P, M_AND, method, __VA_ARGS__))
+
+/* Macro for checking compatible type and oplist for all the attributes */
+#define FUNCOBJI_CONTROL_ALL_OPLIST(name, ...)                                \
+  M_MAP2(FUNCOBJI_CONTROL_OPLIST, name, __VA_ARGS__)
+#define FUNCOBJI_CONTROL_OPLIST(name, a)                                      \
+  M_CHECK_COMPATIBLE_OPLIST(name, M_RET_ARG1 a, M_RET_ARG2 a, M_RET_ARG3 a)
+
+
+#endif

m-genint.h

@@ -1,7 +1,7 @@
 /*
- * M*LIB - GENINT module
+ * M*LIB - Integer Generator (GENINT) module
  *
- * Copyright (c) 2017-2019, Patrick Pelissier
+ * Copyright (c) 2017-2021, Patrick Pelissier
  * All rights reserved.
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -28,70 +28,87 @@
 #include "m-core.h"
 #include "m-atomic.h"
 
-/* GENINT is a container of integers with the following properties:
+M_BEGIN_PROTECTED_CODE
 
+/* GENINT is a container providing unique integers.
+  It has the following properties:
    - it stores integer from [0..N) (N is fixed).
    - an integer can have only one occurrence in the container.
    - you can atomically push in / pop out integer from this container
-   provided that they were not already in the container.
+   provided that it is not already in the container.
    - there are no order (like FIFO or stack)
 
    This can be used to map integers to index of resources in a table.
-   At most we can support N = GENINT_LIMBSIZE * GENINT_LIMBSIZE >= 4096
-   due to the master trick. For the typical usage of this container
+   At most we can support N = 2048 with the master limb usage.
+   For the typical usage of this container
    (mapping hardware or software limited resources), this should be
    enough.
 */
 
 // TO DO: We may want a specialization with constant N value.
 
-// Define the limb size 
-typedef unsigned long long genint_limb_t;
+// Define the limb size used by genint
+typedef unsigned long long genint_limb_ct;
 
+/* Define a generator of unique integer (Lock Free) */
 typedef struct genint_s {
   unsigned int n;            // size of the container
   unsigned int max;          // number of allocated limb - 1
-  genint_limb_t mask0;       // mask of the last limb
-  genint_limb_t mask_master; // mask of master
+  genint_limb_ct mask0;       // mask of the last limb (constant)
+  genint_limb_ct mask_master; // mask of the master limb that controls others (constant)
   atomic_ullong master;      // master bitfield (which informs if a limb is full or not)
-  atomic_ullong *data;       // the bitfield which informs if an integer
+  atomic_ullong *data;       // the bitfield which informs if an integer is used or not
 } genint_t[1];
 
-// Define the max supported value
+// Define the max absolute supported value
 #define GENINT_MAX_ALLOC (GENINT_LIMBSIZE * (GENINT_LIMBSIZE - GENINT_ABA_CPT))
 
 // Define the size of a limb in bits.
-#define GENINT_LIMBSIZE (sizeof(genint_limb_t) * CHAR_BIT)
+#define GENINT_LIMBSIZE ((unsigned)(sizeof(genint_limb_ct) * CHAR_BIT))
 
-#define GENINT_CONTRACT(s)                              do {            \
-    assert (s != NULL);                                                 \
-    assert (s->n > 0 && s->n <= GENINT_MAX_ALLOC);                      \
-    assert ((s->max+1) * GENINT_LIMBSIZE >= s->n);                      \
-    assert (s->data != NULL);                                           \
+// Define the contract of a genint
+#define GENINT_CONTRACT(s)                              do {                  \
+    M_ASSERT (s != NULL);                                                     \
+    M_ASSERT (s->n > 0 && s->n <= GENINT_MAX_ALLOC);                          \
+    M_ASSERT ((s->max+1) * GENINT_LIMBSIZE >= s->n);                          \
+    M_ASSERT (s->data != NULL);                                               \
   } while (0)
 
-#define GENINT_ONE  ((genint_limb_t)1)
+// Define the limb one
+#define GENINT_ONE  ((genint_limb_ct)1)
 
-// Value returned in case of error.
-#define GENINT_ERROR (-1U)
+#define GENINT_FULL_MASK ULLONG_MAX
 
-// 32 bits of master are kept for handling the ABA problems.
+// Value returned in case of error (not integer available).
+#define GENINT_ERROR (UINT_MAX)
+
+/* 32 bits of the master mask are kept for handling the ABA problem.
+ * NOTE: May be too much. 16 bits should be more than enough. TBC
+ */
 #define GENINT_ABA_CPT 32
 #define GENINT_ABA_CPT_T uint32_t
 
-// Set the bit i of master
-#define GENINT_MASTER_SET(master, i)                            \
+// Set the bit 'i' of the master limb, and increase ABA counter.
+#define GENINT_MASTER_SET(master, i)                                          \
   ((((master)& (~((GENINT_ONE<< GENINT_ABA_CPT)-1))) | (GENINT_ONE << (GENINT_LIMBSIZE - 1 - i))) \
    |((GENINT_ABA_CPT_T)((master) + 1)))
 
-// Reset the bit i of master
-#define GENINT_MASTER_RESET(master, i)                           \
-  (((master) & (~((GENINT_ONE<< GENINT_ABA_CPT)-1)) & ~(GENINT_ONE << (GENINT_LIMBSIZE - 1 - i)))       \
+// Reset the bit i of the master limb, and increase ABA counter.
+#define GENINT_MASTER_RESET(master, i)                                        \
+  (((master) & (~((GENINT_ONE<< GENINT_ABA_CPT)-1)) & ~(GENINT_ONE << (GENINT_LIMBSIZE - 1 - i))) \
    |((GENINT_ABA_CPT_T)((master) + 1)))
 
-static inline void genint_init(genint_t s, unsigned int n)
+/* Initialize an integer generator (CONSTRUCTOR).
+ * Initialy, the container is full of all the integers up to 'n-1'
+ * The typical sequence is to initialize the container, and pop
+ * the integer from it. Each pop integer is **unique** for all threads,
+ * meaning it can be used to index global unique resources shared 
+ * for all threads.
+ */
+static inline void
+genint_init(genint_t s, unsigned int n)
 {
-  assert (s != NULL && n > 0 && n <= GENINT_MAX_ALLOC);
+  M_ASSERT (s != NULL && n > 0 && n <= GENINT_MAX_ALLOC);
   const size_t alloc = (n + GENINT_LIMBSIZE - 1) / GENINT_LIMBSIZE;
   const unsigned int index  = n % GENINT_LIMBSIZE;
   atomic_ullong *ptr = M_MEMORY_REALLOC (atomic_ullong, NULL, alloc);
@@ -101,55 +118,61 @@ static inline void genint_init(genint_t s, unsigned int n)
   }
   s->n = n;
   s->data = ptr;
-  s->max = alloc-1;
-  s->mask0 = (index == 0) ? -GENINT_ONE : ~((GENINT_ONE<<(GENINT_LIMBSIZE-index))-1);
+  s->max = (unsigned int) (alloc-1);
+  s->mask0 = (index == 0) ? GENINT_FULL_MASK : ~((GENINT_ONE<<(GENINT_LIMBSIZE-index))-1);
   s->mask_master = (((GENINT_ONE << alloc) - 1) << (GENINT_LIMBSIZE-alloc)) >> GENINT_ABA_CPT;
-  atomic_init (&s->master, (genint_limb_t)0);
+  atomic_init (&s->master, (genint_limb_ct)0);
   for(unsigned int i = 0; i < alloc; i++)
-    atomic_init(&s->data[i], (genint_limb_t)0);
+    atomic_init(&s->data[i], (genint_limb_ct)0);
   GENINT_CONTRACT(s);
 }
 
-static inline void genint_clear(genint_t s)
+/* Clear an integer generator (Destructor) */
+static inline void
+genint_clear(genint_t s)
 {
   GENINT_CONTRACT(s);
   M_MEMORY_FREE(s->data);
   s->data = NULL;
 }
 
-static inline size_t genint_size(genint_t s)
+/* Return the maximum integer that the generator will provide */
+static inline size_t
+genint_size(genint_t s)
 {
   GENINT_CONTRACT(s);
   return s->n;
 }
 
-// For a typical case, the amortized cost is one CAS per pop.
-static inline unsigned int genint_pop(genint_t s)
+/* Get an unique integer from the integer generator.
+ * NOTE: For a typical case, the amortized cost is one CAS per pop. */
+static inline unsigned int
+genint_pop(genint_t s)
 {
   GENINT_CONTRACT(s);
   // First read master to see which limb is not full.
-  genint_limb_t master = atomic_load(&s->master);
+  genint_limb_ct master = atomic_load(&s->master);
   // While master is not full
   while ((master >> GENINT_ABA_CPT) != s->mask_master) {
     // Let's get the index i of the first not full limb according to master.
     unsigned int i = m_core_clz64(~master);
-    assert (i < GENINT_LIMBSIZE);
+    M_ASSERT (i < GENINT_LIMBSIZE);
     // Let's compute the mask of this limb representing the limb as being full
-    genint_limb_t mask = s->mask0;
-    mask = (i == s->max) ? mask : -GENINT_ONE;
+    genint_limb_ct mask = s->mask0;
+    mask = (i == s->max) ? mask : GENINT_FULL_MASK;
     unsigned int bit;
     // Let's load this limb,
-    genint_limb_t next, org = atomic_load(&s->data[i]);
+    genint_limb_ct next, org = atomic_load(&s->data[i]);
     do {
       // If it is now full, we have been preempted by another.
       if (M_UNLIKELY (org == mask))
         goto next_element;
-      assert (org != -GENINT_ONE);
+      M_ASSERT (org != GENINT_FULL_MASK);
       // At least one bit is free in the limb. Find one.
       bit = GENINT_LIMBSIZE - 1 - m_core_clz64(~org);
-      assert (bit < GENINT_LIMBSIZE);
-      assert ((org & (GENINT_ONE<<bit)) == 0);
-      assert (i * GENINT_LIMBSIZE + GENINT_LIMBSIZE - 1 - bit < s->n);
+      M_ASSERT (bit < GENINT_LIMBSIZE);
+      M_ASSERT ((org & (GENINT_ONE<<bit)) == 0);
+      M_ASSERT (i * GENINT_LIMBSIZE + GENINT_LIMBSIZE - 1 - bit < s->n);
       // Set the integer as being used.
       next = org | (GENINT_ONE << bit);
       // Try to reserve the integer 
@@ -158,7 +181,7 @@ static inline unsigned int genint_pop(genint_t s)
     // If the limb is now full, try to update master
     if (M_UNLIKELY(next == mask)) {
       while (true) {
-        genint_limb_t newMaster;
+        genint_limb_ct newMaster;
         if (next == mask) {
           newMaster = GENINT_MASTER_SET(master, i);
         } else {
@@ -181,30 +204,32 @@ static inline unsigned int genint_pop(genint_t s)
   return GENINT_ERROR; // No more resource available
 }
 
-// For a typical case, the amortized cost is one CAS per pop.
-static inline void genint_push(genint_t s, unsigned int n)
+/* Restore a used integer in the integer generator.
+ * NOTE: For a typical case, the amortized cost is one CAS per pop */
+static inline void
+genint_push(genint_t s, unsigned int n)
 {
   GENINT_CONTRACT(s);
-  assert (n < s->n);
+  M_ASSERT (n < s->n);
   const unsigned int i    = n / GENINT_LIMBSIZE;
   const unsigned int bit  = GENINT_LIMBSIZE - 1 - (n % GENINT_LIMBSIZE);
-  genint_limb_t master = atomic_load(&s->master);
+  genint_limb_ct master = atomic_load(&s->master);
   // Load the limb
-  genint_limb_t next, org = atomic_load(&s->data[i]);
+  genint_limb_ct next, org = atomic_load(&s->data[i]);
   do {
-    assert ((org & (GENINT_ONE << bit)) != 0);
+    M_ASSERT ((org & (GENINT_ONE << bit)) != 0);
     // Reset it
     next = org & (~(GENINT_ONE << bit));
     //  Try to unreserve it.
   } while (!atomic_compare_exchange_weak (&s->data[i], &org, next));
   // if the limb  was marked as full by master
-  genint_limb_t mask = s->mask0;
-  mask = (i == s->max) ? mask : -GENINT_ONE;
+  genint_limb_ct mask = s->mask0;
+  mask = (i == s->max) ? mask : GENINT_FULL_MASK;
   if (M_UNLIKELY (next != mask)) {
     // Let's compute the mask of this limb representing the limb as being full
     // Let's try to update master to say that this limb is not full
     while (true) {
-      genint_limb_t newMaster;
+      genint_limb_ct newMaster;
       if (next == mask) {
         newMaster = GENINT_MASTER_SET(master, i);
       } else {
@@ -219,4 +244,6 @@ static inline void genint_push(genint_t s, unsigned int n)
   GENINT_CONTRACT(s);
 }
 
+M_END_PROTECTED_CODE
+
 #endif

m-i-shared.h

@@ -1,7 +1,7 @@
 /*
  * M*LIB - INTRUSIVE SHARED PTR Module
  *
- * Copyright (c) 2017-2019, Patrick Pelissier
+ * Copyright (c) 2017-2021, Patrick Pelissier
  * All rights reserved.
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -28,119 +28,211 @@
 #include "m-core.h"
 #include "m-atomic.h"
 
+M_BEGIN_PROTECTED_CODE
+
 /* Define the oplist of a intrusive shared pointer.
    USAGE: ISHARED_OPLIST(name [, oplist_of_the_type]) */
-#define ISHARED_PTR_OPLIST(...)                                      \
-  ISHAREDI_PTR_OPLIST(M_IF_NARGS_EQ1(__VA_ARGS__)                    \
-                      ((__VA_ARGS__, M_DEFAULT_OPLIST),		     \
-                       (__VA_ARGS__ )))
+#define ISHARED_PTR_OPLIST(...)                                               \
+  ISHAREDI_PTR_OPLIST_P1(M_IF_NARGS_EQ1(__VA_ARGS__)                          \
+                         ((__VA_ARGS__, M_DEFAULT_OPLIST),                    \
+                          (__VA_ARGS__ )))
+
 
 /* Interface to add to a structure to allow intrusive support.
    name: name of the intrusive shared pointer.
    type: name of the type of the structure (aka. struct test_s) - not used currently.
    NOTE: There can be only one interface of this kind in a type! */
-#define ISHARED_PTR_INTERFACE(name, type)       \
+#define ISHARED_PTR_INTERFACE(name, type)                                     \
   atomic_int M_C(name, _cpt)
 
+
+/* Value of the interface field for static intialization (Uses C99 designated element). */
+#define ISHARED_PTR_STATIC_DESIGNATED_INIT(name, type)                        \
+  .M_C(name, _cpt) = ATOMIC_VAR_INIT(0)
+
+/* Value of the interface field for static intialization (Uses C89 designated element). */
+#define ISHARED_PTR_STATIC_INIT(name, type)                                   \
+  ATOMIC_VAR_INIT(0)
+
+
 /* Define the intrusive shared pointer type and its static inline functions.
-   USAGE: ISHARED_PTR_DEF(name[, oplist]) */
-#define ISHARED_PTR_DEF(name, ...)                                      \
-  ISHAREDI_PTR_DEF(M_IF_NARGS_EQ1(__VA_ARGS__)                          \
-                   ((name, __VA_ARGS__, M_GLOBAL_OPLIST_OR_DEF(__VA_ARGS__)() ), \
-                    (name, __VA_ARGS__ )))
+   USAGE: ISHARED_PTR_DEF(name, type, [, oplist]) */
+#define ISHARED_PTR_DEF(name, ...)                                            \
+  M_BEGIN_PROTECTED_CODE                                                      \
+  ISHAREDI_PTR_DEF_P1(M_IF_NARGS_EQ1(__VA_ARGS__)                             \
+                      ((name, __VA_ARGS__, M_GLOBAL_OPLIST_OR_DEF(__VA_ARGS__)(), M_C(name, _t)  ), \
+                       (name, __VA_ARGS__                                       , M_C(name, _t) ))) \
+  M_END_PROTECTED_CODE
+
+
+/* Define the intrusive shared pointer type and its static inline functions
+  as the name name_t
+   USAGE: ISHARED_PTR_DEF_AS(name, name_t, type, [, oplist]) */
+#define ISHARED_PTR_DEF_AS(name, name_t, ...)                                 \
+  M_BEGIN_PROTECTED_CODE                                                      \
+  ISHAREDI_PTR_DEF_P1(M_IF_NARGS_EQ1(__VA_ARGS__)                             \
+                      ((name, __VA_ARGS__, M_GLOBAL_OPLIST_OR_DEF(__VA_ARGS__)(), name_t ), \
+                       (name, __VA_ARGS__                                       , name_t ))) \
+  M_END_PROTECTED_CODE
 
 
 /********************************** INTERNAL ************************************/
 
-#define ISHAREDI_PTR_OPLIST(arg) ISHAREDI_PTR_OPLIST2 arg
+// Deferred evaluation
+#define ISHAREDI_PTR_OPLIST_P1(arg) ISHAREDI_PTR_OPLIST_P2 arg
 
-#define ISHAREDI_PTR_OPLIST2(name, oplist) (                            \
-  INIT(M_INIT_DEFAULT),                                                 \
-  INIT_SET(M_C(name, _init_set2) M_IPTR),				\
-  SET(M_C(name, _set) M_IPTR),						\
-  CLEAR(M_C(name, _clear)),						\
-  CLEAN(M_C(name, _clean) M_IPTR),					\
-  TYPE(M_C(name, _type_t)),						\
-  OPLIST(oplist),                                                       \
-  SUBTYPE(M_C(name, _type_t))						\
-  ,M_IF_METHOD(NEW, oplist)(NEW(M_GET_NEW oplist),)                     \
-  ,M_IF_METHOD(REALLOC, oplist)(REALLOC(M_GET_REALLOC oplist),)         \
-  ,M_IF_METHOD(DEL, oplist)(DEL(M_GET_DEL oplist),)                     \
+/* Validation of the given oplist */
+#define ISHAREDI_PTR_OPLIST_P2(name, oplist)                                  \
+  M_IF_OPLIST(oplist)(ISHAREDI_PTR_OPLIST_P3, ISHAREDI_PTR_OPLIST_FAILURE)(name, oplist)
+
+/* Prepare a clean compilation failure */
+#define ISHAREDI_PTR_OPLIST_FAILURE(name, oplist)                             \
+  ((M_LIB_ERROR(ARGUMENT_OF_ISHARED_PTR_OPLIST_IS_NOT_AN_OPLIST, name, oplist)))
+
+// Define the oplist
+#define ISHAREDI_PTR_OPLIST_P3(name, oplist) (                                \
+  INIT(M_INIT_DEFAULT),                                                       \
+  INIT_SET(API_4(M_C(name, _init_set))),                                      \
+  SET(M_C(name, _set) M_IPTR),                                                \
+  CLEAR(M_C(name, _clear)),                                                   \
+  CLEAN(M_C(name, _clean) M_IPTR),                                            \
+  TYPE(M_C(name, _ct)),                                                       \
+  OPLIST(oplist),                                                             \
+  SUBTYPE(M_C(name, _subtype_ct))                                             \
+  ,M_IF_METHOD(NEW, oplist)(NEW(M_GET_NEW oplist),)                           \
+  ,M_IF_METHOD(REALLOC, oplist)(REALLOC(M_GET_REALLOC oplist),)               \
+  ,M_IF_METHOD(DEL, oplist)(DEL(M_GET_DEL oplist),)                           \
   )
 
-#define ISHAREDI_PTR_DEF(arg) ISHAREDI_PTR_DEF2 arg
+// Deferred evaluatioin
+#define ISHAREDI_PTR_DEF_P1(arg) ISHAREDI_PTR_DEF_P2 arg
 
-#define ISHAREDI_PTR_DEF2(name, type, oplist)                           \
-                                                                        \
-  typedef type *M_C(name,_t);						\
-  typedef type M_C(name, _type_t);					\
-                                                                        \
-  static inline M_C(name,_t)                                            \
-  M_C(name, _init)(type *ptr)						\
-  {									\
-    if (M_LIKELY (ptr != NULL))                                         \
-      atomic_init(&ptr->M_C(name, _cpt), 1);                            \
-    return ptr;                                                         \
-  }									\
-  									\
-  static inline M_C(name,_t)                                            \
-  M_C(name, _init_set)(M_C(name,_t) shared)				\
-  {									\
-    if (M_LIKELY (shared != NULL))	{                               \
-      int n = atomic_fetch_add(&(shared->M_C(name, _cpt)), 1);		\
-      (void) n;								\
-    }									\
-    return shared;                                                      \
-  }									\
-  									\
-  static inline void				                        \
-  M_C(name, _init_set2)(M_C(name,_t) *ptr, M_C(name,_t) shared)         \
-  {									\
-    assert (ptr != NULL);                                               \
-    *ptr = M_C(name, _init_set)(shared);				\
-  }									\
-  									\
-  static inline M_C(name,_t)                                            \
-  M_C(name, _init_new)(void)                                            \
-  {									\
-    type *ptr = M_CALL_NEW(oplist, type);                               \
-    if (ptr == NULL) {                                                  \
-      M_MEMORY_FULL(sizeof(type));                                      \
-      return NULL;                                                      \
-    }                                                                   \
-    M_CALL_INIT(oplist, *ptr);                                          \
-    atomic_init (&ptr->M_C(name, _cpt), 1);                             \
-    return ptr;                                                         \
-  }									\
-  									\
-  static inline void				                        \
-  M_C(name, _clear)(M_C(name,_t) shared)                                \
-  {									\
-    if (shared != NULL)	{						\
-      if (atomic_fetch_sub(&(shared->M_C(name, _cpt)), 1) == 1)	{       \
-        M_CALL_CLEAR(oplist, *shared);                                  \
-        M_IF_DISABLED_METHOD(DEL, oplist)(, M_CALL_DEL(oplist, shared);) \
-      }									\
-    }                                                                   \
-  }									\
-  									\
-  static inline void				                        \
-  M_C(name, _clean)(M_C(name,_t) *shared)                               \
-  {									\
-    M_C(name, _clear)(*shared);						\
-    *shared = NULL;                                                     \
-  }                                                                     \
-                                                                        \
-  static inline void				                        \
-  M_C(name, _set)(M_C(name,_t) *ptr, M_C(name,_t)shared)                \
-  {									\
-    assert (ptr != NULL);                                               \
-    if (M_LIKELY (*ptr != shared)) {                                    \
-      M_C(name, _clear)(*ptr);						\
-      *ptr = M_C(name, _init_set)(shared);				\
-    }                                                                   \
-  }									\
-                                                                        \
+/* Validate the oplist before going further */
+#define ISHAREDI_PTR_DEF_P2(name, type, oplist, shared_t)                     \
+  M_IF_OPLIST(oplist)(ISHAREDI_PTR_DEF_P3, ISHAREDI_PTR_DEF_FAILURE)(name, type, oplist, shared_t)
+
+/* Stop processing with a compilation failure */
+#define ISHAREDI_PTR_DEF_FAILURE(name, type, oplist, shared_t)                \
+  M_STATIC_FAILURE(M_LIB_NOT_AN_OPLIST, "(ISHARED_PTR_DEF): the given argument is not a valid oplist: " #oplist)
+
+#define ISHAREDI_PTR_DEF_P3(name, type, oplist, shared_t)                     \
+                                                                              \
+  /* The shared pointer is only a pointer to the type */                      \
+  typedef type *shared_t;                                                     \
+                                                                              \
+  /* Define internal types for oplist */                                      \
+  typedef shared_t M_C(name, _ct);                                            \
+  typedef type     M_C(name, _subtype_ct);                                    \
+                                                                              \
+  M_CHECK_COMPATIBLE_OPLIST(name, 1, type, oplist)                            \
+                                                                              \
+  static inline shared_t                                                      \
+  M_C(name, _init)(type *ptr)                                                 \
+  {                                                                           \
+    /* Initialize the type referenced by the pointer */                       \
+    if (M_LIKELY (ptr != NULL)) {                                             \
+      atomic_init(&ptr->M_C(name, _cpt), 2);                                  \
+    }                                                                         \
+    return ptr;                                                               \
+  }                                                                           \
+                                                                              \
+  static inline shared_t                                                      \
+  M_C(name, _init_set)(shared_t shared)                                       \
+  {                                                                           \
+    if (M_LIKELY (shared != NULL)) {                                          \
+      int n = atomic_fetch_add(&(shared->M_C(name, _cpt)), 2);                \
+      (void) n;                                                               \
+    }                                                                         \
+    return shared;                                                            \
+  }                                                                           \
+                                                                              \
+  M_IF_METHOD(INIT, oplist)(                                                  \
+  M_IF_DISABLED_METHOD(NEW, oplist)                                           \
+  (                                                                           \
+  /* This function is only for static object */                               \
+  static inline shared_t                                                      \
+  M_C(name, _init_once)(type *shared)                                         \
+  {                                                                           \
+    if (M_LIKELY (shared != NULL)) {                                          \
+      /* Pretty much like atomic_add, except the first one increment by 1, others by 2 */ \
+      int o = atomic_load(&(shared->M_C(name, _cpt)));                        \
+      int n;                                                                  \
+      do {                                                                    \
+        n = o + 1 + (o != 0);                                                 \
+      } while (!atomic_compare_exchange_strong(&(shared->M_C(name, _cpt)), &o, n)); \
+      if (o == 0) {                                                           \
+      /* Partial initialization: _cpt is odd */                               \
+        /* Call the INIT function once */                                     \
+        M_CALL_INIT(oplist, *shared);                                         \
+        /* Finish initialization: _cpt is even */                             \
+        atomic_fetch_add(&(shared->M_C(name, _cpt)), 1);                      \
+      } else if ( (o&1) != 0) {                                               \
+        /* Not fully initialized yet: wait for initialization */              \
+        m_core_backoff_ct bkoff;                                              \
+        m_core_backoff_init(bkoff);                                           \
+        /* Wait for _cpt to be _even */                                       \
+        while ((atomic_load(&(shared->M_C(name, _cpt)))&1) != 0 ) {           \
+            m_core_backoff_wait(bkoff);                                       \
+        }                                                                     \
+      }                                                                       \
+      M_ASSERT( (atomic_load(&(shared->M_C(name, _cpt)))&1) == 0);            \
+    }                                                                         \
+    return shared;                                                            \
+  }                                                                           \
+  ,                                                                           \
+  /* This function is only for dynamic object */                              \
+  static inline shared_t                                                      \
+  M_C(name, _init_new)(void)                                                  \
+  {                                                                           \
+    type *ptr = M_CALL_NEW(oplist, type);                                     \
+    if (ptr == NULL) {                                                        \
+      M_MEMORY_FULL(sizeof(type));                                            \
+      return NULL;                                                            \
+    }                                                                         \
+    M_CALL_INIT(oplist, *ptr);                                                \
+    atomic_init (&ptr->M_C(name, _cpt), 2);                                   \
+    return ptr;                                                               \
+  }                                                                           \
+    /* End of NEW */)                                                         \
+  , /* End of INIT */)                                                        \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _clear)(shared_t shared)                                          \
+  {                                                                           \
+    if (shared != NULL) {                                                     \
+      if (atomic_fetch_sub(&(shared->M_C(name, _cpt)), 2) == 2) {             \
+        M_CALL_CLEAR(oplist, *shared);                                        \
+        M_IF_DISABLED_METHOD(DEL, oplist)(, M_CALL_DEL(oplist, shared);)      \
+      }                                                                       \
+    }                                                                         \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _clear_ptr)(shared_t *shared)                                     \
+  {                                                                           \
+    M_ASSERT(shared != NULL);                                                 \
+    M_C(name, _clear)(*shared);                                               \
+    *shared = NULL;                                                           \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _clean)(shared_t *shared)                                         \
+  {                                                                           \
+    M_C(name, _clear)(*shared);                                               \
+    *shared = NULL;                                                           \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _set)(shared_t *ptr, shared_t shared)                             \
+  {                                                                           \
+    M_ASSERT (ptr != NULL);                                                   \
+    if (M_LIKELY (*ptr != shared)) {                                          \
+      M_C(name, _clear)(*ptr);                                                \
+      *ptr = M_C(name, _init_set)(shared);                                    \
+    }                                                                         \
+  }                                                                           \
+                                                                              \
+
+M_END_PROTECTED_CODE
 
 #endif
-    

m-mempool.h

@@ -1,7 +1,7 @@
 /*
  * M*LIB - MEMPOOL module
  *
- * Copyright (c) 2017-2019, Patrick Pelissier
+ * Copyright (c) 2017-2021, Patrick Pelissier
  * All rights reserved.
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -37,113 +37,145 @@
      *ptr = 17;
      mempool_uint_free(m, ptr);
      mempool_uint_clear(m); // Give back memory to system
+   NOTE: Can not use m-list since it may be expanded from LIST_DEF
 */
-// NOTE: Can not use m-list since it may be expanded from LIST_DEF
+#define MEMPOOL_DEF(name, type)                                               \
+  M_BEGIN_PROTECTED_CODE                                                      \
+  MEMPOOL_DEF_P2(name, type, M_C(name, _t) )                                  \
+  M_END_PROTECTED_CODE
+
+
+/* Fast Fixed Size thread unsafe allocator based on memory region.
+   USAGE:
+     MEMPOOL_DEF_AS(memppol_uint, name_t, unsigned int)
+*/
+#define MEMPOOL_DEF_AS(name, name_t, type)                                    \
+  M_BEGIN_PROTECTED_CODE                                                      \
+  MEMPOOL_DEF_P2(name, type, name_t )                                         \
+  M_END_PROTECTED_CODE
 
-#define MEMPOOL_DEF(name, type)                                         \
-  									\
-  typedef union M_C(name,_union_s) {					\
-    type t;                                                             \
-    union M_C(name,_union_s) *next;					\
-  } M_C(name,_union_t);							\
-  									\
-  typedef struct M_C(name,_segment_s) {					\
-    unsigned int count;                                                 \
-    struct M_C(name,_segment_s) *next;					\
-    M_C(name,_union_t)	tab[MEMPOOL_MAX_PER_SEGMENT(type)];		\
-  } M_C(name,_segment_t);						\
-  									\
-  typedef struct M_C(name, _s) {					\
-    M_C(name,_union_t)   *free_list;					\
-    M_C(name,_segment_t) *current_segment;				\
-  } M_C(name,_t)[1];							\
-									\
-  static inline void                                                    \
-  M_C(name,_init)(M_C(name,_t) mem)                                     \
-  {                                                                     \
-    mem->free_list = NULL;                                              \
-    mem->current_segment = M_MEMORY_ALLOC(M_C(name,_segment_t));	\
-    if (mem->current_segment == NULL) {                                 \
-      M_MEMORY_FULL(sizeof (M_C(name,_segment_t)));			\
-      return;                                                           \
-    }                                                                   \
-    mem->current_segment->next = NULL;                                  \
-    mem->current_segment->count = 0;                                    \
-    MEMPOOLI_CONTRACT(mem, type);                                       \
-  }                                                                     \
-  									\
-  static inline void                                                    \
-  M_C(name,_clear)(M_C(name,_t) mem)					\
-  {                                                                     \
-    MEMPOOLI_CONTRACT(mem, type);                                       \
-    M_C(name,_segment_t) *segment = mem->current_segment;		\
-    while (segment != NULL) {                                           \
-      M_C(name,_segment_t) *next = segment->next;			\
-      M_MEMORY_DEL (segment);						\
-      segment = next;                                                   \
-    }                                                                   \
-    /* Clean pointers to be safer */					\
-    mem->free_list = NULL;                                              \
-    mem->current_segment = NULL;                                        \
-  }                                                                     \
-  									\
-  static inline type *                                                  \
-  M_C(name,_alloc)(M_C(name,_t) mem)					\
-  {                                                                     \
-    MEMPOOLI_CONTRACT(mem, type);                                       \
-    M_C(name,_union_t) *ret = mem->free_list;				\
-    if (ret != NULL) {                                                  \
-      mem->free_list = ret->next;                                       \
-      return &ret->t;                                                   \
-    }                                                                   \
-    M_C(name,_segment_t) *segment = mem->current_segment;		\
-    assert(segment != NULL);                                            \
-    unsigned int count = segment->count;                                \
-    if (M_UNLIKELY (count >= MEMPOOL_MAX_PER_SEGMENT(type))) {		\
-      M_C(name,_segment_t) *new_segment = M_MEMORY_ALLOC (M_C(name,_segment_t)); \
-      if (M_UNLIKELY (new_segment == NULL)) {				\
-        M_MEMORY_FULL(sizeof (M_C(name,_segment_t)));			\
-        return NULL;                                                    \
-      }                                                                 \
-      new_segment->next = segment;                                      \
-      new_segment->count = 0;                                           \
-      mem->current_segment = new_segment;                               \
-      segment = new_segment;                                            \
-      count = 0;                                                        \
-    }                                                                   \
-    ret = &segment->tab[count];                                         \
-    segment->count = count + 1;                                         \
-    MEMPOOLI_CONTRACT(mem, type);                                       \
-    return &ret->t;                                                     \
-  }                                                                     \
-  									\
-  static inline void                                                    \
-  M_C(name,_free)(M_C(name,_t) mem, type *ptr)				\
-  {                                                                     \
-    MEMPOOLI_CONTRACT(mem, type);                                       \
-    /* NOTE: Unsafe cast: suppose that the given pointer                \
-       was allocated by the previous alloc function. */                 \
-    M_C(name,_union_t) *ret = (M_C(name,_union_t) *)(uintptr_t)ptr;	\
-    ret->next = mem->free_list;                                         \
-    mem->free_list = ret;                                               \
-    MEMPOOLI_CONTRACT(mem, type);                                       \
-  }                                                                     \
 
 /* User shall be able to cutomize the size of the segment and/or
    the minimun number of elements.
+   The default is the number of elements that fits in 16KB.
 */
 #ifndef MEMPOOL_MAX_PER_SEGMENT
-#define MEMPOOL_MAX_PER_SEGMENT(type)					\
+#define MEMPOOL_MAX_PER_SEGMENT(type)                                         \
   M_MAX((16*1024-sizeof(unsigned int) - 2*sizeof(void*)) / sizeof (type), 256U)
 #endif
 
+
 /********************************** INTERNAL ************************************/
 
+#define MEMPOOL_DEF_P2(name, type, name_t)                                    \
+                                                                              \
+  /* Define the type of element in a segment of the mempool.                  \
+    Either it is the basic type or a pointer to another one.  */              \
+  typedef union M_C(name,_union_s) {                                          \
+    type t;                                                                   \
+    union M_C(name,_union_s) *next;                                           \
+  } M_C(name,_union_ct);                                                      \
+                                                                              \
+  /* Define a segment of a mempool.                                           \
+    It is an array of basic type, each segment is in a linked list */         \
+  typedef struct M_C(name,_segment_s) {                                       \
+    unsigned int count;                                                       \
+    struct M_C(name,_segment_s) *next;                                        \
+    M_C(name,_union_ct)        tab[MEMPOOL_MAX_PER_SEGMENT(type)];            \
+  } M_C(name,_segment_ct);                                                    \
+                                                                              \
+  /* Define a mempool.                                                        \
+    It is a pointer to the first free object within the segments              \
+    and the segments themselves           */                                  \
+  typedef struct M_C(name, _s) {                                              \
+    M_C(name,_union_ct)   *free_list;                                         \
+    M_C(name,_segment_ct) *current_segment;                                   \
+  } name_t[1];                                                                \
+                                                                              \
+  static inline void                                                          \
+  M_C(name,_init)(name_t mem)                                                 \
+  {                                                                           \
+    mem->free_list = NULL;                                                    \
+    mem->current_segment = M_MEMORY_ALLOC(M_C(name,_segment_ct));             \
+    if (mem->current_segment == NULL) {                                       \
+      M_MEMORY_FULL(sizeof (M_C(name,_segment_ct)));                          \
+      return;                                                                 \
+    }                                                                         \
+    mem->current_segment->next = NULL;                                        \
+    mem->current_segment->count = 0;                                          \
+    MEMPOOLI_CONTRACT(mem, type);                                             \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name,_clear)(name_t mem)                                                \
+  {                                                                           \
+    MEMPOOLI_CONTRACT(mem, type);                                             \
+    M_C(name,_segment_ct) *segment = mem->current_segment;                    \
+    while (segment != NULL) {                                                 \
+      M_C(name,_segment_ct) *next = segment->next;                            \
+      M_MEMORY_DEL (segment);                                                 \
+      segment = next;                                                         \
+    }                                                                         \
+    /* Clean pointers to be safer */                                          \
+    mem->free_list = NULL;                                                    \
+    mem->current_segment = NULL;                                              \
+  }                                                                           \
+                                                                              \
+  static inline type *                                                        \
+  M_C(name,_alloc)(name_t mem)                                                \
+  {                                                                           \
+    MEMPOOLI_CONTRACT(mem, type);                                             \
+    /* Test if one object is in the free list */                              \
+    M_C(name,_union_ct) *ret = mem->free_list;                                \
+    if (ret != NULL) {                                                        \
+      /* Yes, so return it, and pop it from the free list */                  \
+      mem->free_list = ret->next;                                             \
+      return &ret->t;                                                         \
+    }                                                                         \
+    /* No cheap free object exist. Test within a segment */                   \
+    M_C(name,_segment_ct) *segment = mem->current_segment;                    \
+    M_ASSERT(segment != NULL);                                                \
+    unsigned int count = segment->count;                                      \
+    /* If segment is full, allocate a new one from the system */              \
+    if (M_UNLIKELY (count >= MEMPOOL_MAX_PER_SEGMENT(type))) {                \
+      M_C(name,_segment_ct) *new_segment = M_MEMORY_ALLOC (M_C(name,_segment_ct)); \
+      if (M_UNLIKELY (new_segment == NULL)) {                                 \
+        M_MEMORY_FULL(sizeof (M_C(name,_segment_ct)));                        \
+        return NULL;                                                          \
+      }                                                                       \
+      new_segment->next = segment;                                            \
+      new_segment->count = 0;                                                 \
+      mem->current_segment = new_segment;                                     \
+      segment = new_segment;                                                  \
+      count = 0;                                                              \
+    }                                                                         \
+    /* Return the object as the last element of the current segment */        \
+    ret = &segment->tab[count];                                               \
+    segment->count = count + 1;                                               \
+    MEMPOOLI_CONTRACT(mem, type);                                             \
+    return &ret->t;                                                           \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name,_free)(name_t mem, type *ptr)                                      \
+  {                                                                           \
+    MEMPOOLI_CONTRACT(mem, type);                                             \
+    /* NOTE: Unsafe cast: suppose that the given pointer                      \
+       was allocated by the previous alloc function. */                       \
+    M_C(name,_union_ct) *ret = (M_C(name,_union_ct) *)(uintptr_t)ptr;         \
+    /* Add the object back in the free list */                                \
+    ret->next = mem->free_list;                                               \
+    mem->free_list = ret;                                                     \
+    /* NOTE: the objects are NOT given back to the system until the mempool   \
+    is fully cleared */                                                       \
+    MEMPOOLI_CONTRACT(mem, type);                                             \
+  }                                                                           \
 
-#define MEMPOOLI_CONTRACT(mempool, type) do {                           \
-    assert((mempool) != NULL);                                          \
-    assert((mempool)->current_segment != NULL);                         \
-    assert((mempool)->current_segment->count <= MEMPOOL_MAX_PER_SEGMENT(type)); \
+/* MEMPOOL contract */
+#define MEMPOOLI_CONTRACT(mempool, type) do {                                 \
+    M_ASSERT((mempool) != NULL);                                              \
+    M_ASSERT((mempool)->current_segment != NULL);                             \
+    M_ASSERT((mempool)->current_segment->count <= MEMPOOL_MAX_PER_SEGMENT(type)); \
   } while (0)
 
 #endif

m-mutex.h

@@ -1,7 +1,7 @@
 /*
  * M*LIB - Thin Mutex & Thread wrapper
  *
- * Copyright (c) 2017-2019, Patrick Pelissier
+ * Copyright (c) 2017-2021, Patrick Pelissier
  * All rights reserved.
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -25,108 +25,173 @@
 #ifndef MSTARLIB_MUTEX_H
 #define MSTARLIB_MUTEX_H
 
-#if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L    \
+/* Auto-detect the thread backend to use if the user has not override it */
+#ifndef M_USE_THREAD_BACKEND
+# if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L                 \
   && !defined(__STDC_NO_THREADS__)
+#  define M_USE_THREAD_BACKEND 1
+# elif defined(WIN32) || defined(_WIN32) || defined(__CYGWIN__)
+#  define M_USE_THREAD_BACKEND 2
+# else
+#  define M_USE_THREAD_BACKEND 3
+# endif
+#endif
+
 
 /****************************** C11 version ********************************/
+#if M_USE_THREAD_BACKEND == 1
 
 #include <threads.h>
 #include <assert.h>
 #include <stdbool.h>
 #include "m-core.h"
 
+M_BEGIN_PROTECTED_CODE
+
+/* Define a mutex type based on C11 definition */
 typedef mtx_t                  m_mutex_t[1];
+
+/* Define a condition variable type based on C11 definition */
 typedef cnd_t                  m_cond_t[1];
+
+/* Define a thread type based on C11 definition */
 typedef thrd_t                 m_thread_t[1];
 
+/* Initialize the mutex (constructor) */
 static inline void m_mutex_init(m_mutex_t m)
 {
   int rc = mtx_init(m, mtx_plain);
+  // Abort program in case of initialization failure
+  // There is really nothing else to do if a mutex cannot be constructed
   M_ASSERT_INIT (rc == 0, "mutex");
 }
 
+/* Clear the mutex (destructor) */
 static inline void m_mutex_clear(m_mutex_t m)
 {
   mtx_destroy(m);
 }
 
+/* Lock the mutex */
 static inline void m_mutex_lock(m_mutex_t m)
 {
   mtx_lock(m);
 }
 
+/* Unlock the mutex */
 static inline void m_mutex_unlock(m_mutex_t m)
 {
   mtx_unlock(m);
 }
 
+/* Initialize the condition variable (constructor) */
 static inline void m_cond_init(m_cond_t c)
 {
   int rc = cnd_init(c);
+  // Abort program in case of initialization failure
+  // There is really nothing else to do if the object cannot be constructed
   M_ASSERT_INIT (rc == 0, "conditional variable");
 }
 
+/* Clear the condition variable (destructor) */
 static inline void m_cond_clear(m_cond_t c)
 {
   cnd_destroy(c);
 }
 
+/* Signal the condition variable to at least one waiting thread */
 static inline void m_cond_signal(m_cond_t c)
 {
   cnd_signal(c);
 }
 
+/* Signal the condition variable to all waiting threads */
 static inline void m_cond_broadcast(m_cond_t c)
 {
   cnd_broadcast(c);
 }
 
+/* Wait for signaling the condition variable by another thread */
 static inline void m_cond_wait(m_cond_t c, m_mutex_t m)
 {
   cnd_wait(c, m);
 }
 
+/* Create the thread (constructor) and start it */
 static inline void m_thread_create(m_thread_t t, void (*func)(void*), void* arg)
 {
   int rc = thrd_create(t, (int(*)(void*))(void(*)(void))func, arg);
+  // Abort program in case of initialization failure
   M_ASSERT_INIT (rc == thrd_success, "thread");
 }
 
+/* Wait for the thread to terminate and destroy it (destructor) */
 static inline void m_thread_join(m_thread_t t)
 {
   int rc = thrd_join(*t, NULL);
-  assert (rc == thrd_success);
+  M_ASSERT (rc == thrd_success);
+  // Avoid warning about variable unused.
+  (void) rc;
 }
 
+/* The thread has nothing meaningfull to do.
+   Inform the OS to let other threads be scheduled */
 static inline void m_thread_yield(void)
 {
   thrd_yield();
 }
 
+/* Sleep the thread for at least usec microseconds.
+   Return true if the sleep was successful */
 static inline bool m_thread_sleep(unsigned long long usec)
 {
   struct timespec tv;
-  tv.tv_sec = usec / 1000000ULL;
-  tv.tv_nsec = (usec % 1000000ULL) * 1000UL;
+  tv.tv_sec = (long) (usec / 1000000ULL);
+  tv.tv_nsec = (long) ((usec % 1000000ULL) * 1000UL);
   int retval = thrd_sleep(&tv, NULL);
   return retval == 0;
 }
 
 // Internal type, not exported.
-typedef once_flag                     m_oncei_t[1];
+typedef once_flag                     m_once_ct[1];
+
+// Initial value for m_once_ct
 #define M_ONCEI_INIT_VALUE            { ONCE_FLAG_INIT }
-static inline void m_oncei_call(m_oncei_t o, void (*func)(void))
+
+// Call the function exactly once
+static inline void m_oncei_call(m_once_ct o, void (*func)(void))
 {
   call_once(o,func);
 }
 
+// Attribute to use to allocate a global variable to a thread.
 #define M_THREAD_ATTR _Thread_local
 
+M_END_PROTECTED_CODE
 
-// MSYS2 doesn't define _WIN32 by default.
-#elif defined(WIN32) || defined(_WIN32) || defined(__CYGWIN__)
 
 /****************************** WIN32 version ******************************/
+#elif M_USE_THREAD_BACKEND == 2
+
+/* CLANG provides some useless and wrong warnings:
+ * - _WIN32_WINNT starts with '_' which is reserved by the standard
+ * as per the MSVC compiler, it is needed to be defined by the user
+ * to define which version of windows it want to be compatible with.
+ * - windows.h may be different than the case used by the file sytem
+ * there is however no normalized case.
+ *
+ * So, theses warnings have to be ignored and are disabled.
+ *
+ * We cannot add theses warnings in M_BEGIN_PROTECTED_CODE
+ * as they need to be disabled **BEFORE** including any system header
+ * and m-core includes some system headers.
+ * So we need to disable them explictly here.
+ */
+#if defined(__clang__) && __clang_major__ >= 4
+  _Pragma("clang diagnostic push")
+  _Pragma("clang diagnostic ignored \"-Wreserved-id-macro\"")
+  _Pragma("clang diagnostic ignored \"-Wnonportable-system-include-path\"")
+#endif
 
 /* CriticalSection & ConditionVariable are available from Windows Vista */
 #ifndef WINVER
@@ -135,83 +200,112 @@ static inline void m_oncei_call(m_oncei_t o, void (*func)(void))
 #ifndef _WIN32_WINNT
 #define _WIN32_WINNT  _WIN32_WINNT_VISTA
 #endif
+
+/* Include system headers */
 #include <windows.h>
 #include <assert.h>
 #include <stdbool.h>
 #include "m-core.h"
 
+#if defined(__clang__) && __clang_major__ >= 4
+  _Pragma("clang diagnostic pop")
+#endif
+
+M_BEGIN_PROTECTED_CODE
+
+/* Define a thread type based on WINDOWS definition */
 typedef HANDLE                 m_thread_t[1];
+
+/* Define a mutex type based on WINDOWS definition */
 typedef CRITICAL_SECTION       m_mutex_t[1];
+
+/* Define a condition variable type based on WINDOWS definition */
 typedef CONDITION_VARIABLE     m_cond_t[1];
 
+/* Initialize a mutex (Constructor)*/
 static inline void m_mutex_init(m_mutex_t m)
 {
   InitializeCriticalSection(m);
 }
 
+/* Clear a mutex (destructor) */
 static inline void m_mutex_clear(m_mutex_t m)
 {
   DeleteCriticalSection(m);
 }
 
+/* Lock a mutex */
 static inline void m_mutex_lock(m_mutex_t m)
 {
   EnterCriticalSection(m);
 }
 
+/* Unlock a mutex */
 static inline void m_mutex_unlock(m_mutex_t m)
 {
   LeaveCriticalSection(m);
 }
 
+/* Initialize a condition variable (constructor) */
 static inline void m_cond_init(m_cond_t c)
 {
   InitializeConditionVariable(c);
 }
 
+/* Clear a condition variable (destructor) */
 static inline void m_cond_clear(m_cond_t c)
 {
   (void) c; // There is no destructor for this object.
 }
 
+/* Signal a condition variable to at least one waiting thread */
 static inline void m_cond_signal(m_cond_t c)
 {
   WakeConditionVariable(c);
 }
 
+/* Signal a condition variable to all waiting threads */
 static inline void m_cond_broadcast(m_cond_t c)
 {
   WakeAllConditionVariable(c);
 }
 
+/* Wait for a condition variable */
 static inline void m_cond_wait(m_cond_t c, m_mutex_t m)
 {
   SleepConditionVariableCS(c, m, INFINITE);
 }
 
+/* Create a thread (constructor) and start it */
 static inline void m_thread_create(m_thread_t t, void (*func)(void*), void *arg)
 {
-  *t = CreateThread(NULL, 0, (LPTHREAD_START_ROUTINE) func, arg, 0, NULL);
+  *t = CreateThread(NULL, 0, (LPTHREAD_START_ROUTINE) (uintptr_t) func, arg, 0, NULL);
   M_ASSERT_INIT (*t != NULL, "thread");
 }
 
+/* Wait for the thread to terminate and destroy it (destructor) */
 static inline void m_thread_join(m_thread_t t)
 {
   DWORD dwWaitResult = WaitForSingleObject(*t, INFINITE);
   (void) dwWaitResult;
-  assert (dwWaitResult == WAIT_OBJECT_0);
+  M_ASSERT (dwWaitResult == WAIT_OBJECT_0);
   CloseHandle(*t);
 }
 
+/* The thread has nothing meaningfull to do.
+   Inform the OS to let other threads be scheduled */
 static inline void m_thread_yield(void)
 {
   Sleep(0);
 }
 
+/* Sleep the thread for at least usec microseconds
+   Return true if the sleep was successful */
 static inline bool m_thread_sleep(unsigned long long usec)
 {
   LARGE_INTEGER ft;
-  ft.QuadPart = -(10ULL*usec);
+  M_ASSERT (usec <= LLONG_MAX);
+  ft.QuadPart = -(10LL*(long long) usec);
   HANDLE hd = CreateWaitableTimer(NULL, TRUE, NULL);
   M_ASSERT_INIT (hd != NULL, "timer");
   SetWaitableTimer(hd, &ft, 0, NULL, NULL, 0);
@@ -222,7 +316,7 @@ static inline bool m_thread_sleep(unsigned long long usec)
 
 
 // Internal type, not exported.
-typedef INIT_ONCE                     m_oncei_t[1];
+typedef INIT_ONCE                     m_once_ct[1];
 #define M_ONCEI_INIT_VALUE            { INIT_ONCE_STATIC_INIT }
 static inline BOOL CALLBACK m_oncei_callback( PINIT_ONCE InitOnce, PVOID Parameter, PVOID *lpContext)
 {
@@ -233,20 +327,24 @@ static inline BOOL CALLBACK m_oncei_callback( PINIT_ONCE InitOnce, PVOID Paramet
     (*func)();
     return TRUE;
 }
-static inline void m_oncei_call(m_oncei_t o, void (*func)(void))
+static inline void m_oncei_call(m_once_ct o, void (*func)(void))
 {
   InitOnceExecuteOnce(o, m_oncei_callback, (void*)(intptr_t)func, NULL);
 }
 
 #if defined(_MSC_VER)
+// Attribute to use to allocate a global variable to a thread (MSVC def).
 # define M_THREAD_ATTR __declspec( thread )
 #else
+// Attribute to use to allocate a global variable to a thread (GCC def).
 # define M_THREAD_ATTR __thread
 #endif
 
-#else
+M_END_PROTECTED_CODE
+
 
 /**************************** PTHREAD version ******************************/
+#else
 
 #include <pthread.h>
 #ifdef _POSIX_PRIORITY_SCHEDULING
@@ -259,76 +357,103 @@ static inline void m_oncei_call(m_oncei_t o, void (*func)(void))
 #include <stdbool.h>
 #include "m-core.h"
 
+M_BEGIN_PROTECTED_CODE
+
+/* Define a mutex type based on PTHREAD definition */
 typedef pthread_mutex_t        m_mutex_t[1];
+
+/* Define a condition variable type based on PTHREAD definition */
 typedef pthread_cond_t         m_cond_t[1];
+
+/* Define a thread type based on PTHREAD definition */
 typedef pthread_t              m_thread_t[1];
 
+/* Initialize the mutex (constructor) */
 static inline void m_mutex_init(m_mutex_t m)
 {
   int _rc = pthread_mutex_init(m, NULL);
+  // Abort program in case of initialization failure
+  // There is really nothing else to do if a mutex cannot be constructed
   M_ASSERT_INIT (_rc == 0, "mutex");
 }
 
+/* Clear the mutex (destructor) */
 static inline void m_mutex_clear(m_mutex_t m)
 {
   pthread_mutex_destroy(m);
 }
 
+/* Lock the mutex */
 static inline void m_mutex_lock(m_mutex_t m)
 {
   pthread_mutex_lock(m);
 }
 
+/* Unlock the mutex */
 static inline void m_mutex_unlock(m_mutex_t m)
 {
   pthread_mutex_unlock(m);
 }
 
+/* Lazy lock initialization */
 #define M_MUTEXI_INIT_VALUE    { PTHREAD_MUTEX_INITIALIZER }
+
+/* Internal function compatible with lazy lock */
 static inline void m_mutexi_lazy_lock(m_mutex_t m)
 {
   pthread_mutex_lock(m);
 }
 
+/* Initialize the condition variable (constructor) */
 static inline void m_cond_init(m_cond_t c)
 {
   int _rc = pthread_cond_init(c, NULL);
+  // Abort program in case of initialization failure
+  // There is really nothing else to do if a mutex cannot be constructed
   M_ASSERT_INIT (_rc == 0, "conditional variable");
 }
 
+/* Clear the condition variable (destructor) */
 static inline void m_cond_clear(m_cond_t c)
 {
   pthread_cond_destroy(c);
 }
 
+/* Signal a condition variable to at least a waiting thread */
 static inline void m_cond_signal(m_cond_t c)
 {
   pthread_cond_signal(c);
 }
 
+/* Signal a condition variable to all waiting threads */
 static inline void m_cond_broadcast(m_cond_t c)
 {
   pthread_cond_broadcast(c);
 }
 
+/* Waiting for a condition variable */
 static inline void m_cond_wait(m_cond_t c, m_mutex_t m)
 {
   pthread_cond_wait(c, m);
 }
 
+/* Create a thread (constructor) and start it */
 static inline void m_thread_create(m_thread_t t, void (*func)(void*), void *arg)
 {
   int _rc = pthread_create(t, NULL, (void*(*)(void*))(void(*)(void))func, arg);
   M_ASSERT_INIT (_rc == 0, "thread");
 }
 
+/* Wait for the thread to terminate and destroy it (destructor) */
 static inline void m_thread_join(m_thread_t t)
 {
   int _rc = pthread_join(*t, NULL);
   (void)_rc; // Avoid warning about variable unused.
-  assert (_rc == 0);
+  M_ASSERT (_rc == 0);
 }
 
+/* The thread has nothing meaningfull to do.
+   Inform the OS to let other threads be scheduled */
 static inline void m_thread_yield(void)
 {
 #ifdef _POSIX_PRIORITY_SCHEDULING
@@ -336,30 +461,33 @@ static inline void m_thread_yield(void)
 #endif
 }
 
+/* Sleep for at least usec microseconds
+   Return true if the sleep was successful */
 static inline bool m_thread_sleep(unsigned long long usec)
 {
   struct timeval tv;
   /* We don't want to use usleep or nanosleep so that
      we remain compatible with strict C99 build */
-  tv.tv_sec = usec / 1000000ULL;
-  tv.tv_usec = usec % 1000000ULL;
+  tv.tv_sec = (time_t) (usec / 1000000ULL);
+  tv.tv_usec = (suseconds_t) (usec % 1000000ULL);
   int retval = select(1, NULL, NULL, NULL, &tv);
   return retval == 0;
 }
 
 // Internal type, not exported.
-typedef pthread_once_t                m_oncei_t[1];
+typedef pthread_once_t                m_once_ct[1];
 #define M_ONCEI_INIT_VALUE            { PTHREAD_ONCE_INIT }
-static inline void m_oncei_call(m_oncei_t o, void (*func)(void))
+static inline void m_oncei_call(m_once_ct o, void (*func)(void))
 {
   pthread_once(o,func);
 }
 
 #define M_THREAD_ATTR __thread
 
+M_END_PROTECTED_CODE
+
 #endif
 
-// TODO: m_thread_sleep doesn't yield thread during waiting, making it a poor choice for active waiting.
 // TODO: Obsolete M_LOCK macro.
 
 /* M_LOCK macro. Allow simple locking encapsulation.
@@ -375,25 +503,25 @@ static inline void m_oncei_call(m_oncei_t o, void (*func)(void))
    or using C11's ONCE mechanism */
 #ifdef M_MUTEXI_INIT_VALUE
 # define M_LOCK_DECL(name) m_mutex_t name = M_MUTEXI_INIT_VALUE
-# define M_LOCK(name)                                                   \
+# define M_LOCK(name)                                                         \
   M_LOCKI_DO(name, M_C(local_cont_, __LINE__), m_mutexi_lazy_lock, m_mutex_unlock)
 #else
-# define M_LOCK_DECL(name)                                      \
-  m_mutex_t name;                                               \
-  static void M_C(m_mutex_init_, name)(void) {                  \
-    m_mutex_init(name);                                         \
-  }                                                             \
-  m_oncei_t M_C(m_once_, name) = M_ONCEI_INIT_VALUE
-# define M_LOCKI_BY_ONCE(name)                                          \
-  (m_oncei_call(M_C(m_once_, name), M_C(m_mutex_init_, name)),          \
+# define M_LOCK_DECL(name)                                                    \
+  m_mutex_t name;                                                             \
+  static void M_C(m_mutex_init_, name)(void) {                                \
+    m_mutex_init(name);                                                       \
+  }                                                                           \
+  m_once_ct M_C(m_once_, name) = M_ONCEI_INIT_VALUE
+# define M_LOCKI_BY_ONCE(name)                                                \
+  (m_oncei_call(M_C(m_once_, name), M_C(m_mutex_init_, name)),                \
    m_mutex_lock(name), (void) 0 )
-# define M_LOCK(name)                                                   \
+# define M_LOCK(name)                                                         \
   M_LOCKI_DO(name, M_C(local_cont_, __LINE__), M_LOCKI_BY_ONCE, m_mutex_unlock)
 #endif
 
-#define M_LOCKI_DO(name, cont, lock_func, unlock_func)                \
-  for(bool cont = true                                                \
-        ; cont && (lock_func (name), true);                           \
+#define M_LOCKI_DO(name, cont, lock_func, unlock_func)                        \
+  for(bool cont = true                                                        \
+        ; cont && (lock_func (name), true);                                   \
       (unlock_func (name), cont = false))
 
 #endif

m-prioqueue.h

@@ -1,7 +1,7 @@
 /*
  * M*LIB - dynamic priority queue module
  *
- * Copyright (c) 2017-2019, Patrick Pelissier
+ * Copyright (c) 2017-2021, Patrick Pelissier
  * All rights reserved.
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -26,323 +26,413 @@
 #define MSTARLIB_PRIOQUEUE_H
 
 #include "m-core.h"
-#include "m-array.h"
+#include "m-array.h"            /* Priority queue are built upon array */
 
 /* Priority queue based on binary heap implementation */
 
 /* Define a prioqueue of a given type and its associated functions.
    USAGE: PRIOQUEUE_DEF(name, type [, oplist_of_the_type]) */
-#define PRIOQUEUE_DEF(name, ...)                                            \
-  PRIOQUEUEI_DEF(M_IF_NARGS_EQ1(__VA_ARGS__)                                \
-                 ((name, __VA_ARGS__, M_GLOBAL_OPLIST_OR_DEF(__VA_ARGS__)(), M_C(name,_t), M_C(name,_it_t) ), \
-   (name, __VA_ARGS__,                                      M_C(name,_t), M_C(name,_it_t))))
+#define PRIOQUEUE_DEF(name, ...)                                              \
+  M_BEGIN_PROTECTED_CODE                                                      \
+  PRIOQUEUEI_DEF_P1(M_IF_NARGS_EQ1(__VA_ARGS__)                               \
+                    ((name, __VA_ARGS__, M_GLOBAL_OPLIST_OR_DEF(__VA_ARGS__)(), M_C(name,_t), M_C(name,_it_t) ), \
+                     (name, __VA_ARGS__,                                        M_C(name,_t), M_C(name,_it_t)))) \
+  M_END_PROTECTED_CODE
+
+
+/* Define a prioqueue of a given type and its associated functions.
+  as the name name_t with an iterator named it_t
+   USAGE: PRIOQUEUE_DEF_AS(name, name_t, it_t, type [, oplist_of_the_type]) */
+#define PRIOQUEUE_DEF_AS(name, name_t, it_t, ...)                             \
+  M_BEGIN_PROTECTED_CODE                                                      \
+  PRIOQUEUEI_DEF_P1(M_IF_NARGS_EQ1(__VA_ARGS__)                               \
+                    ((name, __VA_ARGS__, M_GLOBAL_OPLIST_OR_DEF(__VA_ARGS__)(), name_t, it_t ), \
+                     (name, __VA_ARGS__,                                        name_t, it_t ))) \
+  M_END_PROTECTED_CODE
+
 
 /* Define the oplist of a prioqueue of type.
    USAGE: PRIOQUEUE_OPLIST(name[, oplist of the type]) */
-#define PRIOQUEUE_OPLIST(...)                                           \
-  PRIOQUEUEI_OPLIST(M_IF_NARGS_EQ1(__VA_ARGS__)                         \
-                    ((__VA_ARGS__, M_DEFAULT_OPLIST),			\
-                     (__VA_ARGS__ )))
+#define PRIOQUEUE_OPLIST(...)                                                 \
+  PRIOQUEUEI_OPLIST_P1(M_IF_NARGS_EQ1(__VA_ARGS__)                            \
+                       ((__VA_ARGS__, M_DEFAULT_OPLIST),                      \
+                        (__VA_ARGS__ )))
+
 
 
 /********************************** INTERNAL ************************************/
 
-#define PRIOQUEUEI_OPLIST(arg) PRIOQUEUEI_OPLIST2 arg
-#define PRIOQUEUEI_DEF(arg)    PRIOQUEUEI_DEF2 arg
+/* Deferred evaluation for the definition,
+   so that all arguments are evaluated before further expansion */
+#define PRIOQUEUEI_OPLIST_P1(arg) PRIOQUEUEI_OPLIST_P2 arg
 
-#define PRIOQUEUEI_OPLIST2(name, oplist)                                \
-  (INIT(M_C(name, _init))						\
-   ,INIT_SET(M_C(name, _init_set))					\
-   ,INIT_WITH(API_1(M_INIT_VAI))                                        \
-   ,SET(M_C(name, _set))						\
-   ,CLEAR(M_C(name, _clear))						\
-   ,INIT_MOVE(M_C(name, _init_move))					\
-   ,MOVE(M_C(name, _move))						\
-   ,SWAP(M_C(name, _swap))						\
-   ,TYPE(M_C(name,_t))							\
-   ,SUBTYPE(M_C(name, _type_t))						\
-   ,CLEAN(M_C(name,_clean))						\
-   ,PUSH(M_C(name,_push))						\
-   ,POP(M_C(name,_pop))                                                 \
-   ,OPLIST(oplist)                                                      \
-   ,TEST_EMPTY(M_C(name, _empty_p)),                                    \
-   ,GET_SIZE(M_C(name, _size))                                          \
+/* Validation of the given oplist */
+#define PRIOQUEUEI_OPLIST_P2(name, oplist)                                    \
+  M_IF_OPLIST(oplist)(PRIOQUEUEI_OPLIST_P3, PRIOQUEUEI_OPLIST_FAILURE)(name, oplist)
+
+/* Prepare a clean compilation failure */
+#define PRIOQUEUEI_OPLIST_FAILURE(name, oplist)                               \
+  ((M_LIB_ERROR(ARGUMENT_OF_PRIOQUEUE_OPLIST_IS_NOT_AN_OPLIST, name, oplist)))
+
+/* Define oplist of a priority queue */
+#define PRIOQUEUEI_OPLIST_P3(name, oplist)                                    \
+  (INIT(M_C(name, _init))                                                     \
+   ,INIT_SET(M_C(name, _init_set))                                            \
+   ,INIT_WITH(API_1(M_INIT_VAI))                                              \
+   ,SET(M_C(name, _set))                                                      \
+   ,CLEAR(M_C(name, _clear))                                                  \
+   ,INIT_MOVE(M_C(name, _init_move))                                          \
+   ,MOVE(M_C(name, _move))                                                    \
+   ,SWAP(M_C(name, _swap))                                                    \
+   ,TYPE(M_C(name,_ct))                                                       \
+   ,SUBTYPE(M_C(name, _subtype_ct))                                           \
+   ,CLEAN(M_C(name,_clean))                                                   \
+   ,PUSH(M_C(name,_push))                                                     \
+   ,POP(M_C(name,_pop))                                                       \
+   ,OPLIST(oplist)                                                            \
+   ,EMPTY_P(M_C(name, _empty_p)),                                             \
+   ,GET_SIZE(M_C(name, _size))                                                \
+   ,IT_TYPE(M_C(name, _it_ct)),                                               \
+   IT_FIRST(M_C(name,_it)),                                                   \
+   IT_END(M_C(name,_it_end)),                                                 \
+   IT_SET(M_C(name,_it_set)),                                                 \
+   IT_END_P(M_C(name,_end_p)),                                                \
+   IT_EQUAL_P(M_C(name,_it_equal_p)),                                         \
+   IT_LAST_P(M_C(name,_last_p)),                                              \
+   IT_NEXT(M_C(name,_next)),                                                  \
+   IT_CREF(M_C(name,_cref)),                                                  \
    )
 
-#define PRIOQUEUEI_DEF2(name, type, oplist, prioqueue_t, it_t)          \
-  ARRAY_DEF(M_C(name, _array), type, oplist)                            \
-                                                                        \
-  typedef type M_C(name, _type_t);					\
-									\
-  typedef struct M_C(name, _s) {                                        \
-    M_C(name, _array_t) array;                                          \
-  } prioqueue_t[1];                                                     \
-  typedef struct M_C(name, _s) *M_C(name, _ptr);                        \
-  typedef const struct M_C(name, _s) *M_C(name, _srcptr);               \
-                                                                        \
-  typedef M_C(name, _array_it_t) it_t;                                  \
-                                                                        \
-  static inline void                                                    \
-  M_C(name, _init)(prioqueue_t p)                                       \
-  {                                                                     \
-    M_C(name, _array_init)(p->array);                                   \
-  }                                                                     \
-                                                                        \
-  static inline void                                                    \
-  M_C(name, _init_set)(prioqueue_t p, prioqueue_t o)                    \
-  {                                                                     \
-    M_C(name, _array_init_set)(p->array, o->array);                     \
-  }                                                                     \
-                                                                        \
-  static inline void                                                    \
-  M_C(name, _set)(prioqueue_t p, prioqueue_t o)                         \
-  {                                                                     \
-    M_C(name, _array_set)(p->array, o->array);                          \
-  }                                                                     \
-                                                                        \
-  static inline void                                                    \
-  M_C(name, _clear)(prioqueue_t p)                                      \
-  {                                                                     \
-    M_C(name, _array_clear)(p->array);                                  \
-  }                                                                     \
-                                                                        \
-  static inline void                                                    \
-  M_C(name, _init_move)(prioqueue_t p, prioqueue_t o)                   \
-  {                                                                     \
-    M_C(name, _array_init_move)(p->array, o->array);                    \
-  }                                                                     \
-                                                                        \
-  static inline void                                                    \
-  M_C(name, _move)(prioqueue_t p, prioqueue_t o)                        \
-  {                                                                     \
-    M_C(name, _array_move)(p->array, o->array);                         \
-  }                                                                     \
-                                                                        \
-  static inline void                                                    \
-  M_C(name, _swap)(prioqueue_t p, prioqueue_t o)                        \
-  {                                                                     \
-    M_C(name, _array_swap)(p->array, o->array);                         \
-  }                                                                     \
-                                                                        \
-  static inline void                                                    \
-  M_C(name, _clean)(prioqueue_t p)                                      \
-  {                                                                     \
-    M_C(name, _array_clean)(p->array);                                  \
-  }                                                                     \
-                                                                        \
-  static inline size_t                                                  \
-  M_C(name, _i_parent)(size_t i)                                        \
-  {                                                                     \
-    assert (i > 0);                                                     \
-    return (i - 1) / 2;                                                 \
-  }                                                                     \
-                                                                        \
-  static inline size_t                                                  \
-  M_C(name, _i_lchild)(size_t i)                                        \
-  {                                                                     \
-    assert(i <= ((-(size_t)1)-2)/2);                                    \
-    return 2*i + 1;                                                     \
-  }                                                                     \
-                                                                        \
-  static inline size_t                                                  \
-  M_C(name, _i_rchild)(size_t i)                                        \
-  {                                                                     \
-    assert(i <= ((-(size_t)1)-2)/2);                                    \
-    return 2*i + 2;                                                     \
-  }                                                                     \
-                                                                        \
-  static inline int                                                     \
-  M_C(name, _i_cmp)(const prioqueue_t p, size_t i, size_t j)            \
-  {                                                                     \
-    return M_CALL_CMP(oplist, *M_C(name, _array_cget)(p->array, i),     \
-                      *M_C(name, _array_cget)(p->array, j));            \
-  }                                                                     \
-                                                                        \
-  static inline bool                                                    \
-  M_C(name, _empty_p)(const prioqueue_t p)                              \
-  {                                                                     \
-    return M_C(name, _array_empty_p)(p->array);                         \
-  }                                                                     \
-                                                                        \
-  static inline size_t                                                  \
-  M_C(name, _size)(const prioqueue_t p)                                 \
-  {                                                                     \
-    return M_C(name, _array_size)(p->array);                            \
-  }                                                                     \
-                                                                        \
-  static inline void                                                    \
-  M_C(name, _push)(prioqueue_t p, type const x)                         \
-  {                                                                     \
-    M_C(name, _array_push_back)(p->array, x);                           \
-                                                                        \
-    size_t i = M_C(name, _array_size)(p->array)-1;                      \
-    while (i > 0) {                                                     \
-      size_t j = M_C(name, _i_parent)(i);                               \
-      if (M_C(name, _i_cmp)(p, j, i) <= 0)                              \
-        break;                                                          \
-      M_C(name, _array_swap_at) (p->array, i, j);                       \
-      i = j;                                                            \
-    }                                                                   \
-  }                                                                     \
-                                                                        \
-  static inline type const *                                            \
-  M_C(name, _front)(prioqueue_t p)                                      \
-  {                                                                     \
-    return M_C(name, _array_cget)(p->array, 0);                         \
-  }                                                                     \
-                                                                        \
-  static inline void                                                    \
-  M_C(name, _pop)(type *x, prioqueue_t p)                               \
-  {                                                                     \
-    size_t size = M_C(name, _array_size)(p->array)-1;                   \
-    M_C(name, _array_swap_at) (p->array, 0, size);                      \
-    M_C(name, _array_pop_back)(x, p->array);                            \
-                                                                        \
-    size_t i = 0;                                                       \
-    while (true) {                                                      \
-      size_t child = M_C(name, _i_lchild)(i);                           \
-      if (child >= size) break;                                         \
-      size_t otherChild = M_C(name, _i_rchild)(i);                      \
-      if (otherChild < size                                             \
-          && M_C(name, _i_cmp)(p, otherChild, child) < 0 ) {            \
-        child = otherChild;                                             \
-      }                                                                 \
-      if (M_C(name, _i_cmp)(p, i, child) <= 0) break;                   \
-      M_C(name, _array_swap_at) (p->array, i, child);                   \
-      i = child;                                                        \
-    }                                                                   \
-  }                                                                     \
-                                                                        \
-  static inline void                                                    \
-  M_C(name, _it)(it_t it, const prioqueue_t v)                          \
-  {                                                                     \
-    M_C(name, _array_it)(it, v->array);                                 \
-  }                                                                     \
-                                                                        \
-  static inline void                                                    \
-  M_C(name, _it_last)(it_t it, const prioqueue_t v)			\
-  {                                                                     \
-    M_C(name, _array_it_last)(it, v->array);                            \
-  }                                                                     \
-                                                                        \
-  static inline void                                                    \
-  M_C(name, _it_end)(it_t it, const prioqueue_t v)			\
-  {                                                                     \
-    M_C(name, _array_it_end)(it, v->array);                             \
-  }                                                                     \
-                                                                        \
-  static inline void                                                    \
-  M_C(name, _it_set)(it_t it, const it_t org)                           \
-  {                                                                     \
-    M_C(name, _array_it_set)(it, org);                                  \
-  }                                                                     \
-                                                                        \
-  static inline bool                                                    \
-  M_C(name, _end_p)(const it_t it)                                      \
-  {                                                                     \
-    return M_C(name, _array_end_p)(it);                                 \
-  }                                                                     \
-                                                                        \
-  static inline bool                                                    \
-  M_C(name, _last_p)(const it_t it)                                     \
-  {                                                                     \
-    return M_C(name, _array_last_p)(it);                                \
-  }                                                                     \
-                                                                        \
-  static inline bool                                                    \
-  M_C(name, _it_equal_p)(const it_t it1,				\
-			 const it_t it2)				\
-  {                                                                     \
-    return M_C(name, _array_it_equal_p)(it1, it2);                      \
-  }                                                                     \
-                                                                        \
-  static inline void                                                    \
-  M_C(name, _next)(it_t it)                                             \
-  {                                                                     \
-    M_C(name, _array_next)(it);                                         \
-  }                                                                     \
-                                                                        \
-  static inline void                                                    \
-  M_C(name, _previous)(it_t it)                                         \
-  {                                                                     \
-    M_C(name, _array_previous)(it);                                     \
-  }                                                                     \
-                                                                        \
-  static inline type const *                                            \
-  M_C(name, _cref)(const it_t it)					\
-  {                                                                     \
-    return M_C(name, _array_cref)(it);                                  \
-  }                                                                     \
-                                                                        \
-  M_IF_METHOD(EQUAL, oplist)                                            \
-  (                                                                     \
-   /* EQUAL & CMP may be uncorrelated */                                \
-   static inline bool                                                   \
-   M_C(name, _erase)(prioqueue_t p, type x)                             \
-   {                                                                    \
-     /* First pass: search for an item EQUAL to x */                    \
-     size_t size = M_C(name, _array_size)(p->array);                    \
-     size_t i = 0;                                                      \
-     for(i = 0; i < size; i++) {                                        \
-       if (M_CALL_EQUAL(oplist, *M_C(name, _array_cget)(p->array, i), x)) \
-         break;                                                         \
-     }                                                                  \
-     /* If x is not found, then stop */                                 \
-     if (i >= size)                                                     \
-       return false;                                                    \
-     /* Swap the found item and the last element */                     \
-     size--;                                                            \
-     M_C(name, _array_swap_at) (p->array, i, size);                     \
-     M_C(name, _array_pop_back)(NULL, p->array);                        \
+
+/* Deferred evaluation for the definition,
+   so that all arguments are evaluated before further expansion */
+#define PRIOQUEUEI_DEF_P1(arg)    PRIOQUEUEI_DEF_P2 arg
+
+/* Validate the oplist before going further */
+#define PRIOQUEUEI_DEF_P2(name, type, oplist, prioqueue_t, it_t)              \
+  M_IF_OPLIST(oplist)(PRIOQUEUEI_DEF_P3, PRIOQUEUEI_DEF_FAILURE)(name, type, oplist, prioqueue_t, it_t)
+
+/* Stop processing with a compilation failure */
+#define PRIOQUEUEI_DEF_FAILURE(name, type, oplist, prioqueue_t, it_t)         \
+  M_STATIC_FAILURE(M_LIB_NOT_AN_OPLIST, "(PRIOQUEUE_DEF): the given argument is not a valid oplist: " #oplist)
+
+/* Define the priority queue:
+   - name: prefix to use,
+   - type: type of the contained objects,
+   - oplist: oplist of the contained objects,
+   - prioqueue_t: type of the container,
+   - it_t: iterator of the container
+*/
+#define PRIOQUEUEI_DEF_P3(name, type, oplist, prioqueue_t, it_t)              \
+                                                                              \
+  /* Definition of the internal array used to construct the priority queue */ \
+  ARRAY_DEF(M_C(name, _array), type, oplist)                                  \
+                                                                              \
+  /* Define the priority queue over the defined array */                      \
+  typedef struct M_C(name, _s) {                                              \
+    M_C(name, _array_t) array;                                                \
+  } prioqueue_t[1];                                                           \
+  /* Define the pointer references to the priority queue */                   \
+  typedef struct M_C(name, _s) *M_C(name, _ptr);                              \
+  typedef const struct M_C(name, _s) *M_C(name, _srcptr);                     \
+                                                                              \
+  /* The iterator is the same one as the one of the internal array */         \
+  typedef M_C(name, _array_it_t) it_t;                                        \
+                                                                              \
+  /* Definition of the internal types used by the oplist */                   \
+  typedef prioqueue_t M_C(name, _ct);                                         \
+  typedef type        M_C(name, _subtype_ct);                                 \
+  typedef it_t        M_C(name, _it_ct);                                      \
+                                                                              \
+  M_CHECK_COMPATIBLE_OPLIST(name, 1, type, oplist)                            \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _init)(prioqueue_t p)                                             \
+  {                                                                           \
+    M_C(name, _array_init)(p->array);                                         \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _init_set)(prioqueue_t p, prioqueue_t const o)                    \
+  {                                                                           \
+    M_C(name, _array_init_set)(p->array, o->array);                           \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _set)(prioqueue_t p, prioqueue_t const o)                         \
+  {                                                                           \
+    M_C(name, _array_set)(p->array, o->array);                                \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _clear)(prioqueue_t p)                                            \
+  {                                                                           \
+    M_C(name, _array_clear)(p->array);                                        \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _init_move)(prioqueue_t p, prioqueue_t o)                         \
+  {                                                                           \
+    M_C(name, _array_init_move)(p->array, o->array);                          \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _move)(prioqueue_t p, prioqueue_t o)                              \
+  {                                                                           \
+    M_C(name, _array_move)(p->array, o->array);                               \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _swap)(prioqueue_t p, prioqueue_t o)                              \
+  {                                                                           \
+    M_C(name, _array_swap)(p->array, o->array);                               \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _clean)(prioqueue_t p)                                            \
+  {                                                                           \
+    M_C(name, _array_clean)(p->array);                                        \
+  }                                                                           \
+                                                                              \
+  static inline size_t                                                        \
+  M_C(name, _i_parent)(size_t i)                                              \
+  {                                                                           \
+    M_ASSERT (i > 0);                                                         \
+    return (i - 1) / 2;                                                       \
+  }                                                                           \
+                                                                              \
+  static inline size_t                                                        \
+  M_C(name, _i_lchild)(size_t i)                                              \
+  {                                                                           \
+    M_ASSERT(i <= ((SIZE_MAX)-2)/2);                                          \
+    return 2*i + 1;                                                           \
+  }                                                                           \
+                                                                              \
+  static inline size_t                                                        \
+  M_C(name, _i_rchild)(size_t i)                                              \
+  {                                                                           \
+    M_ASSERT(i <= ((SIZE_MAX)-2)/2);                                          \
+    return 2*i + 2;                                                           \
+  }                                                                           \
+                                                                              \
+  static inline int                                                           \
+  M_C(name, _i_cmp)(const prioqueue_t p, size_t i, size_t j)                  \
+  {                                                                           \
+    return M_CALL_CMP(oplist, *M_C(name, _array_cget)(p->array, i),           \
+                      *M_C(name, _array_cget)(p->array, j));                  \
+  }                                                                           \
+                                                                              \
+  static inline bool                                                          \
+  M_C(name, _empty_p)(prioqueue_t const p)                                    \
+  {                                                                           \
+    return M_C(name, _array_empty_p)(p->array);                               \
+  }                                                                           \
+                                                                              \
+  static inline size_t                                                        \
+  M_C(name, _size)(prioqueue_t const p)                                       \
+  {                                                                           \
+    return M_C(name, _array_size)(p->array);                                  \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _push)(prioqueue_t p, type const x)                               \
+  {                                                                           \
+    /* Push back the new element at the end of the array */                   \
+    M_C(name, _array_push_back)(p->array, x);                                 \
+                                                                              \
+    /* Reorder the array by swapping with its parent                          \
+     * until it reaches the right position */                                 \
+    size_t i = M_C(name, _array_size)(p->array)-1;                            \
+    while (i > 0) {                                                           \
+      size_t j = M_C(name, _i_parent)(i);                                     \
+      if (M_C(name, _i_cmp)(p, j, i) <= 0)                                    \
+        break;                                                                \
+      M_C(name, _array_swap_at) (p->array, i, j);                             \
+      i = j;                                                                  \
+    }                                                                         \
+  }                                                                           \
+                                                                              \
+  static inline type const *                                                  \
+  M_C(name, _front)(prioqueue_t const p)                                      \
+  {                                                                           \
+    return M_C(name, _array_cget)(p->array, 0);                               \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _pop)(type *x, prioqueue_t p)                                     \
+  {                                                                           \
+    /* Swap the front element with the last element */                        \
+    size_t size = M_C(name, _array_size)(p->array)-1;                         \
+    M_C(name, _array_swap_at) (p->array, 0, size);                            \
+    /* Swap the new last element  */                                          \
+    M_C(name, _array_pop_back)(x, p->array);                                  \
+                                                                              \
+    /* Reorder the heap */                                                    \
+    size_t i = 0;                                                             \
+    while (true) {                                                            \
+      size_t child = M_C(name, _i_lchild)(i);                                 \
+      if (child >= size)                                                      \
+        break;                                                                \
+      size_t otherChild = M_C(name, _i_rchild)(i);                            \
+      if (otherChild < size                                                   \
+          && M_C(name, _i_cmp)(p, otherChild, child) < 0 ) {                  \
+        child = otherChild;                                                   \
+      }                                                                       \
+      if (M_C(name, _i_cmp)(p, i, child) <= 0)                                \
+        break;                                                                \
+      M_C(name, _array_swap_at) (p->array, i, child);                         \
+      i = child;                                                              \
+    }                                                                         \
+  }                                                                           \
+                                                                              \
+  /* Define iterators over the array iterator */                              \
+  static inline void                                                          \
+  M_C(name, _it)(it_t it, prioqueue_t const v)                                \
+  {                                                                           \
+    M_C(name, _array_it)(it, v->array);                                       \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _it_last)(it_t it, prioqueue_t const v)                           \
+  {                                                                           \
+    M_C(name, _array_it_last)(it, v->array);                                  \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _it_end)(it_t it, prioqueue_t const v)                            \
+  {                                                                           \
+    M_C(name, _array_it_end)(it, v->array);                                   \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _it_set)(it_t it, const it_t org)                                 \
+  {                                                                           \
+    M_C(name, _array_it_set)(it, org);                                        \
+  }                                                                           \
+                                                                              \
+  static inline bool                                                          \
+  M_C(name, _end_p)(const it_t it)                                            \
+  {                                                                           \
+    return M_C(name, _array_end_p)(it);                                       \
+  }                                                                           \
+                                                                              \
+  static inline bool                                                          \
+  M_C(name, _last_p)(const it_t it)                                           \
+  {                                                                           \
+    return M_C(name, _array_last_p)(it);                                      \
+  }                                                                           \
+                                                                              \
+  static inline bool                                                          \
+  M_C(name, _it_equal_p)(const it_t it1,                                      \
+                         const it_t it2)                                      \
+  {                                                                           \
+    return M_C(name, _array_it_equal_p)(it1, it2);                            \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _next)(it_t it)                                                   \
+  {                                                                           \
+    M_C(name, _array_next)(it);                                               \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _previous)(it_t it)                                               \
+  {                                                                           \
+    M_C(name, _array_previous)(it);                                           \
+  }                                                                           \
+                                                                              \
+  static inline type const *                                                  \
+  M_C(name, _cref)(const it_t it)                                             \
+  {                                                                           \
+    return M_C(name, _array_cref)(it);                                        \
+  }                                                                           \
+                                                                              \
+  M_IF_METHOD(EQUAL, oplist)                                                  \
+  (                                                                           \
+    /* EQUAL & CMP may be uncorrelated */                                     \
+    static inline bool                                                        \
+    M_C(name, _equal_p)(prioqueue_t const p, prioqueue_t const q)             \
+    {                                                                         \
+      return M_C(name, _array_equal_p)(p->array, q->array);                   \
+    }                                                                         \
+                                                                              \
+   static inline bool                                                         \
+   M_C(name, _erase)(prioqueue_t p, type x)                                   \
+   {                                                                          \
+     /* First pass: search for an item EQUAL to x */                          \
+     /* NOTE: An HASHMAP may be a good idea to optimize this pass. */         \
+     size_t size = M_C(name, _array_size)(p->array);                          \
+     size_t i = 0;                                                            \
+     for(i = 0; i < size; i++) {                                              \
+       if (M_CALL_EQUAL(oplist, *M_C(name, _array_cget)(p->array, i), x))     \
+         break;                                                               \
+     }                                                                        \
+     /* If x is not found, then stop */                                       \
+     if (i >= size)                                                           \
+       return false;                                                          \
+     /* Swap the found item and the last element */                           \
+     size--;                                                                  \
+     M_C(name, _array_swap_at) (p->array, i, size);                           \
+     M_C(name, _array_pop_back)(NULL, p->array);                              \
      /* Move back the last swapped element to its right position in the heap */ \
-     while (true) {                                                     \
-       size_t child = M_C(name, _i_lchild)(i);                          \
-       if (child >= size) break;                                        \
-       size_t otherChild = M_C(name, _i_rchild)(i);                     \
-       if (otherChild < size                                            \
-           && M_C(name, _i_cmp)(p, otherChild, child) < 0 ) {           \
-         child = otherChild;                                            \
-       }                                                                \
-       if (M_C(name, _i_cmp)(p, i, child) <= 0) break;                  \
-       M_C(name, _array_swap_at) (p->array, i, child);                  \
-       i = child;                                                       \
-     }                                                                  \
-     return true;                                                       \
-   }                                                                    \
-                                                                        \
-   static inline void                                                   \
-   M_C(name, _update_further)(prioqueue_t p, type xold, type xnew)      \
-   {                                                                    \
-     /* This update assumes that the new position is further in the heap */ \
-     assert (M_CALL_CMP(oplist, xold, xnew) > 0);                       \
-     /* First pass: search for an item EQUAL to x */                    \
-     size_t size = M_C(name, _array_size)(p->array);                    \
-     size_t i = 0;                                                      \
-     for(i = 0; i < size; i++) {                                        \
-       if (M_CALL_EQUAL(oplist, *M_C(name, _array_cget)(p->array, i), xold)) \
-         break;                                                         \
-     }                                                                  \
-     /* We shall have found the item */                                 \
-     assert (i < size);                                                 \
-     /* Set the found item to the new element */                        \
-     M_C(name, _array_set_at) (p->array, i, xnew);                      \
-     /* Move back the updated element to its right position in the heap */ \
-     while (true) {                                                     \
-       size_t child = M_C(name, _i_lchild)(i);                          \
-       if (child >= size) break;                                        \
-       size_t otherChild = M_C(name, _i_rchild)(i);                     \
-       if (otherChild < size                                            \
-           && M_C(name, _i_cmp)(p, otherChild, child) < 0 ) {           \
-         child = otherChild;                                            \
-       }                                                                \
-       if (M_C(name, _i_cmp)(p, i, child) <= 0) break;                  \
-       M_C(name, _array_swap_at) (p->array, i, child);                  \
-       i = child;                                                       \
-     }                                                                  \
-   }                                                                    \
-                                                                        \
-   , /* No EQUAL */ \)                                                  \
-   
+     while (true) {                                                           \
+       size_t child = M_C(name, _i_lchild)(i);                                \
+       if (child >= size) break;                                              \
+       size_t otherChild = M_C(name, _i_rchild)(i);                           \
+       if (otherChild < size                                                  \
+           && M_C(name, _i_cmp)(p, otherChild, child) < 0 ) {                 \
+         child = otherChild;                                                  \
+       }                                                                      \
+       if (M_C(name, _i_cmp)(p, i, child) <= 0) break;                        \
+       M_C(name, _array_swap_at) (p->array, i, child);                        \
+       i = child;                                                             \
+     }                                                                        \
+     return true;                                                             \
+   }                                                                          \
+                                                                              \
+   static inline void                                                         \
+   M_C(name, _update)(prioqueue_t p, type const xold, type const xnew)        \
+   {                                                                          \
+     /* NOTE: xold can be the same pointer than xnew */                       \
+     /* First pass: search for an item EQUAL to x */                          \
+     size_t size = M_C(name, _array_size)(p->array);                          \
+     size_t i = 0;                                                            \
+     for(i = 0; i < size; i++) {                                              \
+       if (M_CALL_EQUAL(oplist, *M_C(name, _array_cget)(p->array, i), xold))  \
+         break;                                                               \
+     }                                                                        \
+     /* We shall have found the item */                                       \
+     M_ASSERT (i < size);                                                     \
+     /* Test if the position of the old data is further or nearer than the new */ \
+     int cmp = M_CALL_CMP(oplist, *M_C(name, _array_cget)(p->array, i), xnew); \
+     /* Set the found item to the new element */                              \
+     M_C(name, _array_set_at) (p->array, i, xnew);                            \
+     if (cmp < 0) {                                                           \
+      /* Move back the updated element to its new position, further in the heap */ \
+      while (true) {                                                          \
+        size_t child = M_C(name, _i_lchild)(i);                               \
+        if (child >= size) break;                                             \
+        size_t otherChild = M_C(name, _i_rchild)(i);                          \
+        if (otherChild < size                                                 \
+            && M_C(name, _i_cmp)(p, otherChild, child) < 0 ) {                \
+          child = otherChild;                                                 \
+        }                                                                     \
+        if (M_C(name, _i_cmp)(p, i, child) <= 0) break;                       \
+        M_C(name, _array_swap_at) (p->array, i, child);                       \
+        i = child;                                                            \
+      }                                                                       \
+     } else {                                                                 \
+      /* Move back the updated element to its new position, nearest in the heap */ \
+      while (i > 0) {                                                         \
+        size_t parent = M_C(name, _i_parent)(i);                              \
+        if (M_C(name, _i_cmp)(p, parent, i) <= 0) break;                      \
+        M_C(name, _array_swap_at) (p->array, i, parent);                      \
+        i = parent;                                                           \
+      }                                                                       \
+     }                                                                        \
+   }                                                                          \
+   , /* No EQUAL */ )                                                         \
+
 
 // TODO: set all & remove all function
 

m-serial-bin.h

@@ -0,0 +1,593 @@
+/*
+ * M*LIB - Serial BIN
+ *
+ * Copyright (c) 2017-2021, Patrick Pelissier
+ * All rights reserved.
+ * 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 REGENTS 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 REGENTS AND 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.
+*/
+#ifndef MSTARLIB_SERIAL_BIN_H
+#define MSTARLIB_SERIAL_BIN_H
+
+#include <stdint.h>
+
+#include "m-core.h"
+#include "m-string.h"
+
+M_BEGIN_PROTECTED_CODE
+
+/* Internal service:
+ * Write size_t in the stream in a compact form to reduce consumption
+ * (and I/O bandwidth)
+ */
+static inline bool
+m_serial_bin_write_size(FILE *f, const size_t size)
+{
+  bool b;
+  if (M_LIKELY(size < 253))
+  {
+    b = EOF != fputc((unsigned char) size, f);
+  } else if (size < 1ULL << 16) {
+    b = EOF != fputc(253, f);    // Save 16 bits encoding
+    b &= EOF != fputc((unsigned char) (size >> 8), f);
+    b &= EOF != fputc((unsigned char) size, f);
+  } 
+// For 32 bits systems, don't encode a 64 bits size_t
+ #if SIZE_MAX < 1ULL<< 32
+  else {
+    b = EOF != fputc(254, f);    // Save 32 bits encoding
+    b &= EOF != fputc((unsigned char) (size >> 24), f);
+    b &= EOF != fputc((unsigned char) (size >> 16), f);
+    b &= EOF != fputc((unsigned char) (size >> 8), f);
+    b &= EOF != fputc((unsigned char) size, f);
+  }
+ #else 
+  else if (size < 1ULL<< 32) {
+    b = EOF != fputc(254, f);    // Save 32 bits encoding
+    b &= EOF != fputc((unsigned char) (size >> 24), f);
+    b &= EOF != fputc((unsigned char) (size >> 16), f);
+    b &= EOF != fputc((unsigned char) (size >> 8), f);
+    b &= EOF != fputc((unsigned char) size, f);
+  } else {
+    b = EOF != fputc(255, f);    // Save 64 bits encoding
+    b &= EOF != fputc((unsigned char) (size >> 56), f);
+    b &= EOF != fputc((unsigned char) (size >> 48), f);
+    b &= EOF != fputc((unsigned char) (size >> 40), f);
+    b &= EOF != fputc((unsigned char) (size >> 32), f);
+    b &= EOF != fputc((unsigned char) (size >> 24), f);
+    b &= EOF != fputc((unsigned char) (size >> 16), f);
+    b &= EOF != fputc((unsigned char) (size >> 8), f);
+    b &= EOF != fputc((unsigned char) size, f);
+  }
+#endif
+  return b;
+}
+
+/* Internal service:
+ * Read size_t in the stream from a compact form to reduce consumption
+ * (and I/O bandwidth)
+ */
+static inline bool
+m_serial_bin_read_size(FILE *f, size_t *size)
+{
+  int c;
+  c = fgetc(f);
+  if (M_UNLIKELY(c == EOF)) return false;
+  if (M_LIKELY(c < 253)) {
+    *size = (size_t) c;
+    return true;
+  }
+  size_t s = 0;
+  int l = (c = 255) ? 8 : (c == 254) ? 4 : 2;
+  for(int i = 0; i < l; i++) {
+      c = fgetc(f);
+      if (M_UNLIKELY(c == EOF)) return false;
+      s = (s << 8) | (size_t) c;
+  }
+  *size = s;
+  return true;
+}
+
+/* Write the boolean 'data' into the serial stream 'serial'.
+   Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline m_serial_return_code_t
+m_serial_bin_write_boolean(m_serial_write_t serial, const bool data)
+{
+  FILE *f = (FILE *)serial->data[0].p;
+  size_t n = fwrite (M_ASSIGN_CAST(const void*, &data), sizeof (bool), 1, f);
+  return n == 1 ? M_SERIAL_OK_DONE : m_core_serial_fail();
+}
+
+/* Write the integer 'data' of 'size_of_type' bytes into the serial stream 'serial'.
+   Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline m_serial_return_code_t
+m_serial_bin_write_integer(m_serial_write_t serial,const long long data, const size_t size_of_type)
+{
+  int8_t   i8;
+  int16_t i16;
+  int32_t i32;
+  int64_t i64;
+  size_t n;
+  
+  FILE *f = (FILE *)serial->data[0].p;
+  switch (size_of_type) {
+  case 1:
+    i8 = (int8_t) data;
+    n = fwrite (M_ASSIGN_CAST(const void*, &i8), sizeof i8, 1, f);
+    break;
+  case 2:
+    i16 = (int16_t) data;
+    n = fwrite (M_ASSIGN_CAST(const void*, &i16), sizeof i16, 1, f);
+    break;
+  case 4:
+    i32 = (int32_t) data;
+    n = fwrite (M_ASSIGN_CAST(const void*, &i32), sizeof i32, 1, f);
+    break;
+  case 8:
+    i64 = (int64_t) data;
+    n = fwrite (M_ASSIGN_CAST(const void*, &i64), sizeof i64, 1, f);
+    break;
+  default:
+    M_ASSERT_INIT(false, "an integer of suitable size (8/16/32/64)");
+    break;
+  }
+  return n == 1 ? M_SERIAL_OK_DONE : m_core_serial_fail();
+}
+
+/* Write the float 'data' of 'size_of_type' bytes into the serial stream 'serial'.
+   Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline m_serial_return_code_t
+m_serial_bin_write_float(m_serial_write_t serial, const long double data, const size_t size_of_type)
+{
+  float   f1;
+  double  f2;
+  long double f3;
+  size_t n;
+  
+  FILE *f = (FILE *)serial->data[0].p;
+  if (size_of_type == sizeof f1) {
+    f1 = (float) data;
+    n = fwrite (M_ASSIGN_CAST(const void*, &f1), sizeof f1, 1, f);
+  } else if (size_of_type == sizeof f2) {
+    f2 = (double) data;
+    n = fwrite (M_ASSIGN_CAST(const void*, &f2), sizeof f2, 1, f);
+  } else if (size_of_type == sizeof f3) {
+    f3 = (long double) data;
+    n = fwrite (M_ASSIGN_CAST(const void*, &f3), sizeof f3, 1, f);
+  } else {
+    M_ASSERT_INIT(false, "a float of suitable size");
+  }
+  return n == 1 ? M_SERIAL_OK_DONE : m_core_serial_fail();
+}
+
+/* Write the null-terminated string 'data'into the serial stream 'serial'.
+   Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline m_serial_return_code_t
+m_serial_bin_write_string(m_serial_write_t serial, const char data[], size_t length)
+{
+  M_ASSERT_SLOW(length == strlen(data) );
+  FILE *f = (FILE *)serial->data[0].p;
+  M_ASSERT(f != NULL && data != NULL);
+  // Write first the number of (non null) characters
+  if (m_serial_bin_write_size(f, length) != true) return m_core_serial_fail();
+  // Write the characters (excluding the final null char)
+  // NOTE: fwrite supports length == 0.
+  size_t n = fwrite (M_ASSIGN_CAST(const void*, data), 1, length, f);
+  return (n == length) ? M_SERIAL_OK_DONE : m_core_serial_fail();
+}
+
+/* Start writing an array of 'number_of_elements' objects into the serial stream 'serial'.
+   If 'number_of_elements' is 0, then either the array has no data,
+   or the number of elements of the array is unkown.
+   Initialize 'local' so that it can be used to serialize the array 
+   (local is an unique serialization object of the array).
+   Return M_SERIAL_OK_CONTINUE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline m_serial_return_code_t
+m_serial_bin_write_array_start(m_serial_local_t local, m_serial_write_t serial, const size_t number_of_elements)
+{
+  FILE *f = (FILE *)serial->data[0].p;
+  size_t n = fwrite (M_ASSIGN_CAST(const void*, &number_of_elements), sizeof number_of_elements, 1, f);
+  local->data[0].b = (number_of_elements == 0);
+  return n == 1 ? M_SERIAL_OK_CONTINUE : m_core_serial_fail();
+}
+
+/* Write an array separator between elements of an array into the serial stream 'serial' if needed.
+   Return M_SERIAL_OK_CONTINUE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_bin_write_array_next(m_serial_local_t local, m_serial_write_t serial)
+{
+  FILE *f = (FILE *)serial->data[0].p;
+  // Need separator if we don't know the real size 
+  if (local->data[0].b) {
+    size_t n = 0xABCDEF;
+    n = fwrite (M_ASSIGN_CAST(const void*, &n), sizeof n, 1, f);
+    return n == 1 ? M_SERIAL_OK_CONTINUE : m_core_serial_fail();    
+  } else {
+    return M_SERIAL_OK_CONTINUE;
+  }
+}
+
+/* End the writing of an array into the serial stream 'serial'.
+   Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline   m_serial_return_code_t
+m_serial_bin_write_array_end(m_serial_local_t local, m_serial_write_t serial)
+{
+  FILE *f = (FILE *)serial->data[0].p;
+  // Need mark if we don't know the real size 
+  if (local->data[0].b) {
+    size_t n = 0x12345678;
+    n = fwrite (M_ASSIGN_CAST(const void*, &n), sizeof n, 1, f);
+    return n == 1 ? M_SERIAL_OK_CONTINUE : m_core_serial_fail();    
+  } else {
+    return M_SERIAL_OK_CONTINUE;
+  }
+}
+
+/* Write a value separator between element of the same pair of a map into the serial stream 'serial' if needed.
+   Return M_SERIAL_OK_CONTINUE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline   m_serial_return_code_t
+m_serial_bin_write_map_value(m_serial_local_t local, m_serial_write_t serial)
+{
+  (void) local; // argument not used
+  (void) serial;
+  return M_SERIAL_OK_CONTINUE;
+}
+
+/* Start writing a tuple into the serial stream 'serial'.
+   Initialize 'local' so that it can serial the tuple 
+   (local is an unique serialization object of the tuple).
+   Return M_SERIAL_OK_CONTINUE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline   m_serial_return_code_t
+m_serial_bin_write_tuple_start(m_serial_local_t local, m_serial_write_t serial)
+{
+  (void) local; // argument not used
+  (void) serial;
+  return M_SERIAL_OK_CONTINUE;
+}
+
+/* Start writing the field named field_name[index] of a tuple into the serial stream 'serial'.
+   Return M_SERIAL_OK_CONTINUE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline   m_serial_return_code_t
+m_serial_bin_write_tuple_id(m_serial_local_t local, m_serial_write_t serial, const char *const field_name[], const int max, const int index)
+{
+  (void) local; // argument not used
+  (void) serial;
+  (void) field_name;
+  (void) max;
+  (void) index; // Assume index are write in order from 0 to max.
+  return M_SERIAL_OK_CONTINUE;
+}
+
+/* End the write of a tuple into the serial stream 'serial'.
+   Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline   m_serial_return_code_t
+m_serial_bin_write_tuple_end(m_serial_local_t local, m_serial_write_t serial)
+{
+  (void) local; // argument not used
+  (void) serial;
+  return M_SERIAL_OK_DONE;
+}
+
+/* Start writing a variant into the serial stream 'serial'.
+   If index <= 0, the variant is empty.
+     Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise 
+   Otherwise, the field 'field_name[index]' will be filled.
+     Return M_SERIAL_OK_CONTINUE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline   m_serial_return_code_t
+m_serial_bin_write_variant_start(m_serial_local_t local, m_serial_write_t serial, const char *const field_name[], const int max, const int index)
+{
+  (void) field_name;
+  (void) max;
+  (void) local;
+  FILE *f = (FILE *)serial->data[0].p;
+  size_t n = fwrite (M_ASSIGN_CAST(const void*, &index), sizeof index, 1, f);
+  return n == 1 ? ((index < 0) ? M_SERIAL_OK_DONE : M_SERIAL_OK_CONTINUE) : m_core_serial_fail();
+}
+
+/* End Writing a variant into the serial stream 'serial'. 
+   Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline   m_serial_return_code_t
+m_serial_bin_write_variant_end(m_serial_local_t local, m_serial_write_t serial)
+{
+  (void) local; // argument not used
+  (void) serial;
+  return M_SERIAL_OK_DONE;
+}
+
+/* The exported interface. */
+static const m_serial_write_interface_t m_serial_write_bin_interface = {
+  m_serial_bin_write_boolean,
+  m_serial_bin_write_integer,
+  m_serial_bin_write_float,
+  m_serial_bin_write_string, 
+  m_serial_bin_write_array_start,
+  m_serial_bin_write_array_next,
+  m_serial_bin_write_array_end,
+  m_serial_bin_write_array_start,
+  m_serial_bin_write_map_value,
+  m_serial_bin_write_array_next,
+  m_serial_bin_write_array_end,
+  m_serial_bin_write_tuple_start,
+  m_serial_bin_write_tuple_id,
+  m_serial_bin_write_tuple_end,
+  m_serial_bin_write_variant_start,
+  m_serial_bin_write_variant_end
+};
+
+static inline void m_serial_bin_write_init(m_serial_write_t serial, FILE *f)
+{
+  serial->m_interface = &m_serial_write_bin_interface;
+  serial->data[0].p = M_ASSIGN_CAST(void*, f);
+}
+
+static inline void m_serial_bin_write_clear(m_serial_write_t serial)
+{
+  (void) serial; // Nothing to do
+}
+
+
+/* Define a synonym of m_serial_read_t to the BIN serializer with its proper OPLIST */
+typedef m_serial_write_t m_serial_bin_write_t;
+#define M_OPL_m_serial_bin_write_t()                                          \
+  (INIT_WITH(m_serial_bin_write_init), CLEAR(m_serial_bin_write_clear), TYPE(m_serial_bin_write_t) )
+
+
+/* Read from the stream 'serial' a boolean.
+   Set '*b' with the boolean value if succeeds 
+   Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_bin_read_boolean(m_serial_read_t serial, bool *b){
+  FILE *f = (FILE*) serial->data[0].p;
+  size_t n = fread (M_ASSIGN_CAST(void*, b), sizeof (bool), 1, f);
+  return n == 1 ? M_SERIAL_OK_DONE : m_core_serial_fail();
+}
+
+/* Read from the stream 'serial' an integer that can be represented with 'size_of_type' bytes.
+   Set '*i' with the integer value if succeeds 
+   Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_bin_read_integer(m_serial_read_t serial, long long *i, const size_t size_of_type){
+  int8_t   i8;
+  int16_t i16;
+  int32_t i32;
+  int64_t i64;
+  size_t n;
+  FILE *f = (FILE *)serial->data[0].p;
+  switch (size_of_type) {
+  case 1:
+    n = fread (M_ASSIGN_CAST(void*, &i8), sizeof i8, 1, f);
+    *i = i8;
+    break;
+  case 2:
+    n = fread (M_ASSIGN_CAST(void*, &i16), sizeof i16, 1, f);
+    *i = i16;
+    break;
+  case 4:
+    n = fread (M_ASSIGN_CAST(void*, &i32), sizeof i32, 1, f);
+    *i = i32;
+    break;
+  case 8:
+    n = fread (M_ASSIGN_CAST(void*, &i64), sizeof i64, 1, f);
+    *i = i64;
+    break;
+  default:
+    M_ASSERT_INIT(false, "an integer of suitable size");
+    break;
+  }
+  return n == 1 ? M_SERIAL_OK_DONE : m_core_serial_fail();
+}
+
+/* Read from the stream 'serial' a float that can be represented with 'size_of_type' bytes.
+   Set '*r' with the boolean value if succeeds 
+   Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_bin_read_float(m_serial_read_t serial, long double *r, const size_t size_of_type){
+  float   f1;
+  double  f2;
+  long double f3;
+  size_t n;
+  FILE *f = (FILE *)serial->data[0].p;
+  if (size_of_type == sizeof f1) {
+    n = fread (M_ASSIGN_CAST(void*, &f1), sizeof f1, 1, f);
+    *r = f1;
+  } else if (size_of_type == sizeof f2) {
+    n = fread (M_ASSIGN_CAST(void*, &f2), sizeof f2, 1, f);
+    *r = f2;
+  } else if (size_of_type == sizeof f3) {
+    n = fread (M_ASSIGN_CAST(void*, &f3), sizeof f3, 1, f);
+    *r = f3;
+  } else {
+    M_ASSERT_INIT(false, "a float of suitable size");
+  }
+  return n == 1 ? M_SERIAL_OK_DONE : m_core_serial_fail();
+}
+
+/* Read from the stream 'serial' a string.
+   Set 's' with the string if succeeds 
+   Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_bin_read_string(m_serial_read_t serial, struct string_s *s){
+  FILE *f = (FILE*) serial->data[0].p;
+  M_ASSERT(f != NULL && s != NULL);
+  // First read the number of non null characters
+  size_t length;
+  if (m_serial_bin_read_size(f, &length) != true) return m_core_serial_fail();
+  // Use of internal string interface to dimension the string
+  char *p = stringi_fit2size(s, length + 1);
+  stringi_set_size(s, length);
+  // Read the characters excluding the final null one.
+  // NOTE: fread supports length == 0.
+  size_t n = fread(M_ASSIGN_CAST(void*, p), 1, length, f);
+  // Force the final null character
+  p[length] = 0;
+  return (n == length) ? M_SERIAL_OK_DONE : m_core_serial_fail();
+}
+
+/* Start reading from the stream 'serial' an array.
+   Set '*num' with the number of elements, or 0 if it is not known.
+   Initialize 'local' so that it can be used to serialize the array 
+   (local is an unique serialization object of the array).
+   Return M_SERIAL_OK_CONTINUE if it succeeds and the array continue,
+   M_SERIAL_OK_DONE if it succeeds and the array ends (the array is empty),
+   M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_bin_read_array_start(m_serial_local_t local, m_serial_read_t serial, size_t *num)
+{
+  FILE *f = (FILE*) serial->data[0].p;
+  size_t n = fread (M_ASSIGN_CAST(void*, num), sizeof *num, 1, f);
+  if (n != 1)
+    return m_core_serial_fail();
+  local->data[0].b = (*num == 0);
+  local->data[1].s = *num;
+  if (local->data[0].b) {
+    // Size not know ==> use of marker in the stream.
+    size_t p;
+    n = fread (M_ASSIGN_CAST(void*, &p), sizeof p, 1, f);
+    if (n != 1)
+      return m_core_serial_fail();
+    return p == 0xABCDEF ? M_SERIAL_OK_CONTINUE : p == 0x12345678 ? M_SERIAL_OK_DONE : m_core_serial_fail();
+  }
+  return M_SERIAL_OK_CONTINUE;
+}
+
+/* Continue reading from the stream 'serial' an array.
+   Return M_SERIAL_OK_CONTINUE if it succeeds and the array continue,
+   M_SERIAL_OK_DONE if it succeeds and the array ends,
+   M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_bin_read_array_next(m_serial_local_t local, m_serial_read_t serial)
+{
+  FILE *f = (FILE*) serial->data[0].p;
+  if (local->data[0].b) {
+    // Size not know ==> use of marker in the stream.
+    size_t p, n;
+    n = fread (M_ASSIGN_CAST(void*, &p), sizeof p, 1, f);
+    if (n != 1)
+      return m_core_serial_fail();
+    return p == 0xABCDEF ? M_SERIAL_OK_CONTINUE : p == 0x12345678 ? M_SERIAL_OK_DONE : m_core_serial_fail();
+  } else {
+    M_ASSERT(local->data[1].s > 0);
+    local->data[1].s --;
+    return local->data[1].s == 0 ? M_SERIAL_OK_DONE : M_SERIAL_OK_CONTINUE;
+  }
+}
+
+
+/* Continue reading from the stream 'serial' the value separator
+   Return M_SERIAL_OK_CONTINUE if it succeeds and the map continue,
+   M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_bin_read_map_value(m_serial_local_t local, m_serial_read_t serial)
+{
+  (void) local; // argument not used
+  (void) serial;
+  return M_SERIAL_OK_CONTINUE;
+}
+
+/* Start reading a tuple from the stream 'serial'.
+   Return M_SERIAL_OK_CONTINUE if it succeeds and the tuple continues,
+   M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_bin_read_tuple_start(m_serial_local_t local, m_serial_read_t serial)
+{
+  (void) serial;
+  local->data[1].i = 0;
+  return M_SERIAL_OK_CONTINUE;
+}
+
+/* Continue reading a tuple from the stream 'serial'.
+   Set '*id' with the corresponding index of the table 'field_name[max]'
+   associated to the parsed field in the stream.
+   Return M_SERIAL_OK_CONTINUE if it succeeds and the tuple continues,
+   Return M_SERIAL_OK_DONE if it succeeds and the tuple ends,
+   M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_bin_read_tuple_id(m_serial_local_t local, m_serial_read_t serial, const char *const field_name [], const int max, int *id)
+{
+  (void) serial;
+  (void) field_name;
+  (void) max;
+  *id = local->data[1].i;
+  local->data[1].i ++;
+  return (*id == max) ? M_SERIAL_OK_DONE : M_SERIAL_OK_CONTINUE;
+}
+
+/* Start reading a variant from the stream 'serial'.
+   Set '*id' with the corresponding index of the table 'field_name[max]'
+   associated to the parsed field in the stream.
+   Return M_SERIAL_OK_CONTINUE if it succeeds and the variant continues,
+   Return M_SERIAL_OK_DONE if it succeeds and the variant ends(variant is empty),
+   M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_bin_read_variant_start(m_serial_local_t local, m_serial_read_t serial, const char *const field_name[], const int max, int*id)
+{
+  (void) field_name;
+  (void) max;
+  (void) local; // argument not used
+  FILE *f = (FILE*) serial->data[0].p;
+  size_t n = fread (M_ASSIGN_CAST(void*, id), sizeof *id, 1, f);
+  return n == 1 ? ((*id < 0) ? M_SERIAL_OK_DONE : M_SERIAL_OK_CONTINUE) : m_core_serial_fail();
+}
+
+/* End reading a variant from the stream 'serial'.
+   Return M_SERIAL_OK_DONE if it succeeds and the variant ends,
+   M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_bin_read_variant_end(m_serial_local_t local, m_serial_read_t serial)
+{
+  (void) local; // argument not used
+  (void) serial;
+  return M_SERIAL_OK_DONE;
+}
+
+static const m_serial_read_interface_t m_serial_bin_read_interface = {
+  m_serial_bin_read_boolean,
+  m_serial_bin_read_integer,
+  m_serial_bin_read_float,
+  m_serial_bin_read_string,
+  m_serial_bin_read_array_start,
+  m_serial_bin_read_array_next,
+  m_serial_bin_read_array_start,
+  m_serial_bin_read_map_value,
+  m_serial_bin_read_array_next,
+  m_serial_bin_read_tuple_start,
+  m_serial_bin_read_tuple_id,
+  m_serial_bin_read_variant_start,
+  m_serial_bin_read_variant_end
+};
+
+static inline void m_serial_bin_read_init(m_serial_read_t serial, FILE *f)
+{
+  serial->m_interface = &m_serial_bin_read_interface;
+  serial->data[0].p = M_ASSIGN_CAST(void*, f);
+}
+
+static inline void m_serial_bin_read_clear(m_serial_read_t serial)
+{
+  (void) serial; // Nothing to do
+}
+
+/* Define a synonym of m_serial_read_t to the BIN serializer with its proper OPLIST */
+typedef m_serial_read_t m_serial_bin_read_t;
+#define M_OPL_m_serial_bin_read_t()                                           \
+  (INIT_WITH(m_serial_bin_read_init), CLEAR(m_serial_bin_read_clear), TYPE(m_serial_bin_read_t) )
+
+M_END_PROTECTED_CODE
+
+#endif

m-serial-json.h

@@ -0,0 +1,580 @@
+/*
+ * M*LIB - Serial JSON
+ *
+ * Copyright (c) 2017-2021, Patrick Pelissier
+ * All rights reserved.
+ * 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 REGENTS 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 REGENTS AND 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.
+*/
+#ifndef MSTARLIB_SERIAL_JSON_H
+#define MSTARLIB_SERIAL_JSON_H
+
+#include "m-core.h"
+#include "m-string.h"
+
+M_BEGIN_PROTECTED_CODE
+
+/* Write the boolean 'data' into the serial stream 'serial'.
+   Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline m_serial_return_code_t
+m_serial_json_write_boolean(m_serial_write_t serial, const bool data)
+{
+  FILE *f = (FILE *)serial->data[0].p;
+  int n = fprintf(f, "%s", data ? "true" : "false");
+  return n > 0 ? M_SERIAL_OK_DONE : m_core_serial_fail();
+}
+
+/* Write the integer 'data' of 'size_of_type' bytes into the serial stream 'serial'.
+   Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline m_serial_return_code_t
+m_serial_json_write_integer(m_serial_write_t serial,const long long data, const size_t size_of_type)
+{
+  (void) size_of_type; // Ignored
+  FILE *f = (FILE *)serial->data[0].p;
+  int n = fprintf(f, "%lld", data);
+  return n > 0 ? M_SERIAL_OK_DONE : m_core_serial_fail();  
+}
+
+/* Write the float 'data' of 'size_of_type' bytes into the serial stream 'serial'.
+   Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline m_serial_return_code_t
+m_serial_json_write_float(m_serial_write_t serial, const long double data, const size_t size_of_type)
+{
+  (void) size_of_type; // Ignored
+  FILE *f = (FILE *)serial->data[0].p;
+  int n = fprintf(f, "%Lf", data);
+  return n > 0 ? M_SERIAL_OK_DONE : m_core_serial_fail();
+}
+
+/* Write the null-terminated string 'data'into the serial stream 'serial'.
+   Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline m_serial_return_code_t
+m_serial_json_write_string(m_serial_write_t serial, const char data[], size_t length)
+{
+  M_ASSERT_SLOW(length == strlen(data) );
+  FILE *f = (FILE *)serial->data[0].p;
+  M_ASSERT(f != NULL && data != NULL);
+  /* HACK: Build dummy string to reuse string_out_str */
+  string_t v2;
+  uintptr_t ptr = (uintptr_t) data;
+  v2->u.heap.size = length;
+  v2->u.heap.alloc = length + 1;
+  v2->ptr = (char*)ptr;
+  string_out_str(f, v2);
+  return M_SERIAL_OK_DONE;
+}
+
+/* Start writing an array of 'number_of_elements' objects into the serial stream 'serial'.
+   If 'number_of_elements' is 0, then either the array has no data,
+   or the number of elements of the array is unkown.
+   Initialize 'local' so that it can be used to serialize the array 
+   (local is an unique serialization object of the array).
+   Return M_SERIAL_OK_CONTINUE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline m_serial_return_code_t
+m_serial_json_write_array_start(m_serial_local_t local, m_serial_write_t serial, const size_t number_of_elements)
+{
+  (void) local; // argument not used
+  (void) number_of_elements; // Ignored
+  FILE *f = (FILE *)serial->data[0].p;
+  int n = fprintf(f, "[");
+  return n > 0 ? M_SERIAL_OK_CONTINUE : m_core_serial_fail();
+}
+
+/* Write an array separator between elements of an array into the serial stream 'serial' if needed.
+   Return M_SERIAL_OK_CONTINUE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_json_write_array_next(m_serial_local_t local, m_serial_write_t serial)
+{
+  (void) local; // argument not used
+  FILE *f = (FILE *)serial->data[0].p;
+  int n = fprintf(f, ",");
+  return n > 0 ? M_SERIAL_OK_CONTINUE : m_core_serial_fail();
+}
+
+/* End the writing of an array into the serial stream 'serial'.
+   Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline   m_serial_return_code_t
+m_serial_json_write_array_end(m_serial_local_t local, m_serial_write_t serial)
+{
+  (void) local; // argument not used
+  FILE *f = (FILE *)serial->data[0].p;
+  int n = fprintf(f, "]");
+  return n > 0 ? M_SERIAL_OK_DONE : m_core_serial_fail();
+}
+
+/* Start writing a map of 'number_of_elements' pairs of objects into the serial stream 'serial'.
+   If 'number_of_elements' is 0, then either the map has no data,
+   or the number of elements is unkown.
+   Initialize 'local' so that it can be used to serialize the map 
+   (local is an unique serialization object of the map).
+   Return M_SERIAL_OK_CONTINUE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline   m_serial_return_code_t
+m_serial_json_write_map_start(m_serial_local_t local, m_serial_write_t serial, const size_t number_of_elements)
+{
+  (void) local; // argument not used
+  (void) number_of_elements; // Ignored
+  FILE *f = (FILE *)serial->data[0].p;
+  int n = fprintf(f, "{");
+  return n > 0 ? M_SERIAL_OK_CONTINUE : m_core_serial_fail();
+}
+
+/* Write a value separator between element of the same pair of a map into the serial stream 'serial' if needed.
+   Return M_SERIAL_OK_CONTINUE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline   m_serial_return_code_t
+m_serial_json_write_map_value(m_serial_local_t local, m_serial_write_t serial)
+{
+  (void) local; // argument not used
+  FILE *f = (FILE *)serial->data[0].p;
+  int n = fprintf(f, ":");
+  return n > 0 ? M_SERIAL_OK_CONTINUE : m_core_serial_fail();
+}
+
+/* Write a map separator between elements of a map into the serial stream 'serial' if needed.
+   Return M_SERIAL_OK_CONTINUE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline   m_serial_return_code_t
+m_serial_json_write_map_next(m_serial_local_t local, m_serial_write_t serial)
+{
+  (void) local; // argument not used
+  FILE *f = (FILE *)serial->data[0].p;
+  int n = fprintf(f, ",");
+  return n > 0 ? M_SERIAL_OK_CONTINUE : m_core_serial_fail();
+}
+
+/* End the writing of a map into the serial stream 'serial'.
+   Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline   m_serial_return_code_t
+m_serial_json_write_map_end(m_serial_local_t local, m_serial_write_t serial)
+{
+  (void) local; // argument not used
+  FILE *f = (FILE *)serial->data[0].p;
+  int n = fprintf(f, "}");
+  return n > 0 ? M_SERIAL_OK_DONE : m_core_serial_fail();
+}
+
+/* Start writing a tuple into the serial stream 'serial'.
+   Initialize 'local' so that it can serial the tuple 
+   (local is an unique serialization object of the tuple).
+   Return M_SERIAL_OK_CONTINUE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline   m_serial_return_code_t
+m_serial_json_write_tuple_start(m_serial_local_t local, m_serial_write_t serial)
+{
+  (void) local; // argument not used
+  FILE *f = (FILE *)serial->data[0].p;
+  int n = fprintf(f, "{");
+  return n > 0 ? M_SERIAL_OK_CONTINUE : m_core_serial_fail();
+}
+
+/* Start writing the field named field_name[index] of a tuple into the serial stream 'serial'.
+   Return M_SERIAL_OK_CONTINUE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline   m_serial_return_code_t
+m_serial_json_write_tuple_id(m_serial_local_t local, m_serial_write_t serial, const char *const field_name[], const int max, const int index)
+{
+  (void) local; // argument not used
+  (void) max; // Ignored
+  FILE *f = (FILE *)serial->data[0].p;
+  int n = fprintf(f, "%c\"%s\":", index == 0 ? ' ' : ',', field_name[index]);
+  return n > 0 ? M_SERIAL_OK_CONTINUE : m_core_serial_fail();
+}
+
+/* End the write of a tuple into the serial stream 'serial'.
+   Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline   m_serial_return_code_t
+m_serial_json_write_tuple_end(m_serial_local_t local, m_serial_write_t serial)
+{
+  (void) local; // argument not used
+  FILE *f = (FILE *)serial->data[0].p;
+  int n = fprintf(f, "}");
+  return n > 0 ? M_SERIAL_OK_DONE : m_core_serial_fail();
+}
+
+/* Start writing a variant into the serial stream 'serial'.
+   If index <= 0, the variant is empty.
+     Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise 
+   Otherwise, the field 'field_name[index]' will be filled.
+     Return M_SERIAL_OK_CONTINUE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline   m_serial_return_code_t
+m_serial_json_write_variant_start(m_serial_local_t local, m_serial_write_t serial, const char *const field_name[], const int max, const int index)
+{
+  (void) local; // argument not used
+  (void) max; // argument not used
+  FILE *f = (FILE *)serial->data[0].p;
+  int n;
+  if (index >= 0) {
+    M_ASSERT (index < max);
+    n = fprintf(f, "{\"%s\":", field_name[index]);
+    return n > 0 ? M_SERIAL_OK_CONTINUE : m_core_serial_fail();
+  } else {
+    n = fprintf(f, "{}");
+    return n > 0 ? M_SERIAL_OK_DONE : m_core_serial_fail();
+  }
+}
+
+/* End Writing a variant into the serial stream 'serial'. 
+   Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline   m_serial_return_code_t
+m_serial_json_write_variant_end(m_serial_local_t local, m_serial_write_t serial)
+{
+  (void) local; // argument not used
+  FILE *f = (FILE *)serial->data[0].p;
+  int n = fprintf(f, "}");
+  return n > 0 ? M_SERIAL_OK_DONE : m_core_serial_fail();
+}
+
+/* The internal exported interface of m_serial_write_json. */
+static const m_serial_write_interface_t m_serial_write_json_interface = {
+  m_serial_json_write_boolean,
+  m_serial_json_write_integer,
+  m_serial_json_write_float,
+  m_serial_json_write_string, 
+  m_serial_json_write_array_start,
+  m_serial_json_write_array_next,
+  m_serial_json_write_array_end,
+  m_serial_json_write_map_start,
+  m_serial_json_write_map_value,
+  m_serial_json_write_map_next,
+  m_serial_json_write_map_end,
+  m_serial_json_write_tuple_start,
+  m_serial_json_write_tuple_id,
+  m_serial_json_write_tuple_end,
+  m_serial_json_write_variant_start,
+  m_serial_json_write_variant_end
+};
+
+/* Initialize the JSON serial object for writing any object to JSON format in the given FILE */
+static inline void m_serial_json_write_init(m_serial_write_t serial, FILE *f)
+{
+  serial->m_interface = &m_serial_write_json_interface;
+  serial->data[0].p = M_ASSIGN_CAST(void*, f);
+}
+
+/* CLear the JSON serial object for writing*/
+static inline void m_serial_json_write_clear(m_serial_write_t serial)
+{
+  (void) serial; // Nothing to do
+}
+
+/* Define a synonym to the JSON serializer with a proper OPLIST */
+typedef m_serial_write_t m_serial_json_write_t;
+#define M_OPL_m_serial_json_write_t()                                         \
+  (INIT_WITH(m_serial_json_write_init), CLEAR(m_serial_json_write_clear), TYPE(m_serial_json_write_t) )
+
+
+
+/* Helper function to skip a space */
+static inline int
+m_serial_json_read_skip (FILE *f)
+{
+  int c;
+  do {
+    c = fgetc(f);
+  } while (isspace(c));
+  return c;
+}
+
+/* Read from the stream 'serial' a boolean.
+   Set '*b' with the boolean value if succeeds 
+   Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_json_read_boolean(m_serial_read_t serial, bool *b){
+  FILE *f = (FILE*) serial->data[0].p;
+  int c = m_serial_json_read_skip(f);
+  if (c == 't') {
+    *b = true;
+    c = fgetc(f);
+    if (c != 'r') return m_core_serial_fail();
+    c = fgetc(f);
+    if (c != 'u') return m_core_serial_fail();
+    c = fgetc(f);
+    if (c != 'e') return m_core_serial_fail();
+    return M_SERIAL_OK_DONE;
+  } else if (c == 'f') {
+    *b = false;
+    c = fgetc(f);
+    if (c != 'a') return m_core_serial_fail();
+    c = fgetc(f);
+    if (c != 'l') return m_core_serial_fail();
+    c = fgetc(f);
+    if (c != 's') return m_core_serial_fail();
+    c = fgetc(f);
+    if (c != 'e') return m_core_serial_fail();
+    return M_SERIAL_OK_DONE;
+  } else {
+    return m_core_serial_fail();
+  }
+}
+
+/* Read from the stream 'serial' an integer that can be represented with 'size_of_type' bytes.
+   Set '*i' with the integer value if succeeds 
+   Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_json_read_integer(m_serial_read_t serial, long long *i, const size_t size_of_type){
+  (void) size_of_type; // Ignored
+  FILE *f = (FILE*) serial->data[0].p;
+  return m_core_fscanf(f, " %lld", i) == 1 ? M_SERIAL_OK_DONE : m_core_serial_fail();
+}
+
+/* Read from the stream 'serial' a float that can be represented with 'size_of_type' bytes.
+   Set '*r' with the boolean value if succeeds 
+   Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_json_read_float(m_serial_read_t serial, long double *r, const size_t size_of_type){
+  (void) size_of_type; // Ignored
+  FILE *f = (FILE*) serial->data[0].p;
+  return m_core_fscanf(f, " %Lf", r) == 1 ? M_SERIAL_OK_DONE : m_core_serial_fail();
+}
+
+/* Read from the stream 'serial' a string.
+   Set 's' with the string if succeeds 
+   Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_json_read_string(m_serial_read_t serial, struct string_s *s){
+  FILE *f = (FILE*) serial->data[0].p;
+  int n = m_core_fscanf(f, " "); // Skip any leading spaces.
+  (void) n; // Unused return value.
+  return string_in_str(s, f) ? M_SERIAL_OK_DONE : m_core_serial_fail();
+}
+
+/* Start reading from the stream 'serial' an array.
+   Set '*num' with the number of elements, or 0 if it is not known.
+   Initialize 'local' so that it can be used to serialize the array 
+   (local is an unique serialization object of the array).
+   Return M_SERIAL_OK_CONTINUE if it succeeds and the array continue,
+   M_SERIAL_OK_DONE if it succeeds and the array ends (the array is empty),
+   M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_json_read_array_start(m_serial_local_t local, m_serial_read_t serial, size_t *num)
+{
+  (void) local; // argument not used
+  FILE *f = (FILE*) serial->data[0].p;
+  int final1 = -1, final2 = -1;
+  int n = m_core_fscanf(f, " [%n ]%n", &final1, &final2);
+  (void) n; // Unused. Parsing is checked through c (more robust)
+  *num = 0; // don't know the size of the array.
+  // Test how much the parsing succeed.
+  if (final1 < 0) m_core_serial_fail();
+  return (final2 < 0) ? M_SERIAL_OK_CONTINUE : M_SERIAL_OK_DONE;
+}
+
+/* Continue reading from the stream 'serial' an array.
+   Return M_SERIAL_OK_CONTINUE if it succeeds and the array continue,
+   M_SERIAL_OK_DONE if it succeeds and the array ends,
+   M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_json_read_array_next(m_serial_local_t local, m_serial_read_t serial)
+{
+  (void) local; // argument not used
+  FILE *f = (FILE*) serial->data[0].p;
+  char c = 0;
+  int n = m_core_fscanf(f, " %c", m_core_arg_size(&c, 1) );
+  (void) n; // Unused. Parsing is checked through c (more robust)
+  return c == ',' ? M_SERIAL_OK_CONTINUE : c == ']' ? M_SERIAL_OK_DONE : m_core_serial_fail();
+}
+
+/* Start reading from the stream 'serial' a map.
+   Set '*num' with the number of elements, or 0 if it is not known.
+   Initialize 'local' so that it can be used to serialize the array 
+   (local is an unique serialization object of the array).
+   Return M_SERIAL_OK_CONTINUE if it succeeds and the map continue,
+   M_SERIAL_OK_DONE if it succeeds and the map ends (the map is empty),
+   m_core_serial_fail() otherwise */
+static inline  m_serial_return_code_t
+m_serial_json_read_map_start(m_serial_local_t local, m_serial_read_t serial, size_t *num)
+{
+  (void) local; // argument not used
+  FILE *f = (FILE*) serial->data[0].p;
+  int final1 = -1, final2 = -1;
+  int n = m_core_fscanf(f, " {%n }%n", &final1, &final2);
+  (void) n; // Unused. Parsing is checked through final (more robust)
+  *num = 0; // don't know the size of the map.
+  // Test how much the parsing succeed.
+  if (final1 < 0) m_core_serial_fail();
+  return (final2 < 0) ? M_SERIAL_OK_CONTINUE : M_SERIAL_OK_DONE;
+}
+
+/* Continue reading from the stream 'serial' the value separator
+   Return M_SERIAL_OK_CONTINUE if it succeeds and the map continue,
+   M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_json_read_map_value(m_serial_local_t local, m_serial_read_t serial)
+{
+  (void) local; // argument not used
+  FILE *f = (FILE*) serial->data[0].p;
+  int final = -1;
+  int n = m_core_fscanf(f, " :%n", &final);
+  (void) n; // Unused. Parsing is checked through final (more robust)
+  return final > 0 ? M_SERIAL_OK_CONTINUE : m_core_serial_fail();
+}
+
+/* Continue reading from the stream 'serial' a map.
+   Return M_SERIAL_OK_CONTINUE if it succeeds and the map continue,
+   M_SERIAL_OK_DONE if it succeeds and the map ends,
+   M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_json_read_map_next(m_serial_local_t local, m_serial_read_t serial)
+{
+  (void) local; // argument not used
+  FILE *f = (FILE*) serial->data[0].p;
+  char c = 0;
+  int n = m_core_fscanf(f, " %c", m_core_arg_size(&c, 1) );
+  (void) n; // Unused. Parsing is checked through c (more robust)
+  return c == ',' ? M_SERIAL_OK_CONTINUE : c == '}' ? M_SERIAL_OK_DONE : m_core_serial_fail();
+}
+
+/* Start reading a tuple from the stream 'serial'.
+   Return M_SERIAL_OK_CONTINUE if it succeeds and the tuple continues,
+   M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_json_read_tuple_start(m_serial_local_t local, m_serial_read_t serial)
+{
+  (void) local; // argument not used
+  FILE *f = (FILE*) serial->data[0].p;
+  int final = -1;
+  int n = m_core_fscanf(f, " {%n", &final);
+  (void) n; // Unused. Parsing is checked through final (more robust)
+  return final > 0 ? M_SERIAL_OK_CONTINUE : m_core_serial_fail();
+}
+
+/* Continue reading a tuple from the stream 'serial'.
+   Set '*id' with the corresponding index of the table 'field_name[max]'
+   associated to the parsed field in the stream.
+   Return M_SERIAL_OK_CONTINUE if it succeeds and the tuple continues,
+   Return M_SERIAL_OK_DONE if it succeeds and the tuple ends,
+   M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_json_read_tuple_id(m_serial_local_t local, m_serial_read_t serial, const char *const field_name [], const int max, int *id)
+{
+  (void) local; // argument not used
+  FILE *f = (FILE*) serial->data[0].p;
+  int c = m_serial_json_read_skip(f);
+  if (c == EOF) return m_core_serial_fail();
+  if (c == '}') return M_SERIAL_OK_DONE;
+  if (c == ',') {
+     // If first call of read_tuple_id, it is a failure
+     if (*id == -1) return m_core_serial_fail();
+  } else {
+    // c should be \" but let fscanf parse it.
+    ungetc(c, f);
+  }
+  /* Read the field in the JSON */
+  c = -1;
+  char field[M_MAX_IDENTIFIER_LENGTH+1];
+  int nn = m_core_fscanf(f, " \"%" M_APPLY(M_AS_STR, M_MAX_IDENTIFIER_LENGTH) "[^ \t\n\"]\":%n",
+                m_core_arg_size(field, M_MAX_IDENTIFIER_LENGTH+1), &c);
+  (void) nn ; // Unused. Check is done through 'c' (more robust).
+  if (c <= 0)
+    return m_core_serial_fail();
+  /* Search for field in field_name */
+  for(int n = 0; n < max; n++) {
+    if (strcmp(field, field_name[n]) == 0) {
+      *id = n;
+      return M_SERIAL_OK_CONTINUE;
+    }
+  }
+  return m_core_serial_fail();
+}
+
+/* Start reading a variant from the stream 'serial'.
+   Set '*id' with the corresponding index of the table 'field_name[max]'
+   associated to the parsed field in the stream.
+   Return M_SERIAL_OK_CONTINUE if it succeeds and the variant continues,
+   Return M_SERIAL_OK_DONE if it succeeds and the variant ends(variant is empty),
+   M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_json_read_variant_start(m_serial_local_t local, m_serial_read_t serial, const char *const field_name[], const int max, int*id)
+{
+  (void) local; // argument not used
+  FILE *f = (FILE*) serial->data[0].p;
+
+  int final1 = -1, final2 = -1;
+  int nn = m_core_fscanf(f, " {%n }%n", &final1, &final2);
+  (void) nn ; // Unused. Check is done through final (more robust).
+  // Test how much the parsing succeed.
+  if (final1 <= 0) return m_core_serial_fail();
+  if (final2 > 0)  return M_SERIAL_OK_DONE;
+
+  /* Read the field in the JSON */
+  char field[M_MAX_IDENTIFIER_LENGTH+1];
+  nn = m_core_fscanf(f, " \"%" M_APPLY(M_AS_STR, M_MAX_IDENTIFIER_LENGTH) "[^ \t\n\"]\":%n", 
+                m_core_arg_size(field, M_MAX_IDENTIFIER_LENGTH+1), &final2);
+  (void) nn ; // Unused. Check is done through final (more robust).
+  if (final2 <= 0) return m_core_serial_fail();
+
+  /* Linear Search for field in field_name */
+  for(int n = 0; n < max; n++) {
+    if (strcmp(field, field_name[n]) == 0) {
+      *id = n;
+      return M_SERIAL_OK_CONTINUE;
+    }
+  }
+  // Field not found
+  return m_core_serial_fail();
+}
+
+/* End reading a variant from the stream 'serial'.
+   Return M_SERIAL_OK_DONE if it succeeds and the variant ends,
+   M_SERIAL_FAIL otherwise */
+static inline  m_serial_return_code_t
+m_serial_json_read_variant_end(m_serial_local_t local, m_serial_read_t serial)
+{
+  (void) local; // argument not used
+  FILE *f = (FILE*) serial->data[0].p;
+  int final = -1;
+  int n = m_core_fscanf(f, " }%n", &final);
+  (void) n ; // Unused. Check is done through final (more robust).
+  return final > 0 ? M_SERIAL_OK_DONE : m_core_serial_fail();
+}
+
+static const m_serial_read_interface_t m_serial_json_read_interface = {
+  m_serial_json_read_boolean,
+  m_serial_json_read_integer,
+  m_serial_json_read_float,
+  m_serial_json_read_string,
+  m_serial_json_read_array_start,
+  m_serial_json_read_array_next,
+  m_serial_json_read_map_start,
+  m_serial_json_read_map_value,
+  m_serial_json_read_map_next,
+  m_serial_json_read_tuple_start,
+  m_serial_json_read_tuple_id,
+  m_serial_json_read_variant_start,
+  m_serial_json_read_variant_end
+};
+
+/* Initialize the JSON serial object for reading any object from JSON format in the given FILE */
+static inline void m_serial_json_read_init(m_serial_read_t serial, FILE *f)
+{
+  serial->m_interface = &m_serial_json_read_interface;
+  serial->data[0].p = M_ASSIGN_CAST(void*, f);
+}
+
+/* Clear the JSON serial object for reading from the FILE */
+static inline void m_serial_json_read_clear(m_serial_read_t serial)
+{
+  (void) serial; // Nothing to do
+}
+
+/* Define a synonym of m_serial_read_t 
+  to the JSON serializer with its proper OPLIST */
+typedef m_serial_read_t m_serial_json_read_t;
+#define M_OPL_m_serial_json_read_t()                                          \
+  (INIT_WITH(m_serial_json_read_init), CLEAR(m_serial_json_read_clear), TYPE(m_serial_json_read_t) )
+
+M_END_PROTECTED_CODE
+
+#endif

m-shared.h

@@ -1,7 +1,7 @@
 /*
  * M*LIB - SHARED Module
  *
- * Copyright (c) 2017-2019, Patrick Pelissier
+ * Copyright (c) 2017-2021, Patrick Pelissier
  * All rights reserved.
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -29,392 +29,478 @@
 #include "m-atomic.h"
 #include "m-genint.h"
 
+M_BEGIN_PROTECTED_CODE
+
 /* Define the oplist of a shared pointer.
    USAGE: SHARED_OPLIST(name [, oplist_of_the_type]) */
-#define SHARED_PTR_OPLIST(...)                                          \
-  SHAREDI_PTR_OPLIST(M_IF_NARGS_EQ1(__VA_ARGS__)                        \
-                     ((__VA_ARGS__, M_DEFAULT_OPLIST ),			\
-                      _OPLIST(__VA_ARGS__ )))
+#define SHARED_PTR_OPLIST(...)                                                \
+  SHAREDI_PTR_OPLIST_P1(M_IF_NARGS_EQ1(__VA_ARGS__)                           \
+                        ((__VA_ARGS__, M_DEFAULT_OPLIST ),                    \
+                         (__VA_ARGS__ )))
+
 
 /* Define shared pointer and its function.
    USAGE: SHARED_PTR_DEF(name, type, [, oplist]) */
-#define SHARED_PTR_DEF(name, ...)                                       \
-  SHAREDI_PTR_DEF(M_IF_NARGS_EQ1(__VA_ARGS__)                           \
-                  ((name, __VA_ARGS__, M_GLOBAL_OPLIST_OR_DEF(__VA_ARGS__)(), SHAREDI_ATOMIC_OPLIST ), \
-                   (name, __VA_ARGS__ , SHAREDI_ATOMIC_OPLIST)))
+#define SHARED_PTR_DEF(name, ...)                                             \
+  M_BEGIN_PROTECTED_CODE                                                      \
+  SHAREDI_PTR_DEF_P1(M_IF_NARGS_EQ1(__VA_ARGS__)                              \
+                     ((name, __VA_ARGS__, M_GLOBAL_OPLIST_OR_DEF(__VA_ARGS__)(), SHAREDI_ATOMIC_OPLIST, M_C(name, _t) ), \
+                      (name, __VA_ARGS__ ,                                       SHAREDI_ATOMIC_OPLIST, M_C(name, _t) ))) \
+  M_END_PROTECTED_CODE
+
+
+/* Define shared pointer and its function
+   as the given name name_t
+   USAGE: SHARED_PTR_DEF_AS(name, name_t, type, [, oplist]) */
+#define SHARED_PTR_DEF_AS(name, name_t, ...)                                  \
+  M_BEGIN_PROTECTED_CODE                                                      \
+  SHAREDI_PTR_DEF_P1(M_IF_NARGS_EQ1(__VA_ARGS__)                              \
+                     ((name, __VA_ARGS__, M_GLOBAL_OPLIST_OR_DEF(__VA_ARGS__)(), SHAREDI_ATOMIC_OPLIST, name_t ), \
+                      (name, __VA_ARGS__ ,                                       SHAREDI_ATOMIC_OPLIST, name_t ))) \
+  M_END_PROTECTED_CODE
+
 
 /* Define relaxed shared pointer and its function (thread unsafe).
    USAGE: SHARED_PTR_RELAXED_DEF(name, type, [, oplist]) */
-#define SHARED_PTR_RELAXED_DEF(name, ...)                               \
-  SHAREDI_PTR_DEF(M_IF_NARGS_EQ1(__VA_ARGS__)                           \
-                  ((name, __VA_ARGS__, M_GLOBAL_OPLIST_OR_DEF(__VA_ARGS__)(), SHAREDI_INTEGER_OPLIST ), \
-                   (name, __VA_ARGS__ , SHAREDI_INTEGER_OPLIST)))
+#define SHARED_PTR_RELAXED_DEF(name, ...)                                     \
+  M_BEGIN_PROTECTED_CODE                                                      \
+  SHAREDI_PTR_DEF_P1(M_IF_NARGS_EQ1(__VA_ARGS__)                              \
+                     ((name, __VA_ARGS__, M_GLOBAL_OPLIST_OR_DEF(__VA_ARGS__)(), SHAREDI_INTEGER_OPLIST, M_C(name, _t) ), \
+                      (name, __VA_ARGS__,                                        SHAREDI_INTEGER_OPLIST, M_C(name, _t) ))) \
+  M_END_PROTECTED_CODE
+
+
+/* Define relaxed shared pointer and its function (thread unsafe)
+   as the given name name_t
+   USAGE: SHARED_PTR_RELAXED_DEF(name, type, [, oplist]) */
+#define SHARED_PTR_RELAXED_DEF_AS(name, name_t, ...)                          \
+  M_BEGIN_PROTECTED_CODE                                                      \
+  SHAREDI_PTR_DEF_P1(M_IF_NARGS_EQ1(__VA_ARGS__)                              \
+                     ((name, __VA_ARGS__, M_GLOBAL_OPLIST_OR_DEF(__VA_ARGS__)(), SHAREDI_INTEGER_OPLIST, name_t ), \
+                      (name, __VA_ARGS__,                                        SHAREDI_INTEGER_OPLIST, name_t ))) \
+  M_END_PROTECTED_CODE
+
 
 /* Define shared resource and its function.
    This is a bounded pool of resource shared by multiple owners.
    USAGE: SHARED_RESOURCE_DEF(name, type, [, oplist]) */
-#define SHARED_RESOURCE_DEF(name, ...)                                 \
-  SHAREDI_RESOURCE_DEF(M_IF_NARGS_EQ1(__VA_ARGS__)                     \
-                        ((name, __VA_ARGS__, M_GLOBAL_OPLIST_OR_DEF(__VA_ARGS__) ), \
-                         (name, __VA_ARGS__)))
+#define SHARED_RESOURCE_DEF(name, ...)                                        \
+  M_BEGIN_PROTECTED_CODE                                                      \
+  SHAREDI_RESOURCE_DEF_P1(M_IF_NARGS_EQ1(__VA_ARGS__)                         \
+                          ((name, __VA_ARGS__, M_GLOBAL_OPLIST_OR_DEF(__VA_ARGS__)(), M_C(name, _t), M_C(name, _it_t)  ), \
+                           (name, __VA_ARGS__,                                        M_C(name, _t), M_C(name, _it_t)  ))) \
+  M_END_PROTECTED_CODE
+
+
+/* Define shared resource and its function
+   as the given name named_t and the iterator it_t
+   This is a bounded pool of resource shared by multiple owners.
+   USAGE: SHARED_RESOURCE_DEF_AS(name, name_t, it_t, type, [, oplist]) */
+#define SHARED_RESOURCE_DEF_AS(name, name_t, it_t, ...)                       \
+  M_BEGIN_PROTECTED_CODE                                                      \
+  SHAREDI_RESOURCE_DEF_P1(M_IF_NARGS_EQ1(__VA_ARGS__)                         \
+                          ((name, __VA_ARGS__, M_GLOBAL_OPLIST_OR_DEF(__VA_ARGS__)(), name_t, it_t ), \
+                           (name, __VA_ARGS__,                                        name_t, it_t ))) \
+  M_END_PROTECTED_CODE
 
 
 
 /********************************** INTERNAL ************************************/
 
-// deferred
-#define SHAREDI_PTR_OPLIST(arg) SHAREDI_PTR_OPLIST2 arg
+// deferred evaluation
+#define SHAREDI_PTR_OPLIST_P1(arg) SHAREDI_PTR_OPLIST_P2 arg
 
-#define SHAREDI_PTR_OPLIST2(name, oplist) (                             \
-  INIT(M_C(name, _init)),                                               \
-  CLEAR(M_C(name, _clear)),                                             \
-  INIT_SET(M_C(name, _init_set)),                                       \
-  SET(M_C(name, _set))                                                  \
-  INIT_MOVE(M_C(name, _init_move)),                                     \
-  CLEAN(M_C(name, _clean)),                                             \
-  MOVE(M_C(name, _move)),                                               \
-  SWAP(M_C(name, _swap))                                                \
-  ,M_IF_METHOD(NEW, oplist)(NEW(M_GET_NEW oplist),)                     \
-  ,M_IF_METHOD(REALLOC, oplist)(REALLOC(M_GET_REALLOC oplist),)         \
-  ,M_IF_METHOD(DEL, oplist)(DEL(M_GET_DEL oplist),)                     \
+/* Validation of the given, shared_t oplist */
+#define SHAREDI_PTR_OPLIST_P2(name, oplist)                                   \
+  M_IF_OPLIST(oplist)(SHAREDI_PTR_OPLIST_P3, SHAREDI_PTR_OPLIST_FAILURE)(name, oplist)
+
+/* Prepare a clean compilation failure */
+#define SHAREDI_PTR_OPLIST_FAILURE(name, oplist)                              \
+  ((M_LIB_ERROR(ARGUMENT_OF_SHARED_PTR_OPLIST_IS_NOT_AN_OPLIST, name, oplist)))
+
+#define SHAREDI_PTR_OPLIST_P3(name, oplist) (                                 \
+  INIT(M_C(name, _init)),                                                     \
+  CLEAR(M_C(name, _clear)),                                                   \
+  INIT_SET(M_C(name, _init_set)),                                             \
+  SET(M_C(name, _set))                                                        \
+  INIT_MOVE(M_C(name, _init_move)),                                           \
+  CLEAN(M_C(name, _clean)),                                                   \
+  MOVE(M_C(name, _move)),                                                     \
+  SWAP(M_C(name, _swap))                                                      \
+  ,TYPE(M_C(name, _ct))                                                       \
+  ,M_IF_METHOD(NEW, oplist)(NEW(M_GET_NEW oplist),)                           \
+  ,M_IF_METHOD(REALLOC, oplist)(REALLOC(M_GET_REALLOC oplist),)               \
+  ,M_IF_METHOD(DEL, oplist)(DEL(M_GET_DEL oplist),)                           \
   )
 
-// deferred
-#define SHAREDI_PTR_DEF(arg) SHAREDI_PTR_DEF2 arg
-
 // OPLIST to handle a counter of atomic type
-#define SHAREDI_ATOMIC_OPLIST (TYPE(atomic_int),                        \
-                               INIT_SET(atomic_init),                   \
-                               ADD(atomic_fetch_add),                   \
-                               SUB(atomic_fetch_sub),                   \
+#define SHAREDI_ATOMIC_OPLIST (TYPE(atomic_int),                              \
+                               INIT_SET(atomic_init),                         \
+                               ADD(atomic_fetch_add),                         \
+                               SUB(atomic_fetch_sub),                         \
                                IT_CREF(atomic_load))
 
-// OPLIST to handle a counter of non-atomic type with its helper functions.
-#define SHAREDI_INTEGER_OPLIST (TYPE(int),                              \
-                                INIT_SET(sharedi_integer_init_set),     \
-                                ADD(sharedi_integer_add),               \
-                                SUB(sharedi_integer_sub),               \
+// OPLIST to handle a counter of non-atomic type
+#define SHAREDI_INTEGER_OPLIST (TYPE(int),                                    \
+                                INIT_SET(sharedi_integer_init_set),           \
+                                ADD(sharedi_integer_add),                     \
+                                SUB(sharedi_integer_sub),                     \
                                 IT_CREF(sharedi_integer_cref))
+
+/* Atomic like interface for basic integers */
 static inline void sharedi_integer_init_set(int *p, int val) { *p = val; }
 static inline int sharedi_integer_add(int *p, int val) { int r = *p;  *p += val; return r; }
 static inline int sharedi_integer_sub(int *p, int val) { int r = *p;  *p -= val; return r; }
 static inline int sharedi_integer_cref(int *p) { return *p; }
 
-#define SHAREDI_CONTRACT(shared, cpt_oplist) do {                       \
-    assert(shared != NULL);                                             \
-    assert(*shared == NULL || M_CALL_IT_CREF(cpt_oplist, &(*shared)->cpt) >= 1); \
+/* Contract of a shared pointer */
+#define SHAREDI_CONTRACT(shared, cpt_oplist) do {                             \
+    M_ASSERT(shared != NULL);                                                 \
+    M_ASSERT(*shared == NULL || M_CALL_IT_CREF(cpt_oplist, &(*shared)->cpt) >= 1); \
   } while (0)
 
-#define SHAREDI_PTR_DEF2(name, type, oplist, cpt_oplist)                \
-									\
-  typedef struct M_C(name, _s){						\
-    type *data;	                /* Pointer to the data */               \
-    M_GET_TYPE cpt_oplist  cpt; /* Counter of how many points to the data */ \
-    bool  combineAlloc; /* Does the data and the ptr share the slot? */ \
-  } *M_C(name, _t)[1];							\
-  typedef struct M_C(name, _s) *M_C(name, _ptr);                        \
-  typedef const struct M_C(name, _s) *M_C(name, _srcptr);               \
-		  							\
-  typedef struct M_C(name, combine_s) {                                 \
-    type data;                                                          \
-    struct M_C(name, _s) ptr;						\
-  } M_C(name, combine_t)[1];						\
-                                                                        \
-  static inline void				                        \
-  M_C(name, _init)(M_C(name, _t) shared)                                \
-  {									\
-    *shared = NULL;                                                     \
-  }                                                                     \
-                                                                        \
-  static inline void				                        \
-  M_C(name, _init2)(M_C(name, _t) shared, type *data)			\
-  {									\
-    assert (shared != NULL);                                            \
-    /* The shared ptr get exclusive access to data */                   \
-    struct M_C(name, _s) *ptr;						\
-    if (M_UNLIKELY (data == NULL)) {                                    \
-      *shared = NULL;                                                   \
-      return;                                                           \
-    }                                                                   \
-    ptr = M_CALL_NEW(oplist, struct M_C(name, _s));			\
-    if (M_UNLIKELY (ptr == NULL)) {                                     \
-      M_MEMORY_FULL(sizeof(struct M_C(name, _s)));			\
-      return;                                                           \
-    }                                                                   \
-    ptr->data = data;							\
-    M_CALL_INIT_SET(cpt_oplist, &ptr->cpt, 1);                          \
-    ptr->combineAlloc = false;                                          \
-    *shared = ptr;							\
-    SHAREDI_CONTRACT(shared, cpt_oplist);                               \
-  }									\
-									\
-  static inline void				                        \
-  M_C(name, _init_new)(M_C(name, _t) shared)				\
-  {									\
-    /* NOTE: Alloc 1 struct with both structures. */                    \
-    struct M_C(name, combine_s) *p =					\
-      M_CALL_NEW(oplist, struct M_C(name, combine_s));			\
-    if (M_UNLIKELY (p == NULL)) {                                       \
-      M_MEMORY_FULL(sizeof(struct M_C(name, combine_s)));		\
-      return;								\
-    }                                                                   \
-    struct M_C(name, _s) *ptr = &p->ptr;				\
-    type *data = &p->data;                                              \
-    M_CALL_INIT( oplist, *data);                                        \
-    ptr->data = data;							\
-    M_CALL_INIT_SET(cpt_oplist, &ptr->cpt, 1);                          \
-    ptr->combineAlloc = true;                                           \
-    *shared = ptr;							\
-    SHAREDI_CONTRACT(shared, cpt_oplist);                               \
-  }									\
-									\
-  static inline bool				                        \
-  M_C(name, _NULL_p)(const M_C(name, _t) shared)			\
-  {									\
-    SHAREDI_CONTRACT(shared, cpt_oplist);                               \
-    return *shared == NULL;						\
-  }									\
-									\
-  static inline void				                        \
-  M_C(name, _init_set)(M_C(name, _t) dest,				\
-		       const M_C(name, _t) shared)			\
-  {									\
-    SHAREDI_CONTRACT(shared, cpt_oplist);                               \
-    assert (dest != shared);                                            \
-    *dest = *shared;							\
-    if (*dest != NULL) {						\
-      int n = M_CALL_ADD(cpt_oplist, &((*dest)->cpt), 1);             \
-      (void) n;	/* unused return value */				\
-    }									\
-    SHAREDI_CONTRACT(dest, cpt_oplist);                                 \
-  }									\
-									\
-  static inline void				                        \
-  M_C(name, _clear)(M_C(name, _t) dest)					\
-  {									\
-    SHAREDI_CONTRACT(dest, cpt_oplist);                                 \
-    if (*dest != NULL)	{						\
-      if (M_CALL_SUB(cpt_oplist, &((*dest)->cpt), 1) == 1)	{       \
-        bool combineAlloc = (*dest)->combineAlloc;                      \
-        /* Note: if combineAlloc is true, the address of the slot       \
-           combining both data & ptr is the same as the address of the  \
-           first element, aka data itself. Static analyzer tools don't  \
-           seem to detect this and report error. */                     \
-        M_CALL_CLEAR(oplist, *(*dest)->data);                           \
-        M_CALL_DEL(oplist, (*dest)->data);                              \
-        if (combineAlloc == false)                                      \
-          M_CALL_DEL(oplist, *dest);                                    \
-      }									\
-      *dest = NULL;                                                     \
-    }                                                                   \
-    SHAREDI_CONTRACT(dest, cpt_oplist);                                 \
-  }									\
-                                                                        \
-  static inline void				                        \
-  M_C(name, _clean)(M_C(name, _t) dest)					\
-  {									\
-    /* NOTE: Clear will also set dest to NULL */                        \
-    M_C(name, _clear)(dest);						\
-  }                                                                     \
-									\
-  static inline void				                        \
-  M_C(name, _set)(M_C(name, _t) dest,					\
-		  const M_C(name, _t) shared)				\
-  {									\
-    SHAREDI_CONTRACT(dest, cpt_oplist);                                 \
-    SHAREDI_CONTRACT(shared, cpt_oplist);                               \
-    M_C(name, _clear)(dest);						\
-    M_C(name, _init_set)(dest, shared);					\
-  }									\
-									\
-  static inline void				                        \
-  M_C(name, _init_move)(M_C(name, _t) dest,				\
-			M_C(name, _t) shared)				\
-  {									\
-    SHAREDI_CONTRACT(shared, cpt_oplist);                               \
-    assert (dest != NULL && dest != shared);                            \
-    *dest = *shared;							\
-    *shared = NULL;                                                     \
-    SHAREDI_CONTRACT(dest, cpt_oplist);                                 \
-  }									\
-									\
-  static inline void				                        \
-  M_C(name, _move)(M_C(name, _t) dest,					\
-		   M_C(name, _t) shared)				\
-  {									\
-    SHAREDI_CONTRACT(dest, cpt_oplist);                                 \
-    SHAREDI_CONTRACT(shared, cpt_oplist);                               \
-    assert (dest != shared);						\
-    M_C(name, _clear)(dest);						\
-    M_C(name, _init_move)(dest, shared);				\
-  }									\
-									\
-  static inline void				                        \
-  M_C(name, _swap)(M_C(name, _t) p1,					\
-		   M_C(name, _t) p2)					\
-  {									\
-    SHAREDI_CONTRACT(p1, cpt_oplist);                                   \
-    SHAREDI_CONTRACT(p2, cpt_oplist);                                   \
-    M_SWAP (struct M_C(name, _s)*, *p1, *p2);				\
-    SHAREDI_CONTRACT(p1, cpt_oplist);                                   \
-    SHAREDI_CONTRACT(p2, cpt_oplist);                                   \
-  }									\
-									\
-  static inline bool				                        \
-  M_C(name, _equal_p)(const M_C(name, _t) p1,				\
-		      const M_C(name, _t) p2)				\
-  {									\
-    SHAREDI_CONTRACT(p1, cpt_oplist);                                   \
-    SHAREDI_CONTRACT(p2, cpt_oplist);                                   \
-    return *p1 == *p2;							\
-  }									\
-									\
-  static inline type const *						\
-  M_C(name, _cref)(const M_C(name, _t) shared)				\
-  {									\
-    SHAREDI_CONTRACT(shared, cpt_oplist);                               \
-    assert(*shared != NULL);                                            \
-    type *data = (*shared)->data;                                       \
-    assert (data != NULL);                                              \
-    return M_CONST_CAST (type, data);                                   \
-  }									\
-									\
-  static inline type *				                        \
-  M_C(name, _ref)(M_C(name, _t) shared)					\
-  {									\
-    SHAREDI_CONTRACT(shared, cpt_oplist);                               \
-    assert(*shared != NULL);                                            \
-    type *data = (*shared)->data;                                       \
-    assert (data != NULL);                                              \
-    return data;                                                        \
-  }									\
+// deferred evaluation
+#define SHAREDI_PTR_DEF_P1(arg) SHAREDI_PTR_DEF_P2 arg
+
+/* Validate the oplist before going further */
+#define SHAREDI_PTR_DEF_P2(name, type, oplist, cpt_oplist, shared_t)          \
+  M_IF_OPLIST(oplist)(SHAREDI_PTR_DEF_P3, SHAREDI_PTR_DEF_FAILURE)(name, type, oplist, cpt_oplist, shared_t)
+
+/* Stop processing with a compilation failure */
+#define SHAREDI_PTR_DEF_FAILURE(name, type, oplist, cpt_oplist, shared_t)     \
+  M_STATIC_FAILURE(M_LIB_NOT_AN_OPLIST, "(SHARED_PTR_DEF): the given argument is not a valid oplist: " #oplist)
+
+/* Code generation */
+#define SHAREDI_PTR_DEF_P3(name, type, oplist, cpt_oplist, shared_t)          \
+                                                                              \
+  typedef struct M_C(name, _s){                                               \
+    type *data;                        /* Pointer to the data */              \
+    M_GET_TYPE cpt_oplist  cpt; /* Counter of how many refs the data */       \
+    bool  combineAlloc; /* Does the data and the ptr share the slot? */       \
+  } *shared_t[1];                                                             \
+  typedef struct M_C(name, _s) *M_C(name, _ptr);                              \
+  typedef const struct M_C(name, _s) *M_C(name, _srcptr);                     \
+                                                                              \
+  /* Internal type for oplist */                                              \
+  typedef shared_t M_C(name, _ct);                                            \
+                                                                              \
+  typedef struct M_C(name, combine_s) {                                       \
+    type data;                                                                \
+    struct M_C(name, _s) ptr;                                                 \
+  } M_C(name, combine_ct)[1];                                                 \
+                                                                              \
+  M_CHECK_COMPATIBLE_OPLIST(name, 1, type, oplist)                            \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _init)(shared_t shared)                                           \
+  {                                                                           \
+    *shared = NULL;                                                           \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _init2)(shared_t shared, type *data)                              \
+  {                                                                           \
+    M_ASSERT (shared != NULL);                                                \
+    /* The shared ptr get exclusive access to data */                         \
+    struct M_C(name, _s) *ptr;                                                \
+    if (M_UNLIKELY (data == NULL)) {                                          \
+      *shared = NULL;                                                         \
+      return;                                                                 \
+    }                                                                         \
+    ptr = M_CALL_NEW(oplist, struct M_C(name, _s));                           \
+    if (M_UNLIKELY (ptr == NULL)) {                                           \
+      M_MEMORY_FULL(sizeof(struct M_C(name, _s)));                            \
+      return;                                                                 \
+    }                                                                         \
+    ptr->data = data;                                                         \
+    M_CALL_INIT_SET(cpt_oplist, &ptr->cpt, 1);                                \
+    ptr->combineAlloc = false;                                                \
+    *shared = ptr;                                                            \
+    SHAREDI_CONTRACT(shared, cpt_oplist);                                     \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _init_new)(shared_t shared)                                       \
+  {                                                                           \
+    /* NOTE: Alloc 1 struct with both structures. */                          \
+    struct M_C(name, combine_s) *p =                                          \
+      M_CALL_NEW(oplist, struct M_C(name, combine_s));                        \
+    if (M_UNLIKELY (p == NULL)) {                                             \
+      M_MEMORY_FULL(sizeof(struct M_C(name, combine_s)));                     \
+      return;                                                                 \
+    }                                                                         \
+    struct M_C(name, _s) *ptr = &p->ptr;                                      \
+    type *data = &p->data;                                                    \
+    M_CALL_INIT( oplist, *data);                                              \
+    ptr->data = data;                                                         \
+    M_CALL_INIT_SET(cpt_oplist, &ptr->cpt, 1);                                \
+    ptr->combineAlloc = true;                                                 \
+    *shared = ptr;                                                            \
+    SHAREDI_CONTRACT(shared, cpt_oplist);                                     \
+  }                                                                           \
+                                                                              \
+  static inline bool                                                          \
+  M_C(name, _NULL_p)(const shared_t shared)                                   \
+  {                                                                           \
+    SHAREDI_CONTRACT(shared, cpt_oplist);                                     \
+    return *shared == NULL;                                                   \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _init_set)(shared_t dest,                                         \
+                       const shared_t shared)                                 \
+  {                                                                           \
+    SHAREDI_CONTRACT(shared, cpt_oplist);                                     \
+    M_ASSERT (dest != shared);                                                \
+    *dest = *shared;                                                          \
+    if (*dest != NULL) {                                                      \
+      int n = M_CALL_ADD(cpt_oplist, &((*dest)->cpt), 1);                     \
+      (void) n;        /* unused return value */                              \
+    }                                                                         \
+    SHAREDI_CONTRACT(dest, cpt_oplist);                                       \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _clear)(shared_t dest)                                            \
+  {                                                                           \
+    SHAREDI_CONTRACT(dest, cpt_oplist);                                       \
+    if (*dest != NULL)        {                                               \
+      if (M_CALL_SUB(cpt_oplist, &((*dest)->cpt), 1) == 1)        {           \
+        bool combineAlloc = (*dest)->combineAlloc;                            \
+        /* Note: if combineAlloc is true, the address of the slot             \
+           combining both data & ptr is the same as the address of the        \
+           first element, aka data itself. Static analyzer tools don't        \
+           seem to detect this and report error. */                           \
+        M_CALL_CLEAR(oplist, *(*dest)->data);                                 \
+        M_CALL_DEL(oplist, (*dest)->data);                                    \
+        if (combineAlloc == false)                                            \
+          M_CALL_DEL(oplist, *dest);                                          \
+      }                                                                       \
+      *dest = NULL;                                                           \
+    }                                                                         \
+    SHAREDI_CONTRACT(dest, cpt_oplist);                                       \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _clean)(shared_t dest)                                            \
+  {                                                                           \
+    /* NOTE: Clear will also set dest to NULL */                              \
+    M_C(name, _clear)(dest);                                                  \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _set)(shared_t dest,                                              \
+                  const shared_t shared)                                      \
+  {                                                                           \
+    SHAREDI_CONTRACT(dest, cpt_oplist);                                       \
+    SHAREDI_CONTRACT(shared, cpt_oplist);                                     \
+    M_C(name, _clear)(dest);                                                  \
+    M_C(name, _init_set)(dest, shared);                                       \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _init_move)(shared_t dest,                                        \
+                        shared_t shared)                                      \
+  {                                                                           \
+    SHAREDI_CONTRACT(shared, cpt_oplist);                                     \
+    M_ASSERT (dest != NULL && dest != shared);                                \
+    *dest = *shared;                                                          \
+    *shared = NULL;                                                           \
+    SHAREDI_CONTRACT(dest, cpt_oplist);                                       \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _move)(shared_t dest,                                             \
+                   shared_t shared)                                           \
+  {                                                                           \
+    SHAREDI_CONTRACT(dest, cpt_oplist);                                       \
+    SHAREDI_CONTRACT(shared, cpt_oplist);                                     \
+    M_ASSERT (dest != shared);                                                \
+    M_C(name, _clear)(dest);                                                  \
+    M_C(name, _init_move)(dest, shared);                                      \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _swap)(shared_t p1,                                               \
+                   shared_t p2)                                               \
+  {                                                                           \
+    SHAREDI_CONTRACT(p1, cpt_oplist);                                         \
+    SHAREDI_CONTRACT(p2, cpt_oplist);                                         \
+    /* NOTE: SWAP is not atomic */                                            \
+    M_SWAP (struct M_C(name, _s)*, *p1, *p2);                                 \
+    SHAREDI_CONTRACT(p1, cpt_oplist);                                         \
+    SHAREDI_CONTRACT(p2, cpt_oplist);                                         \
+  }                                                                           \
+                                                                              \
+  static inline bool                                                          \
+  M_C(name, _equal_p)(const shared_t p1,                                      \
+                      const shared_t p2)                                      \
+  {                                                                           \
+    SHAREDI_CONTRACT(p1, cpt_oplist);                                         \
+    SHAREDI_CONTRACT(p2, cpt_oplist);                                         \
+    return *p1 == *p2;                                                        \
+  }                                                                           \
+                                                                              \
+  static inline type const *                                                  \
+  M_C(name, _cref)(const shared_t shared)                                     \
+  {                                                                           \
+    SHAREDI_CONTRACT(shared, cpt_oplist);                                     \
+    M_ASSERT(*shared != NULL);                                                \
+    type *data = (*shared)->data;                                             \
+    M_ASSERT (data != NULL);                                                  \
+    return M_CONST_CAST (type, data);                                         \
+  }                                                                           \
+                                                                              \
+  static inline type *                                                        \
+  M_C(name, _ref)(shared_t shared)                                            \
+  {                                                                           \
+    SHAREDI_CONTRACT(shared, cpt_oplist);                                     \
+    M_ASSERT(*shared != NULL);                                                \
+    type *data = (*shared)->data;                                             \
+    M_ASSERT (data != NULL);                                                  \
+    return data;                                                              \
+  }                                                                           \
   
+
+
 /********************************** SHARED RESOURCE ************************************/
 
-#define SHAREDI_RESOURCE_CONTRACT(s) do {      \
-    assert (s != NULL);                         \
-    assert (s->buffer != NULL);                 \
+#define SHAREDI_RESOURCE_CONTRACT(s) do {                                     \
+    M_ASSERT (s != NULL);                                                     \
+    M_ASSERT (s->buffer != NULL);                                             \
   } while (0)
 
 // deferred
-#define SHAREDI_RESOURCE_DEF(arg) SHAREDI_RESOURCE_DEF2 arg
+#define SHAREDI_RESOURCE_DEF_P1(arg) SHAREDI_RESOURCE_DEF_P2 arg
 
-#define SHAREDI_RESOURCE_DEF2(name, type, oplist)                       \
-                                                                        \
-  /* Create an aligned type to avoid false sharing between threads */   \
-  typedef struct M_C(name, _atype_s) {                                  \
-    atomic_uint  cpt;                                                   \
-    type         x;							\
-    M_CACHELINE_ALIGN(align, type, atomic_uint);                        \
-  } M_C(name, _atype_t);                                                \
-                                                                        \
-  typedef struct M_C(name, _s) {                                        \
-    genint_t             core;                                          \
-    M_C(name, _atype_t) *buffer;                                        \
-  } M_C(name, _t)[1];                                                   \
-                                                                        \
-  typedef struct M_C(name, _it_s) {                                     \
-    unsigned int idx;                                                   \
-    struct M_C(name, _s) *ref;                                          \
-  } M_C(name, _it_t)[1];                                                \
-                                                                        \
-  static inline void                                                    \
-  M_C(name, _init)(M_C(name, _t) s, size_t n)                           \
-  {                                                                     \
-    assert(s != NULL);                                                  \
-    assert (n > 0);                                                     \
-    s->buffer = M_CALL_REALLOC(oplist, M_C(name, _atype_t), NULL, n);   \
-    if (M_UNLIKELY (s->buffer == NULL)) {                               \
-      M_MEMORY_FULL(sizeof(M_C(name, _atype_t)) * n);                   \
-      return;                                                           \
-    }                                                                   \
-    for(size_t i = 0; i < n; i++) {                                     \
-      M_CALL_INIT(oplist, s->buffer[i].x);                              \
-      atomic_init (&s->buffer[i].cpt, 0U);                              \
-    }                                                                   \
-    genint_init(s->core, n);                                            \
-    SHAREDI_RESOURCE_CONTRACT(s);                                       \
-  }                                                                     \
-                                                                        \
-  static inline void                                                    \
-  M_C(name, _clear)(M_C(name, _t) s)                                    \
-  {                                                                     \
-    SHAREDI_RESOURCE_CONTRACT(s);                                       \
-    size_t n = genint_size(s->core);                                    \
-    for(size_t i = 0; i < n; i++) {                                     \
-      M_CALL_CLEAR(oplist, s->buffer[i].x);                             \
-    }                                                                   \
-    M_CALL_FREE(oplist, s->buffer);                                     \
-    s->buffer = NULL;                                                   \
-    genint_clear(s->core);                                              \
-  }                                                                     \
-                                                                        \
-  static inline void                                                    \
-  M_C(name, _it)(M_C(name, _it_t) it, M_C(name, _t) s)                  \
-  {                                                                     \
-    SHAREDI_RESOURCE_CONTRACT(s);                                       \
-    assert (it != NULL);                                                \
-    unsigned int idx = genint_pop(s->core);                             \
-    it->idx = idx;                                                      \
-    it->ref = s;                                                        \
-    if (M_LIKELY (idx != GENINT_ERROR)) {                               \
-      assert(atomic_load(&s->buffer[idx].cpt) == 0);                    \
-      atomic_store(&s->buffer[idx].cpt, 1U);                            \
-    }                                                                   \
-  }                                                                     \
-                                                                        \
-  static inline bool                                                    \
-  M_C(name, _end_p)(M_C(name, _it_t) it)                                \
-  {                                                                     \
-    assert (it != NULL);                                                \
-    return it->idx == GENINT_ERROR;                                     \
-  }                                                                     \
-                                                                        \
-  static inline type *                                                  \
-  M_C(name, _ref)(M_C(name, _it_t) it)                                  \
-  {                                                                     \
-    assert (it != NULL && it->ref != NULL && it->idx != GENINT_ERROR);  \
-    SHAREDI_RESOURCE_CONTRACT(it->ref);                                 \
-    return &it->ref->buffer[it->idx].x;                                 \
-  }                                                                     \
-                                                                        \
-  static inline type const *                                            \
-  M_C(name, _cref)(M_C(name, _it_t) it)                                 \
-  {                                                                     \
-    assert (it != NULL && it->ref != NULL && it->idx != GENINT_ERROR);  \
-    SHAREDI_RESOURCE_CONTRACT(it->ref);                                 \
-    return M_CONST_CAST (type, &it->ref->buffer[it->idx].x);            \
-  }                                                                     \
-                                                                        \
-  static inline void                                                    \
-  M_C(name, _end)(M_C(name, _it_t) it, M_C(name, _t) s)                 \
-  {                                                                     \
-    SHAREDI_RESOURCE_CONTRACT(s);                                       \
-    assert (it != NULL);                                                \
-    assert (it->ref == s);                                              \
-    unsigned int idx = it->idx;                                         \
-    if (M_LIKELY (idx != GENINT_ERROR)) {                               \
-      unsigned int c = atomic_fetch_sub (&it->ref->buffer[idx].cpt, 1U); \
-      if (c == 1) {                                                     \
-        genint_push(it->ref->core, idx);                                \
-      }                                                                 \
-      it->idx = GENINT_ERROR;                                           \
-    }                                                                   \
-  }                                                                     \
-                                                                        \
-  static inline void                                                    \
-  M_C(name, _it_set)(M_C(name, _it_t) itd, M_C(name, _it_t) its)        \
-  {                                                                     \
-    assert (itd != NULL && its != NULL);                                \
-    SHAREDI_RESOURCE_CONTRACT(its->ref);                                \
-    itd->ref = its->ref;                                                \
-    unsigned int idx = its->idx;                                        \
-    itd->idx = idx;                                                     \
-    if (M_LIKELY (idx != GENINT_ERROR)) {                               \
-      unsigned int c = atomic_fetch_add(&itd->ref->buffer[idx].cpt, 1U); \
-      assert (c >= 1);                                                  \
-    }                                                                   \
-  }                                                                     \
+/* Validate the oplist before going further */
+#define SHAREDI_RESOURCE_DEF_P2(name, type, oplist, shared_t, it_t)           \
+  M_IF_OPLIST(oplist)(SHAREDI_RESOURCE_DEF_P3, SHAREDI_RESOURCE_DEF_FAILURE)(name, type, oplist, shared_t, it_t)
 
+/* Stop processing with a compilation failure */
+#define SHAREDI_RESOURCE_DEF_FAILURE(name, type, oplist, shared_t, it_t)      \
+  M_STATIC_FAILURE(M_LIB_NOT_AN_OPLIST, "(SHARED_RESOURCE_DEF): the given argument is not a valid oplist: " #oplist)
+
+#define SHAREDI_RESOURCE_DEF_P3(name, type, oplist, shared_t, it_t)           \
+                                                                              \
+  /* Create an aligned type to avoid false sharing between threads */         \
+  typedef struct M_C(name, _atype_s) {                                        \
+    atomic_uint  cpt;                                                         \
+    type         x;                                                           \
+    M_CACHELINE_ALIGN(align, type, atomic_uint);                              \
+  } M_C(name, _atype_ct);                                                     \
+                                                                              \
+  typedef struct M_C(name, _s) {                                              \
+    genint_t             core;                                                \
+    M_C(name, _atype_ct) *buffer;                                             \
+  } shared_t[1];                                                              \
+                                                                              \
+  typedef struct M_C(name, _it_s) {                                           \
+    unsigned int idx;                                                         \
+    struct M_C(name, _s) *ref;                                                \
+  } it_t[1];                                                                  \
+                                                                              \
+  /* Internal Types for oplist */                                             \
+  typedef shared_t M_C(name, _ct);                                            \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _init)(shared_t s, size_t n)                                      \
+  {                                                                           \
+    M_ASSERT(s != NULL);                                                      \
+    M_ASSERT (n > 0 && n < UINT_MAX);                                         \
+    s->buffer = M_CALL_REALLOC(oplist, M_C(name, _atype_ct), NULL, n);        \
+    if (M_UNLIKELY (s->buffer == NULL)) {                                     \
+      M_MEMORY_FULL(sizeof(M_C(name, _atype_ct)) * n);                        \
+      return;                                                                 \
+    }                                                                         \
+    for(size_t i = 0; i < n; i++) {                                           \
+      M_CALL_INIT(oplist, s->buffer[i].x);                                    \
+      atomic_init (&s->buffer[i].cpt, 0U);                                    \
+    }                                                                         \
+    genint_init(s->core, (unsigned int) n);                                   \
+    SHAREDI_RESOURCE_CONTRACT(s);                                             \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _clear)(shared_t s)                                               \
+  {                                                                           \
+    SHAREDI_RESOURCE_CONTRACT(s);                                             \
+    size_t n = genint_size(s->core);                                          \
+    for(size_t i = 0; i < n; i++) {                                           \
+      M_CALL_CLEAR(oplist, s->buffer[i].x);                                   \
+    }                                                                         \
+    M_CALL_FREE(oplist, s->buffer);                                           \
+    s->buffer = NULL;                                                         \
+    genint_clear(s->core);                                                    \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _it)(it_t it, shared_t s)                                         \
+  {                                                                           \
+    SHAREDI_RESOURCE_CONTRACT(s);                                             \
+    M_ASSERT (it != NULL);                                                    \
+    unsigned int idx = genint_pop(s->core);                                   \
+    it->idx = idx;                                                            \
+    it->ref = s;                                                              \
+    if (M_LIKELY (idx != GENINT_ERROR)) {                                     \
+      M_ASSERT(atomic_load(&s->buffer[idx].cpt) == 0);                        \
+      atomic_store(&s->buffer[idx].cpt, 1U);                                  \
+    }                                                                         \
+  }                                                                           \
+                                                                              \
+  static inline bool                                                          \
+  M_C(name, _end_p)(it_t it)                                                  \
+  {                                                                           \
+    M_ASSERT (it != NULL);                                                    \
+    return it->idx == GENINT_ERROR;                                           \
+  }                                                                           \
+                                                                              \
+  static inline type *                                                        \
+  M_C(name, _ref)(it_t it)                                                    \
+  {                                                                           \
+    M_ASSERT (it != NULL && it->ref != NULL && it->idx != GENINT_ERROR);      \
+    SHAREDI_RESOURCE_CONTRACT(it->ref);                                       \
+    return &it->ref->buffer[it->idx].x;                                       \
+  }                                                                           \
+                                                                              \
+  static inline type const *                                                  \
+  M_C(name, _cref)(it_t it)                                                   \
+  {                                                                           \
+    M_ASSERT (it != NULL && it->ref != NULL && it->idx != GENINT_ERROR);      \
+    SHAREDI_RESOURCE_CONTRACT(it->ref);                                       \
+    return M_CONST_CAST (type, &it->ref->buffer[it->idx].x);                  \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _end)(it_t it, shared_t s)                                        \
+  {                                                                           \
+    SHAREDI_RESOURCE_CONTRACT(s);                                             \
+    M_ASSERT (it != NULL);                                                    \
+    M_ASSERT (it->ref == s);                                                  \
+    unsigned int idx = it->idx;                                               \
+    if (M_LIKELY (idx != GENINT_ERROR)) {                                     \
+      unsigned int c = atomic_fetch_sub (&it->ref->buffer[idx].cpt, 1U);      \
+      if (c == 1) {                                                           \
+        genint_push(it->ref->core, idx);                                      \
+      }                                                                       \
+      it->idx = GENINT_ERROR;                                                 \
+    }                                                                         \
+  }                                                                           \
+                                                                              \
+  static inline void                                                          \
+  M_C(name, _it_set)(it_t itd, it_t its)                                      \
+  {                                                                           \
+    M_ASSERT (itd != NULL && its != NULL);                                    \
+    SHAREDI_RESOURCE_CONTRACT(its->ref);                                      \
+    itd->ref = its->ref;                                                      \
+    unsigned int idx = its->idx;                                              \
+    itd->idx = idx;                                                           \
+    if (M_LIKELY (idx != GENINT_ERROR)) {                                     \
+      unsigned int c = atomic_fetch_add(&itd->ref->buffer[idx].cpt, 1U);      \
+      M_ASSERT (c >= 1);                                                      \
+    }                                                                         \
+  }                                                                           \
+
+M_END_PROTECTED_CODE
 
 #endif