Update and freeze pre-commit hooks

Closes #22

.gitignore

@@ -1,3 +1,2 @@
 .cache
-__pycache__
 build

.pre-commit-config.yaml

@@ -13,7 +13,7 @@ repos:
       - id: debug verbose check
         name: disallow checking in DEBUG_VERBOSE=1
         description: disallow checking in DEBUG_VERBOSE=1
-        entry: "^#define DEBUG_VERBOSE 1$"
+        entry: '^#define DEBUG_VERBOSE 1$'
         language: pygrep
         types: [c++]
   - repo: local
@@ -21,14 +21,11 @@ repos:
       - id: debug verbose check
         name: disallow checking in SHOW_MEMORY=1
         description: disallow checking in SHOW_MEMORY=1
-        entry: "^#define SHOW_MEMORY 1$"
+        entry: '^#define SHOW_MEMORY 1$'
         language: pygrep
         types: [c++]
-  - repo: https://github.com/shellcheck-py/shellcheck-py
-    rev: a23f6b85d0fdd5bb9d564e2579e678033debbdff # frozen: v0.10.0.1
+  - repo: https://github.com/koalaman/shellcheck-precommit
+    rev: 2491238703a5d3415bb2b7ff11388bf775372f29  # frozen: v0.10.0
     hooks:
     -   id: shellcheck
-  - repo: https://github.com/psf/black
-    rev: 552baf822992936134cbd31a38f69c8cfe7c0f05 # frozen: 24.3.0
-    hooks:
-      - id: black
+#       args: ["--severity=warning"]  # Optionally only show errors and warnings

CMakeLists.txt

@@ -1,15 +1,13 @@
 cmake_minimum_required(VERSION 3.18)
 project(
   conflict-set
-  VERSION 0.0.3
+  VERSION 0.0.2
   DESCRIPTION
     "A data structure for optimistic concurrency control on ranges of bitwise-lexicographically-ordered keys."
   HOMEPAGE_URL "https://git.weaselab.dev/weaselab/conflict-set"
   LANGUAGES C CXX)
 set(CMAKE_CXX_STANDARD 20)
 
-file(WRITE ${CMAKE_BINARY_DIR}/version.txt ${PROJECT_VERSION})
-
 include(CMakePushCheckState)
 include(CheckCXXCompilerFlag)
 include(CheckIncludeFileCXX)
@@ -130,7 +128,7 @@ endif()
 if(APPLE)
   add_custom_command(
     TARGET ${PROJECT_NAME}-static
-    PRE_LINK
+    PRE_BUILD
     COMMAND ${CMAKE_SOURCE_DIR}/privatize_symbols_macos.sh
             $<TARGET_OBJECTS:${PROJECT_NAME}-object>)
 else()
@@ -138,8 +136,7 @@ else()
     TARGET ${PROJECT_NAME}-static
     POST_BUILD
     COMMAND
-      ${CMAKE_OBJCOPY}
-      --keep-global-symbols=${CMAKE_SOURCE_DIR}/symbol-exports.txt
+      ${CMAKE_OBJCOPY} --keep-global-symbols=${CMAKE_SOURCE_DIR}/symbols.txt
       $<TARGET_FILE:${PROJECT_NAME}-static> || echo
       "Proceeding with all symbols global in static library")
 endif()
@@ -304,12 +301,8 @@ if(BUILD_TESTING)
       set(symbol_imports ${CMAKE_SOURCE_DIR}/apple-symbol-imports.txt)
     else()
       set(symbol_exports ${CMAKE_SOURCE_DIR}/symbol-exports.txt)
-      if(CMAKE_SYSTEM_PROCESSOR STREQUAL aarch64)
-        set(symbol_imports ${CMAKE_SOURCE_DIR}/aarch64-symbol-imports.txt)
-      else()
       set(symbol_imports ${CMAKE_SOURCE_DIR}/symbol-imports.txt)
     endif()
-    endif()
     add_test(
       NAME conflict_set_shared_symbols
       COMMAND
@@ -335,7 +328,6 @@ endif()
 # packaging
 
 set(CPACK_PACKAGE_CONTACT andrew@weaselab.dev)
-set(CMAKE_INSTALL_DEFAULT_COMPONENT_NAME all)
 
 set(CPACK_PACKAGE_VENDOR "Weaselab")
 set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE")
@@ -349,25 +341,6 @@ set(CPACK_RPM_FILE_NAME RPM-DEFAULT)
 
 # deb
 set(CPACK_DEBIAN_FILE_NAME DEB-DEFAULT)
-# see *-imports.txt - dependency versions need to be synced with symbol versions
-if(CMAKE_SYSTEM_PROCESSOR STREQUAL aarch64)
-  set(CPACK_DEBIAN_PACKAGE_DEPENDS "libc6 (>= 2.17)")
-else()
-  set(CPACK_DEBIAN_PACKAGE_DEPENDS "libc6 (>= 2.14)")
-endif()
-
-# macos
-if(APPLE)
-  find_program(PANDOC_EXE pandoc)
-  if(PANDOC_EXE)
-    execute_process(COMMAND ${PANDOC_EXE} ${CMAKE_SOURCE_DIR}/README.md -o
-                            ${CMAKE_BINARY_DIR}/README.txt)
-    set(CPACK_RESOURCE_FILE_README ${CMAKE_BINARY_DIR}/README.txt)
-  endif()
-  configure_file(${CMAKE_SOURCE_DIR}/LICENSE ${CMAKE_BINARY_DIR}/LICENSE.txt
-                 COPYONLY)
-  set(CPACK_RESOURCE_FILE_LICENSE ${CMAKE_BINARY_DIR}/LICENSE.txt)
-endif()
 
 include(CPack)
 
@@ -393,11 +366,8 @@ install(
   ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
   LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
   RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})
-
 install(DIRECTORY include/
         DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME})
 
 install(EXPORT ${PROJECT_NAME}Config
         DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/${PROJECT_NAME}/cmake)
-
-cpack_add_component(all)

README.md

@@ -58,27 +58,27 @@ Performance counters:
 
 ## Skip list
 
-|  ns/op |         op/s | err% | total | benchmark                           |
-| -----: | -----------: | ---: | ----: | :---------------------------------- |
-| 246.99 | 4,048,700.59 | 0.2% |  0.01 | `point reads`                       |
-| 260.16 | 3,843,784.65 | 0.1% |  0.01 | `prefix reads`                      |
-| 493.35 | 2,026,953.19 | 0.1% |  0.01 | `range reads`                       |
-| 462.05 | 2,164,289.23 | 0.6% |  0.01 | `point writes`                      |
-| 448.19 | 2,231,205.25 | 0.9% |  0.01 | `prefix writes`                     |
-| 255.83 | 3,908,845.72 | 1.5% |  0.02 | `range writes`                      |
-| 582.63 | 1,716,349.02 | 1.3% |  0.01 | `monotonic increasing point writes` |
+|               ns/op |                op/s |    err% |     total | benchmark
+|--------------------:|--------------------:|--------:|----------:|:----------
+|              246.99 |        4,048,700.59 |    0.2% |      0.01 | `point reads`
+|              260.16 |        3,843,784.65 |    0.1% |      0.01 | `prefix reads`
+|              493.35 |        2,026,953.19 |    0.1% |      0.01 | `range reads`
+|              462.05 |        2,164,289.23 |    0.6% |      0.01 | `point writes`
+|              448.19 |        2,231,205.25 |    0.9% |      0.01 | `prefix writes`
+|              255.83 |        3,908,845.72 |    1.5% |      0.02 | `range writes`
+|              582.63 |        1,716,349.02 |    1.3% |      0.01 | `monotonic increasing point writes`
 
 ## Radix tree (this implementation)
 
-|  ns/op |          op/s | err% | total | benchmark                           |
-| -----: | ------------: | ---: | ----: | :---------------------------------- |
-|  19.42 | 51,483,206.67 | 0.3% |  0.01 | `point reads`                       |
-|  58.43 | 17,115,612.57 | 0.1% |  0.01 | `prefix reads`                      |
-| 216.09 |  4,627,766.60 | 0.2% |  0.01 | `range reads`                       |
-|  28.35 | 35,267,567.72 | 0.2% |  0.01 | `point writes`                      |
-|  43.43 | 23,026,226.17 | 0.2% |  0.01 | `prefix writes`                     |
-|  50.00 | 20,000,000.00 | 0.0% |  0.01 | `range writes`                      |
-|  92.38 | 10,824,863.69 | 4.1% |  0.01 | `monotonic increasing point writes` |
+|               ns/op |                op/s |    err% |     total | benchmark
+|--------------------:|--------------------:|--------:|----------:|:----------
+|               19.42 |       51,483,206.67 |    0.3% |      0.01 | `point reads`
+|               58.43 |       17,115,612.57 |    0.1% |      0.01 | `prefix reads`
+|              216.09 |        4,627,766.60 |    0.2% |      0.01 | `range reads`
+|               28.35 |       35,267,567.72 |    0.2% |      0.01 | `point writes`
+|               43.43 |       23,026,226.17 |    0.2% |      0.01 | `prefix writes`
+|               50.00 |       20,000,000.00 |    0.0% |      0.01 | `range writes`
+|               92.38 |       10,824,863.69 |    4.1% |      0.01 | `monotonic increasing point writes`
 
 # "Real data" test
 

aarch64-symbol-imports.txt

@@ -1,8 +0,0 @@
-__stack_chk_fail@GLIBC_2.17
-__stack_chk_guard@GLIBC_2.17
-abort@GLIBC_2.17
-free@GLIBC_2.17
-malloc@GLIBC_2.17
-memcpy@GLIBC_2.17
-memmove@GLIBC_2.17
-memset@GLIBC_2.17

conflict_set.py

@@ -1,120 +0,0 @@
-import ctypes
-import enum
-import os
-
-from typing import Optional
-
-_lib = None
-for f in (
-    os.path.dirname(__file__) + "/build/radix_tree/libconflict-set.so.0",
-    os.path.dirname(__file__) + "/build/radix_tree/libconflict-set.0.dylib",
-):
-    try:
-        _lib = ctypes.cdll.LoadLibrary(f)
-    except:
-        pass
-
-if _lib is None:
-    import sys
-
-    print("Could not find libconflict-set", file=sys.stderr)
-    sys.exit(1)
-
-
-class _Key(ctypes.Structure):
-    _fields_ = [("p", ctypes.POINTER(ctypes.c_ubyte)), ("len", ctypes.c_int)]
-
-
-class ReadRange(ctypes.Structure):
-    _fields_ = [
-        ("begin", _Key),
-        ("end", _Key),
-        ("readVersion", ctypes.c_int64),
-    ]
-
-
-class WriteRange(ctypes.Structure):
-    _fields_ = [("begin", _Key), ("end", _Key)]
-
-
-_lib.ConflictSet_create.argtypes = (ctypes.c_int64,)
-_lib.ConflictSet_create.restype = ctypes.c_void_p
-
-_lib.ConflictSet_check.argtypes = (
-    ctypes.c_void_p,
-    ctypes.POINTER(ReadRange),
-    ctypes.POINTER(ctypes.c_int),
-    ctypes.c_int,
-)
-
-_lib.ConflictSet_addWrites.argtypes = (
-    ctypes.c_void_p,
-    ctypes.POINTER(WriteRange),
-    ctypes.c_int,
-    ctypes.c_int64,
-)
-
-_lib.ConflictSet_setOldestVersion.argtypes = (ctypes.c_void_p, ctypes.c_int64)
-
-_lib.ConflictSet_destroy.argtypes = (ctypes.c_void_p,)
-
-
-class Result(enum.Enum):
-    COMMIT = 0
-    CONFLICT = 1
-    TOO_OLD = 2
-
-
-def write(begin: bytes, end: Optional[bytes] = None) -> WriteRange:
-    b = (ctypes.c_ubyte * len(begin))()
-    b.value = begin
-    if end is None:
-        e = (ctypes.c_ubyte * 0)()
-        e.value = b""
-    else:
-        e = (ctypes.c_ubyte * len(end))()
-        e.value = end
-    return WriteRange(_Key(b, len(b)), _Key(e, len(e)))
-
-
-def read(version: int, begin: bytes, end: Optional[bytes] = None) -> ReadRange:
-    b = (ctypes.c_ubyte * len(begin))()
-    b.value = begin
-    if end is None:
-        e = (ctypes.c_ubyte * 0)()
-        e.value = b""
-    else:
-        e = (ctypes.c_ubyte * len(end))()
-        e.value = end
-    return ReadRange(_Key(b, len(b)), _Key(e, len(e)), version)
-
-
-class ConflictSet:
-    def __init__(self, version: int = 0) -> None:
-        self.p = _lib.ConflictSet_create(version)
-
-    def addWrites(self, version: int, *writes: WriteRange):
-        _lib.ConflictSet_addWrites(
-            self.p, (WriteRange * len(writes))(*writes), len(writes), version
-        )
-
-    def check(self, *reads: ReadRange) -> list[Result]:
-        r = (ctypes.c_int * len(reads))()
-        _lib.ConflictSet_check(self.p, *reads, r, 1)
-        return [Result(x) for x in r]
-
-    def setOldestVersion(self, version: int) -> None:
-        _lib.ConflictSet_setOldestVersion(self.p, version)
-
-    def __enter__(self):
-        return self
-
-    def close(self) -> None:
-        if self.p is not None:
-            _lib.ConflictSet_destroy(self.p)
-            self.p = None
-
-    def __exit__(self, exception_type, exception_value, exception_traceback):
-        if self.p is not None:
-            _lib.ConflictSet_destroy(self.p)
-            self.p = None

package_macos.sh

@@ -1,33 +0,0 @@
-#!/bin/bash
-
-set -euxo pipefail
-
-umask 022
-
-SRC_DIR="${0%/*}"
-BUILD_ARM="$(mktemp -d -t conflict-set-arm)"
-BUILD_X86="$(mktemp -d -t conflict-set-x86)"
-
-cmake_args=(-DCMAKE_CXX_FLAGS=-DNVALGRIND -DCPACK_PACKAGING_INSTALL_PREFIX=/usr/local)
-
-cmake -S"$SRC_DIR" -B"$BUILD_ARM" -DCMAKE_OSX_ARCHITECTURES=arm64 "${cmake_args[@]}"
-cmake --build "$BUILD_ARM" --target conflict-set --target conflict-set-static
-
-cmake -S"$SRC_DIR" -B"$BUILD_X86" -DCMAKE_OSX_ARCHITECTURES=x86_64 "${cmake_args[@]}"
-cmake --build "$BUILD_X86" --target conflict-set --target conflict-set-static
-
-VERSION="$(cat "$BUILD_ARM/version.txt")"
-
-lipo -create "$BUILD_ARM/radix_tree/libconflict-set.$VERSION.dylib" "$BUILD_X86/radix_tree/libconflict-set.$VERSION.dylib" -output "libconflict-set.$VERSION.dylib.tmp"
-lipo -create "$BUILD_ARM"/libconflict-set-static.a "$BUILD_X86"/libconflict-set-static.a -output libconflict-set-static.a.tmp
-
-mv "libconflict-set.$VERSION.dylib.tmp" "$BUILD_ARM/radix_tree/libconflict-set.$VERSION.dylib"
-mv libconflict-set-static.a.tmp "$BUILD_ARM/libconflict-set-static.a"
-
-pushd "$BUILD_ARM"
-cpack -G productbuild
-popd
-
-mv "$BUILD_ARM/conflict-set-$VERSION-Darwin.pkg" .
-
-rm -rf  "$BUILD_ARM" "$BUILD_X86"

privatize_symbols_macos.sh

@@ -2,7 +2,5 @@
 
 # This has the effect of making visibility=hidden symbols private in object files
 for obj in "$@" ; do
-  ld -r "$obj" -o "$obj.tmp"
-  touch -r "$obj" "$obj.tmp"
-  mv "$obj.tmp" "$obj"
+  ld -r "$obj" -o "$obj.tmp" && mv "$obj.tmp" "$obj"
 done

symbol-imports.txt

@@ -1,9 +0,0 @@
-_GLOBAL_OFFSET_TABLE_
-__stack_chk_fail@GLIBC_2.4
-__tls_get_addr@GLIBC_2.3
-abort@GLIBC_2.2.5
-free@GLIBC_2.2.5
-malloc@GLIBC_2.2.5
-memcpy@GLIBC_2.14
-memmove@GLIBC_2.2.5
-memset@GLIBC_2.2.5

test_conflict_set.py

@@ -1,9 +0,0 @@
-from conflict_set import *
-
-
-def test_conflict_set():
-    with ConflictSet() as cs:
-        cs.addWrites(1, write(b""))
-        assert cs.check(read(0, b"")) == [Result.CONFLICT]
-        cs.setOldestVersion(1)
-        assert cs.check(read(0, b"")) == [Result.TOO_OLD]

test_symbols.sh

@@ -7,7 +7,7 @@ set -euo pipefail
 diff -u <(sort < "$2") <(nm "$1" | grep " T " | cut -f3 -d " " | sort)
 ec=0
 for symbol in $(nm "$1" | grep " U " | sed 's/ U //') ; do
-    if ! grep --fixed-strings "$symbol" "$3" > /dev/null ; then
+    if ! grep "$symbol" "$3" > /dev/null ; then
         echo "Imported symbol $symbol not present in $3"
         ec=1
     fi