From b6ccffe8099dfdfdaf29870924dd29e0d1cb27f5 Mon Sep 17 00:00:00 2001 From: Greg Burd Date: Tue, 2 Apr 2024 20:41:55 -0400 Subject: [PATCH] import as C++ --- .clang-format | 197 ++++ .clang-tidy | 25 + .envrc | 5 + .gitignore | 120 +++ LICENSE | 21 + README.md | 90 ++ examples/main.c | 205 ++++ flake.nix | 51 + include/popcount.h | 72 ++ include/sparsemap.h | 0 main | Bin 0 -> 126264 bytes src/sparsemap.c | 1021 ++++++++++++++++++++ tests/munit.c | 2255 +++++++++++++++++++++++++++++++++++++++++++ 13 files changed, 4062 insertions(+) create mode 100644 .clang-format create mode 100644 .clang-tidy create mode 100644 .envrc create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 examples/main.c create mode 100644 flake.nix create mode 100644 include/popcount.h create mode 100644 include/sparsemap.h create mode 100755 main create mode 100644 src/sparsemap.c create mode 100644 tests/munit.c diff --git a/.clang-format b/.clang-format new file mode 100644 index 0000000..09db5d1 --- /dev/null +++ b/.clang-format @@ -0,0 +1,197 @@ +# Basic .clang-format +--- +BasedOnStyle: WebKit +AlignAfterOpenBracket: DontAlign +AlignConsecutiveAssignments: false +AlignConsecutiveDeclarations: false +AlignEscapedNewlines: Left +AlignOperands: false +AlignTrailingComments: true +AllowAllArgumentsOnNextLine: false +AllowAllParametersOfDeclarationOnNextLine: false +AllowShortBlocksOnASingleLine: Never +AllowShortCaseLabelsOnASingleLine: false +AllowShortFunctionsOnASingleLine: InlineOnly +AllowShortIfStatementsOnASingleLine: Never +AllowShortLoopsOnASingleLine: false +AlwaysBreakAfterReturnType: TopLevelDefinitions +AlwaysBreakBeforeMultilineStrings: false +AlwaysBreakTemplateDeclarations: MultiLine +BinPackArguments: true +BinPackParameters: true +BreakBeforeBinaryOperators: None +BreakBeforeBraces: WebKit +BreakBeforeTernaryOperators: false +# TODO: BreakStringLiterals can cause very strange formatting so turn it off? +BreakStringLiterals: false +# Prefer: +# some_var = function(arg1, +# arg2) +# over: +# some_var = +# function(arg1, arg2) +PenaltyBreakAssignment: 100 +# Prefer: +# some_long_function(arg1, arg2 +# arg3) +# over: +# some_long_function( +# arg1, arg2, arg3) +PenaltyBreakBeforeFirstCallParameter: 100 +CompactNamespaces: true +DerivePointerAlignment: false +DisableFormat: false +ForEachMacros: + - ARB_ARRFOREACH + - ARB_ARRFOREACH_REVWCOND + - ARB_ARRFOREACH_REVERSE + - ARB_FOREACH + - ARB_FOREACH_FROM + - ARB_FOREACH_SAFE + - ARB_FOREACH_REVERSE + - ARB_FOREACH_REVERSE_FROM + - ARB_FOREACH_REVERSE_SAFE + - BIT_FOREACH_ISCLR + - BIT_FOREACH_ISSET + - CPU_FOREACH + - CPU_FOREACH_ISCLR + - CPU_FOREACH_ISSET + - FOREACH_THREAD_IN_PROC + - FOREACH_PROC_IN_SYSTEM + - FOREACH_PRISON_CHILD + - FOREACH_PRISON_DESCENDANT + - FOREACH_PRISON_DESCENDANT_LOCKED + - FOREACH_PRISON_DESCENDANT_LOCKED_LEVEL + - MNT_VNODE_FOREACH_ALL + - MNT_VNODE_FOREACH_ACTIVE + - RB_FOREACH + - RB_FOREACH_FROM + - RB_FOREACH_SAFE + - RB_FOREACH_REVERSE + - RB_FOREACH_REVERSE_FROM + - RB_FOREACH_REVERSE_SAFE + - SLIST_FOREACH + - SLIST_FOREACH_FROM + - SLIST_FOREACH_FROM_SAFE + - SLIST_FOREACH_SAFE + - SLIST_FOREACH_PREVPTR + - SPLAY_FOREACH + - LIST_FOREACH + - LIST_FOREACH_FROM + - LIST_FOREACH_FROM_SAFE + - LIST_FOREACH_SAFE + - STAILQ_FOREACH + - STAILQ_FOREACH_FROM + - STAILQ_FOREACH_FROM_SAFE + - STAILQ_FOREACH_SAFE + - TAILQ_FOREACH + - TAILQ_FOREACH_FROM + - TAILQ_FOREACH_FROM_SAFE + - TAILQ_FOREACH_REVERSE + - TAILQ_FOREACH_REVERSE_FROM + - TAILQ_FOREACH_REVERSE_FROM_SAFE + - TAILQ_FOREACH_REVERSE_SAFE + - TAILQ_FOREACH_SAFE + - VM_MAP_ENTRY_FOREACH + - VM_PAGE_DUMP_FOREACH +IndentCaseLabels: false +IndentPPDirectives: None +Language: Cpp +NamespaceIndentation: None +PointerAlignment: Right +ContinuationIndentWidth: 4 +IndentWidth: 4 +TabWidth: 4 +ColumnLimit: 160 +UseTab: Never +SpaceAfterCStyleCast: false +IncludeBlocks: Regroup +IncludeCategories: + - Regex: '^\"opt_.*\.h\"' + Priority: 1 + SortPriority: 10 + - Regex: '^' + Priority: 2 + SortPriority: 20 + - Regex: '^' + Priority: 2 + SortPriority: 21 + - Regex: '^' + Priority: 2 + SortPriority: 22 + - Regex: '^' + Priority: 2 + SortPriority: 23 + - Regex: '^' + Priority: 3 + SortPriority: 30 + - Regex: '^ + bugprone-*, + clang-analyzer-*, + google-*, + misc-*, + modernize-*, + performance-*, + portability-*, + -bugprone-branch-clone, + -bugprone-easily-swappable-parameters, + -bugprone-macro-parentheses, + -bugprone-narrowing-conversions, + -bugprone-not-null-terminated-result, + -bugprone-reserved-identifier, + -bugprone-sizeof-expression, + -clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling, + -clang-analyzer-security.insecureAPI.strcpy, + -google-readability-todo, + -misc-unused-parameters, + -misc-no-recursion, + -performance-no-int-to-ptr, + -bugprone-assignment-in-if-condition, + +... diff --git a/.envrc b/.envrc new file mode 100644 index 0000000..f59b4d9 --- /dev/null +++ b/.envrc @@ -0,0 +1,5 @@ +if ! has nix_direnv_version || ! nix_direnv_version 3.0.4; then + source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/3.0.4/direnvrc" "sha256-DzlYZ33mWF/Gs8DDeyjr8mnVmQGx7ASYqA5WlxwvBG4=" +fi +watch_file devShell.nix shell.nix flake.nix +use flake || use nix diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..fc91bf8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,120 @@ +libsparesemap.a +libsparesemap.so +**/*.o +tests/test +examples/main +.cache +hints.txt +tmp/ +git.diff +.direnv +.vscode/.ropeproject +.vscode/ipch +.codelite/ +.cmaketools.json +*.tags +*.dll +build/ +cmake-build* +.cmake_dirty +Makefile +Testing/ +compile_commands.json +.tern* +*.iml +*.dat +*.fsm +*.db + +# Created by https://www.gitignore.io/api/jetbrains +# Edit at https://www.gitignore.io/?templates=jetbrains + +### JetBrains ### +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 + +# User-specific stuff +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml +.idea/**/libraries + +# Gradle and Maven with auto-import +# When using Gradle or Maven with auto-import, you should exclude module files, +# since they will be recreated, and may cause churn. Uncomment if using +# auto-import. +# .idea/modules.xml +# .idea/*.iml +# .idea/modules +# *.iml +# *.ipr + +# CMake +cmake-build-*/ + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# File-based project format +*.iws + +# IntelliJ +out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + +# Editor-based Rest Client +.idea/httpRequests + +# Android studio 3.1+ serialized cache file +.idea/caches/build_file_checksums.ser + +### JetBrains Patch ### +# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721 + +# *.iml +# modules.xml +# .idea/misc.xml +# *.ipr + +# Sonarlint plugin +.idea/**/sonarlint/ + +# SonarQube Plugin +.idea/**/sonarIssues.xml + +# Markdown Navigator plugin +.idea/**/markdown-navigator.xml +.idea/**/markdown-navigator/ + +# End of https://www.gitignore.io/api/jetbrains diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9a2185c --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2014 Christoph Rupp + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..4788f12 --- /dev/null +++ b/README.md @@ -0,0 +1,90 @@ + +`sparsemap` is a sparse, compressed bitmap. In best case, it can store 2048 +bits in just 8 bytes. In worst case, it stores the 2048 bits uncompressed and +requires additional 8 bytes of overhead. + +The "best" case happens when large consecutive sequences of the bits are +either set ("1") or not set ("0"). If your numbers are consecutive 64bit +integers then sparsemap can compress up to 16kb in just 8 bytes. + +## How does it work? + +On the lowest level, bits are stored in BitVectors (a uint32_t or uint64_t). + +Each BitVector has an additional descriptor (2 bits). All descriptors are +stored in a single Word which is prepended to the BitVectors. (The descriptor +Word and the BitVectors have the same size.) The descriptor of a BitVector +specifies whether the BitVector consists only of set bits ("1"), unset +bits ("0") or has a mixed payload. In the first and second case the +BitVector is not stored. + +An example shows a sequence of 4 x 16 bits (here, each BitVector and the +Descriptor word has 16 bits): + + Descriptor: + 00 00 00 00 11 00 11 10 + ^^ ^^ ^^ ^^-- BitVector #0 - #3 are "0000000000000000" + ^^-- BitVector #4 is "1111111111111111" + ^^-- BitVector #5 is "0000000000000000" + ^^-- BitVector #7 is "1111111111111111" + ^^-- BitVector #7 is "0110010101111001" + +Since the first 7 BitVectors are either all "1" or "0" they are not stored. +The actual memory sequence looks like this: + + 0000000011001110 0110010101111001 + +Instead of storing 8 Words (16 bytes), we only store 2 Words (2 bytes): one +for the Descriptor, one for last BitVector #7. + +Since such a construct (it's called a MiniMap) has a limited capacity, another +structure is created on top of it, a `Sparsemap`. The Sparsemap stores a list +of MiniMaps, and for each MiniMap it stores the absolute address. I.e. if +the user sets bit 0 and bit 10000, and the MiniMap capacity is 2048, the +Sparsemap creates two MiniMaps. The first starts at offset 0, the second starts +at offset 8192. + +# Usage instructions + +The file `main.cc` has example code. Here is a small excerpt: + + // we need a buffer to store the SparseMap + unsigned char buffer[1024]; + + sparsemap::SparseMap sm; + sm.create(buffer, sizeof(buffer)); + + // after initialization, the used size is just 4 bytes (sizeof(uint32_t)) + assert(sm.get_size() == sizeof(uint32_t)); + + // set the first bit + sm.set(0, true); + + // check that the first bit was set + assert(sm.is_set(0) == true); + + // unset the first bit + assert(sm.is_set(1) == false); + + // check that the first bit is now no longer set + sm.set(0, false); + +## Final words + +This bitmap implementation has very efficient compression when using on long +sequences of set (or unset) bits. I.e. with a word size of 64bit, and a +payload of consecutive numbers without gaps, the payload of 2048 x +sizeof(uint64_t) = 16kb can be stored in just 8 bytes! + +However, if the sequence is not consecutive and has gaps, it's possible that +the compression is completely inefficient, and the size basically is identical +to an uncompressed bitvector (even higher because a few bytes are required for +metadata). In such cases, other compression schemes are more efficient (i.e. +http://lemire.me/blog/archives/2008/08/20/the-mythical-bitmap-index/). + +This library was originally created for hamsterdb [http://hamsterdb.com] in +order to compress the key indices. For several technical reasons this turned +out to be impossible, though. (If you're curious then feel free to drop +me a mail.) I'm releasing it as open source, hoping that others can make good +use of it. + diff --git a/examples/main.c b/examples/main.c new file mode 100644 index 0000000..b2003b9 --- /dev/null +++ b/examples/main.c @@ -0,0 +1,205 @@ +#include +#include +#include + +using namespace sparsemap; + +// +// this code serves as a sample but also as a unittest. +// +int main() { + int size = 4; + setbuf(stdout, 0); // disable printf() buffering + printf("Please wait a moment."); +#if 1 + uint8_t buffer[1024]; + uint8_t buffer2[1024]; + + SparseMap sm; + sm.create(buffer, sizeof(buffer)); + assert(sm.get_size() == size); + sm.set(0, true); + assert(sm.get_size() == size + 4 + 8 + 8); + assert(sm.is_set(0) == true); + assert(sm.get_size() == size + 4 + 8 + 8); + assert(sm.is_set(1) == false); + sm.set(0, false); + assert(sm.get_size() == size); + + sm.clear(); + sm.set(64, true); + assert(sm.is_set(64) == true); + assert(sm.get_size() == size + 4 + 8 + 8); + + sm.clear(); + printf("."); + + // set [0..100000] + for (int i = 0; i < 100000; i++) { + assert(sm.is_set(i) == false); + sm.set(i, true); + if (i > 5) { + for (int j = i - 5; j <= i; j++) + assert(sm.is_set(j) == true); + } + + assert(sm.is_set(i) == true); + } + + printf("."); + + for (int i = 0; i < 100000; i++) + assert(sm.is_set(i) == true); + + // unset [0..10000] + for (int i = 0; i < 10000; i++) { + assert(sm.is_set(i) == true); + sm.set(i, false); + assert(sm.is_set(i) == false); + } + + for (int i = 0; i < 10000; i++) + assert(sm.is_set(i) == false); + + sm.clear(); + printf("."); + + // set [10000..0] + for (int i = 10000; i >= 0; i--) { + assert(sm.is_set(i) == false); + sm.set(i, true); + assert(sm.is_set(i) == true); + } + + for (int i = 10000; i >= 0; i--) + assert(sm.is_set(i) == true); + printf("."); + + // open and compare + SparseMap sm2; + sm2.open(buffer, sizeof(buffer)); + for (int i = 0; i < 10000; i++) + assert(sm2.is_set(i) == sm.is_set(i)); + + // unset [10000..0] + for (int i = 10000; i >= 0; i--) { + assert(sm.is_set(i) == true); + sm.set(i, false); + assert(sm.is_set(i) == false); + } + + for (int i = 10000; i >= 0; i--) + assert(sm.is_set(i) == false); + + printf("."); + sm.clear(); + + sm.set(0, true); + sm.set(2048 * 2 + 1, true); + assert(sm.is_set(0) == true); + assert(sm.is_set(2048 * 2 + 0) == false); + assert(sm.is_set(2048 * 2 + 1) == true); + assert(sm.is_set(2048 * 2 + 2) == false); + sm.set(2048, true); + assert(sm.is_set(0) == true); + assert(sm.is_set(2047) == false); + assert(sm.is_set(2048) == true); + assert(sm.is_set(2049) == false); + assert(sm.is_set(2048 * 2 + 2) == false); + assert(sm.is_set(2048 * 2 + 0) == false); + assert(sm.is_set(2048 * 2 + 1) == true); + assert(sm.is_set(2048 * 2 + 2) == false); + + sm.clear(); + printf("."); + + for (int i = 0; i < 100000; i++) + sm.set(i, true); + for (int i = 0; i < 100000; i++) + assert(sm.select(i) == (unsigned)i); + + sm.clear(); + printf("."); + + for (int i = 1; i < 513; i++) + sm.set(i, true); + for (int i = 1; i < 513; i++) + assert(sm.select(i - 1) == (unsigned)i); + + sm.clear(); + printf("."); + + for (int i = 0; i < 8; i++) + sm.set(i * 10, true); + for (int i = 0; i < 8; i++) + assert(sm.select(i) == (unsigned)i * 10); + + // split and move, aligned to MiniMap capacity + sm2.create(buffer2, sizeof(buffer2)); + sm.clear(); + for (int i = 0; i < 2048 * 2; i++) + sm.set(i, true); + sm.split(2048, &sm2); + for (int i = 0; i < 2048; i++) { + assert(sm.is_set(i) == true); + assert(sm2.is_set(i) == false); + } + for (int i = 2048; i < 2048 * 2; i++) { + assert(sm.is_set(i) == false); + assert(sm2.is_set(i) == true); + } + printf("."); + + // split and move, aligned to BitVector capacity + sm2.create(buffer2, sizeof(buffer2)); + sm.clear(); + for (int i = 0; i < 2048 * 3; i++) + sm.set(i, true); + sm.split(64, &sm2); + for (int i = 0; i < 64; i++) { + assert(sm.is_set(i) == true); + assert(sm2.is_set(i) == false); + } + for (int i = 64; i < 2048 * 3; i++) { + assert(sm.is_set(i) == false); + assert(sm2.is_set(i) == true); + } + + printf("ok\n"); +#else + // + // This code was used to create the lookup table for + // sparsemap::MiniMap<>::calc_vector_size() + // + printf(" "); + for (unsigned int ch = 0; ch <= 0xff; ch++) { + if (ch > 0 && ch % 16 == 0) + printf("\n "); + + /* + // check if value is invalid (contains 2#01) + if ((ch & (0x3 << 0)) >> 0 == 1 + || (ch & (0x3 << 2)) >> 2 == 1 + || (ch & (0x3 << 4)) >> 4 == 1 + || (ch & (0x3 << 6)) >> 6 == 1) { + //printf("%d: -1\n", (int)ch); + printf(" -1,"); + continue; + } + */ + + // count all occurrences of 2#10 + int size = 0; + if ((ch & (0x3 << 0)) >> 0 == 2) + size++; + if ((ch & (0x3 << 2)) >> 2 == 2) + size++; + if ((ch & (0x3 << 4)) >> 4 == 2) + size++; + if ((ch & (0x3 << 6)) >> 6 == 2) + size++; + //printf("%u: %d\n", (unsigned int)ch, size); + printf(" %d,", size); + } +#endif +} diff --git a/flake.nix b/flake.nix new file mode 100644 index 0000000..2d8d35f --- /dev/null +++ b/flake.nix @@ -0,0 +1,51 @@ +{ + description = "A Concurrent Skip List library for key/value pairs."; + + inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable"; + inputs.flake-utils.url = "github:numtide/flake-utils"; + + outputs = + { self + , nixpkgs + , flake-utils + , ... + }: + flake-utils.lib.eachDefaultSystem (system: + let +# pkgs = nixpkgs.legacyPackages.${system}; + pkgs = import nixpkgs { + inherit system; + config = { allowUnfree = true; }; + }; + in + { + devShells.default = pkgs.mkShell { + packages = with pkgs; [ + autoconf + bashInteractive + clang-tools + ed + gdb + graphviz-nox + meson + python311Packages.rbtools + ]; + }; + buildInputs = with pkgs; [ + glibc + ]; + nativeBuildInputs = with pkgs.buildPackages; [ + act + binutils + coreutils + gcc + gettext + libtool + m4 + make + perl + pkg-config + ripgrep + ]; + }); +} diff --git a/include/popcount.h b/include/popcount.h new file mode 100644 index 0000000..08a1926 --- /dev/null +++ b/include/popcount.h @@ -0,0 +1,72 @@ +/* + * + * from https://github.com/efficient/rankselect/popcount.h + * + * licensed under Apache 2 + */ + +/* -*- Mode: C++; c-basic-offset: 4; indent-tabs-mode: nil -*- */ +#ifndef _FASTRANK_POPCOUNT_H_ +#define _FASTRANK_POPCOUNT_H_ + +#include +#include + +#define L8 0x0101010101010101ULL // Every lowest 8th bit set: 00000001... +#define G2 0xAAAAAAAAAAAAAAAAULL // Every highest 2nd bit: 101010... +#define G4 0x3333333333333333ULL // 00110011 ... used to group the sum of 4 bits. +#define G8 0x0F0F0F0F0F0F0F0FULL +#define H8 0x8080808080808080ULL +#define L9 0x0040201008040201ULL +#define H9 (L9 << 8) +#define L16 0x0001000100010001ULL +#define H16 0x8000800080008000ULL + +#define ONES_STEP_4 ( 0x1111111111111111ULL ) +#define ONES_STEP_8 ( 0x0101010101010101ULL ) +#define ONES_STEP_9 ( 1ULL << 0 | 1ULL << 9 | 1ULL << 18 | 1ULL << 27 | 1ULL << 36 | 1ULL << 45 | 1ULL << 54 ) +#define ONES_STEP_16 ( 1ULL << 0 | 1ULL << 16 | 1ULL << 32 | 1ULL << 48 ) +#define MSBS_STEP_4 ( 0x8ULL * ONES_STEP_4 ) +#define MSBS_STEP_8 ( 0x80ULL * ONES_STEP_8 ) +#define MSBS_STEP_9 ( 0x100ULL * ONES_STEP_9 ) +#define MSBS_STEP_16 ( 0x8000ULL * ONES_STEP_16 ) +#define INCR_STEP_8 ( 0x80ULL << 56 | 0x40ULL << 48 | 0x20ULL << 40 | 0x10ULL << 32 | 0x8ULL << 24 | 0x4ULL << 16 | 0x2ULL << 8 | 0x1 ) + +#define ONES_STEP_32 ( 0x0000000100000001ULL ) +#define MSBS_STEP_32 ( 0x8000000080000000ULL ) + +#define COMPARE_STEP_8(x,y) ( ( ( ( ( (x) | MSBS_STEP_8 ) - ( (y) & ~MSBS_STEP_8 ) ) ^ (x) ^ ~(y) ) & MSBS_STEP_8 ) >> 7 ) +#define LEQ_STEP_8(x,y) ( ( ( ( ( (y) | MSBS_STEP_8 ) - ( (x) & ~MSBS_STEP_8 ) ) ^ (x) ^ (y) ) & MSBS_STEP_8 ) >> 7 ) + +#define UCOMPARE_STEP_9(x,y) ( ( ( ( ( ( (x) | MSBS_STEP_9 ) - ( (y) & ~MSBS_STEP_9 ) ) | ( x ^ y ) ) ^ ( x | ~y ) ) & MSBS_STEP_9 ) >> 8 ) +#define UCOMPARE_STEP_16(x,y) ( ( ( ( ( ( (x) | MSBS_STEP_16 ) - ( (y) & ~MSBS_STEP_16 ) ) | ( x ^ y ) ) ^ ( x | ~y ) ) & MSBS_STEP_16 ) >> 15 ) +#define ULEQ_STEP_9(x,y) ( ( ( ( ( ( (y) | MSBS_STEP_9 ) - ( (x) & ~MSBS_STEP_9 ) ) | ( x ^ y ) ) ^ ( x & ~y ) ) & MSBS_STEP_9 ) >> 8 ) +#define ULEQ_STEP_16(x,y) ( ( ( ( ( ( (y) | MSBS_STEP_16 ) - ( (x) & ~MSBS_STEP_16 ) ) | ( x ^ y ) ) ^ ( x & ~y ) ) & MSBS_STEP_16 ) >> 15 ) +#define ZCOMPARE_STEP_8(x) ( ( ( x | ( ( x | MSBS_STEP_8 ) - ONES_STEP_8 ) ) & MSBS_STEP_8 ) >> 7 ) + +// Population count of a 64 bit integer in SWAR (SIMD within a register) style +// From Sebastiano Vigna, "Broadword Implementation of Rank/Select Queries" +// http://sux.dsi.unimi.it/paper.pdf p4 +// This variant uses multiplication for the last summation instead of +// continuing the shift/mask/addition chain. +inline int suxpopcount(uint64_t x) { + // Step 1: 00 - 00 = 0; 01 - 00 = 01; 10 - 01 = 01; 11 - 01 = 10; + x = x - ((x & G2) >> 1); + // step 2: add 2 groups of 2. + x = (x & G4) + ((x >> 2) & G4); + // 2 groups of 4. + x = (x + (x >> 4)) & G8; + // Using a multiply to collect the 8 groups of 8 together. + x = x * L8 >> 56; + return x; +} + +// Default to using the GCC builtin popcount. On architectures +// with -march popcnt, this compiles to a single popcnt instruction. +#ifndef popcount +# define popcount __builtin_popcountll +#else +# define popcount suxpopcount +#endif + +#endif /* _FASTRANK_POPCOUNT_H_ */ diff --git a/include/sparsemap.h b/include/sparsemap.h new file mode 100644 index 0000000..e69de29 diff --git a/main b/main new file mode 100755 index 0000000000000000000000000000000000000000..83e3a1b140a2d512102cb93de5b970a8ea13e96e GIT binary patch literal 126264 zcmeFa33yaR_BVWQcZY=BB;5%K2^dHR!xGknO@e?O2y$CH5(LBrBoMZ+n+0$g1d}Lj zYz0S09rtZU$7Ng*9ha~Oh>8dzg|PEDi;fMFFT-j%!|4-@osXBArrEjOI&<lJ`7%RQ?OgMyI{9K) zwCbA2#~SKB$sWm*OtW*FF4A6!!fPdp-p(&bQgAzO$w%A7El~Kl1&Ytky|D`3!^&+w znu~lH7GH+NXXif4o_22AlQv;mY}s?M(}x=CDp#MHH9F9XNIW**V;0|I7QLN&g-X-x z+_wGrFREtz-?Ud^@f|o{2|jSXPYQN^nF4EeZnrlMe6-7d`q;yKw$6nlJdn%1`QZAWLaL>f@w>KR8$TbIJ^JcKC|bS zPcQ4!zwdw{eFhHfhf2TsGy2RgUs%1Y&$1zd`wSk~w{lV6{z@?WLsz3OjyY?h=2)RM z5N5ZlYr53i0>;N-)ona!**Dh7&xb=7FC|S&MxJVwTV}RBQUIiEw}qtp(FB|}luiD2 zNdLP><`D>}gXK0tZu?XsYSf2QBSA3Ar&%PAoh;OUl>G}-)V=j{008RT`eA?nh`#(d z@Uh2%_Xhlrz({|jfBbRa&f~y;K92mY$AMpQ9Qdf?z#l#i zoMY@o`rR{i>g)xJ7EZ0KnpROYb*eV?{IkYada+jGZ$BtFIou1>}AWQ zE}mIYxoF|E`Q=p?PhFB{QO~NFc?{*mg-gp9&X{`k%*yHoGeNVsqI_Z1tf^&l=4lIN zE?5Ai0i0G@ITKx(HLZL;Y77Nd=N3#WU#L}9%~(`jr7f8#}wUZ&tfCct z9;hKN9O<8$-*-SuaNqvD{e5x2Sp++JS@zqtk6Ui%2Ys|DQJ3KFb6&;o9+NrXSv0-i{K^{i_F zx3+kKX=nkr*H9w1wt%->FLtzm|4}@*nmdu5u)qlmoUp+E>lXOI-T8=FvoFr9k7=B$ zX=YtRm7{rwS+gl_qv+B+XehwVU5DY*o#jJ`^*O{f?rFx;wLj|&{f#@M-jj7MO^ppw z@4`BlfX2t9-jQ{N{>Hncp29kptj5(+k7u1rRpSb&J6PwE(70IYM=nI2OF?6))W2t) zOITxx)W2q(OG2Yh>YuXCrJylS>hH78C7{uZdf}w}gN5f5PAr@-alE;59|g}a>s?)Y zfWQpa=9~)vZ1V`1%+TZfxTTlbJ=1vaeWQ03l-7sqox!iT!TI3%D{d2TmcyR||4j;mT1A+{9-DdPl z2*OW+skXsgdm|uV2)`AfnE}X)_!$m;UQxKpuqu*BZ2SkUe-FsE4$#a{F&K55^C znqCgf79^;%Hv@uwC{gf0tNo*}Bki*DAutdB0(zkH7+zs|zn2)w^$lkTtCtov8~de@b@=B|_Rqq6zmgm3$;xtV@# z$t||{Mu3kp&6U5Ar+QERH?!PXMUnQqT6EWgE`O)R{8)MfAEWSf;mbaeg)V$_I53!f*pD3}rc{8y#7)!!Q}Irm}Q6-c>MC#YnRR49_# z=^*jf?9(eZwdnUm3poW7$E^8Aul!0H&i^J5nxB&wUV_%BQ5<|c=E2k1&7zzxJYg_`s{ozE&QPwC7ZVESJniUS&0w*Tq(TOSE13!;Kbxqu4Q`fA|GBpk+$T2Ic0Mp0=kK1wG*-X`DaU(?X6iS{M*D zbw*ff#UVbu$bB!{%C*``A<$wBr&^Sm1Uf9rW;igtyqmC7HM@zrNE06@n%ZpAG-Eoj ziOm*cuNI8q$1Tc11nNp!_%@5OA2=iJUS$Cb2(;C%uz;fowAG$s$(#s3jj)>*Ac<9@9>dYDY&Hu0}hUoGs%6eJz|VZHC=-Z^K~FiRYzi)n0yc z{x^}X1cyl5;WcRL*zUxKKf)Qvtof~^`bz{h@Tlms1zsK~*yFDID#v)k;U^Vhy?gv; z#tOCM&oFzbJ%GDzm3Yr4?hNu9E|^j{xo}G1g@sc$nxVwtX;{5_QSs2ARVYK!L1f`r zN(v>;C3>Jjmn-x>qQeITeJ0U;75WT?ex2x76uLLj-4(i*Le~)e4~0%7dZlOOj5kL=7=xxjm7iT!>?p+7?w9<0!} z5S^jWH!JkyQ-Dra=u3#kf=lj;6?!$Y@Sz{2-xm;#C5`Cw6}mII-&5#eM6XupQx*C} zWZ~x&x)afB6gpF(hfwod75eBfpl?v<-%v)sCzAUzh5m$SkhATN6?!nyQxv*^=(`m9 zC50YI^azE%o9Me0`Ywfjp6D!vzJloc6ndpXzlSWWDRddp3l)00LN6H%^xhxDEJZ{w zQs_|%y_Dz;3f-0Hr3#&+&^c`TUWIN$^yLa2qtMgHU8~SvoeK0-3jHO@Fw1nJXDako zqUR~}7KMHkLc*sj^n*mtSLg>6`olp$cUS1EiC&=4L4~d+I!>YI5j{qs=PL9!$ij`^ zOTPm|k5=e275ZMHw<&ZVq9-eKZ-uTU`XQjL{n1?rZVZZ#VUuHTavLpw_!gnzxpNi! zHz=dyqscyBNq>Xra};{JLXRW5SfL*y+N;q2ROm_svT$F8UPE-2La$cnoyfv&g{~m_ zY=yo^q1#gUf$!A(C;Ci!UA?YH zl}|H=^RuemIW#Ca#BA?Hph_M>((lHsfpa=O`)aRr9#}1e_K2V*+S|yyWxaQ? z4`8{kuFDK9OIU~H8T*I#-D~@sH5+uZY~bT&$aTOhc(;0=zotPq_1(nluxU?W5n;e1*5LDiX-T-m2UULfQ{I%-|T$1sm647o;`a ztFnFJw{Y5}yuwLl@DMK;{K22(j-h5>MxcHY?h#Has*g28lhDPT?%F?rxwsB<`B&J~ zuexal-^~BO43$Hl^Aes_{R_L-=9%b@U;3BuT>yRBXVz?lK8=BbjoAO>9`+Y(bJx8{ zIW z|6|KCZ#g40@ME*!z3L`EEglLC(uxZw(bu39?J~2OA2xpB8=TdvLs}!G&m{_LZvr?zQjbzY++( zYlap=+po;*Pt0BW&6;N2bQk?(X}ibbs@~==_^F~Dx>&O*Be=E2<`WxybN&7{HO*P> z>)g7gg%VB+)Q@zD9bkh%_GZ`sCU9SS3lw=46k5$uXVo(`M;-3EYf-Cf4qexb-0gp3 z{oy#X>^rmWpu6@~Kmwu3{avtm{y~g&3hg$wEOkvlf5%_23pNRzqp#oV$bF-(d3hhb zIscWyXW7+2aGSa7(?IqHbJy23M;z`OHlQo+wL4Ayor1&Fd&z}cwH-ylMsrsrg``lf-GCDs3!40GHcfub-b1^^8x98{A?zKZ{GJn~yXU$N;VYA?U#tTl5 z35l2e!j{RcAixFP*uX3+@YFTXr#nheuO|cQKS! ze1Hnk_Fq!-^Xrylc1CE}yCw#$$;9m!6c~;}>zACL8_eK1%+DjvCAIk<6bHX}fkWsI zeu(>+;!ueTr{kT)!7l^BUGB95Fv+UVH&<@p+r64CF2^M#9Y{6lU}UvC@$DneRE@b$U}R<%W@J5gTLlC1lODJ zX-tUVVKe(XfAEdqdjGEdeoTz2F6Ic(Yai}1!@la+_fX2sNa3>8UvEn~#h z;SNjaybF{&Y=={0xqJj(5q>lb->y08s`?;YiBmY_V_o?Un~XN&xscZ!ML75keif*X zEe!5bQ7E`AlrY#|pW)y2sTtfI$lk#jxJ5$plOSc>-vXU$4msVmyhpA(7`j76hL6|( zg2=GT-yk09>pyekeq48O`2aMm zAH?+$Jxtcu;30F@9y5D4w17F4HDOFs-%zlffnucY4-IQ53cjN5wCmFm&PLZ_1F!)S z%(madZJXV7FQ5|KQryP^sPNu4BK@oh#X$!r=EsZgWTB`Xh0} zkJ9(9{5w9aE)|z;!)FL$%f8Cv+W&fW=e*FGF zN{MPn|C{|cw`_oqH;WM(lTi{oL^|Ji6kUl1oi%A4+gz3LBUG|opkzoBs% z$dFwG0hl1a^~3}@$PR=CJ%Y)C334|=XgKtRpg$)1dxgGMq0b|FA<)sb)cy>6kx2Xx z{(xz8u33M%2SFg!U!PvzKM*>@)#8m%QI3hXK8Q!lWoh^VL+jttz-bW(zJmMuKxi7) zgL1VV1cG}Ik0lUd4PAXkDB(@BAk6*JMm?bK^%wk5{f3zf*c zTdNC%mN33xw^kd=Mg4WY&I!H)e=Mq>qN$DA5n#;FXqUg>19#26v~jR^jv4w>bf3nH z!MH&1qn7)%p-`kFoU`iN{8x&D9~Sy#_~S22SQXi~ah)+k^V6`G{Lx* zQ5^i#x*Q&sQ@D<1ZEDLMM{&X1RRgh3*;Wq(w^)15z;X7R!c+a4SwAettVb(F*e7Se zN!&G@X&AuyIjMo%9|EDOoF3eEe;nY;xrCge;MW}T9^pl}K@Zd?8NE>(Uwdf@`d3EP=?$oFIG280nxrr_ezJi(Mu6+QcIQY41bEC5h zn=KVT<$QLoz2Dj$Jr6yG)%QC;&Op|F%ViW7Y@>f;^RWf5pg6ExV%+S)f@acPCUVBz7JA{K(@N!RM7)FQvv$X0_L_*?E z7^RY5v9XNv7mR@s2aCv9GZ!XwAqdTn!-?@v5c_TThfnB>uAD${G&W&lJaKXef~zXO z4R6F?!tDTdKsA3HjjT%+k~f}6R&9Djmei;He+f^&9%8=2jAVoq^(*L9(V9ztJg z4(sl^@3}(B&`nGgANWuJ^np|}Hw+)>$)hHGAT>Pl}^r-6X`|=_7q)_uX-?cHa-Hy3J-3^1w$R14vjPX zp|gBV`R2;Q4KzWm?1EMvULlp6U=MTUdY*MQJ0_YnU*ih^hka|>I2qQ?h0fst`^4{XSNTojIKsA#&g>2E#|&8|HOXkJ60 z@o!HS%_^a6cstNav!{e`(5IM{mS)!j(l`x^xgz+pB3K_KxQGP&&W{;9E`n*Lu(HcJ47$P z22tX!%Qx5zzCFXkSiPrys2Qrj)d7|=`MS;)>(&zA6Zydm&2y<^GEUOiGKH=EJtkiU z56oxbUTtj1wHpqu?$yo+O^(5);N9w%*+P#%y*9eO#8p@y=jZhV7LL5Jp@H!xhzIWHYi2(@& zu>knNhV%S>aq0lXdB~Wd_H)=e7VNJY2!&4>jTJ^*`_(|`61etff$Sg5UD#g!!WHIS z+qGr8S+KwQwE(tDaRGg20B3gGfI=kw{fd|2C&er*r^6^~SsOgAWJBcsRxVUhkNDO8 znE`Y{D)ykC;8vy$*n^)H)u;G_Z%L1>4%PLO5na!-ISg=sEn;(z9-B}ACfXh-xC~!o zsU3oLsasw#H#_p}D5V8nv=j$_^9NrugYVh<>kD1=BVOPsAGazPz}*UNZS!&8aRZj2 zxAA3%1JzAI?hr6YADdiu-tgl-F>JiY88EPyi3<W8UPULf~~S+>)J7G4=> zbIa+nUo`6n^9~H{!Ns&(TudeT^*6B$x{88HMfDkSIX)QCD|$ID=WOd<%Dxw}?>jJT za;J9|E@mS4Lt<=xS!L1jm9SPWP4Vcs8Mbj}E>PsP|zdJ{{NA4OPoz zmzEiAJOB%qwAiPWB*-|zN_P7gPP(~i4X3P!JPzTqzFl#_tJPb~+ynjsd}pSRQn^51 zxdG#g?f0A(+iz+2O~TbUMbC8h`YY`Q(C#0$hl?p`Z!6bd_yvuQ?NrmX9F^b!f6ac~ za+>XCJ*Jp=4vsBR=kfE*wv}54r9opm?k|J?&ey7TNMl^&i-H3Jp$lB@j6>4!LQ-PFLAw*OI_~i8}vZI%T)s~B|Nn|)y?;TKxnMm+VNV)+S(nq zC!WPp{dypHfZtL(YX1DQnfneWeVl3S0j}B(&+^F%c_s}S8gF2DeNBDL;c9{WjU5}V z)<^uu2hEIWxjYV+)iKSzHr^aAi{sYdR(p9g5li4Jqp&`{XN8igoD8){GO7$=r?7)A zST6^a{75*#O3847mGWS8rHq6Vi-!jl$mhJp8x=^CTh$_J2oNq*zHJlyUT(w&0mk9P znbZztfnbwA_#3bKh7tZ$niuSLIXI2^3{g}=Lfv{I3UN7;*hC));^Bl*uOsNvm4;%Z&z;%6u^w` zx=N^lxZXG!UpC`~Vcll{)a@(^{gtQ%;$g75JCF>v8k z#;$<--b3!1HxU6E4eZyjcTy2UmKUxyvcll|V3WCMkN4m;U)9tAj@5a*Br3%v(VT=r zx%tH{Q8a!XyAMcsPwtC&>3(L&mEbSo7ahu*58 zS#0Ro5HCxKG*?b!%jVRgTZ`eBejU>u7ZkZ)GuhrJ)tlL#yz{NPq466qM7}rrL*qmI zx)SC{kH|}=bnKpSnY;u?3iYn(LyRvST`tQ zbX8YlH6qIgn;ddgy&EpZ!CI}y)_XLtjw7pEv0kKDPp2B=z`ELBbJ$h& ze$(dglb>*(lK5*fh^^OXMT*$Xc5*-rbPQ#USF*Y)^iF(#DjcKGe{%zE?ep6xbbWiE zzkEZux1jvoK5qI#gT8_!7^D_icni?s4NyRn?{CO=6l(1Mk-$+u@tm;02@9OCzzGYS zu)qlmoUp(N3!JdP2@9OCzzGYSu)qlm{GV7r=l_btvt&{E3~%M)X%&?-7ff3`bZBw; z!t&y2i-(OYuR3RD8GZ+C#L%Jm;i9Q!(-u!F!;dEQs4Tx^=G3ZO?*&WCtLAtkWZvQ4 z`HL3L_Es;fET6q_<_s@>G3ivVBK{-X6ieCG?T;5#sDXdsjG4=3&X{oV;+egp?LeK1 znfwK&sWYZkO|!J=Z8c$ES@9b%dr?R(J zw=}EgEiC&V^lUZ^O~xMo{f@Nk$ME4^yXC3n3l`7sfp5i3U$kiczw?Xo%Bkpl#3RZU zEv&5if66Z^7xcAtf;FHa?E*UwL>j_m85(q!8vXMI4)ON%_6IUgIA%?oUl|>bKcdSQ zx~humnc5%9>HmjvDre5e%;-_>?c-Gfde|P8TTVGPUYJ|ppj>{Q?H{e}`yY5mD|4#} z_}_B%%KvKzUVsRKP%>3bjfi*r&(*awvI5P27+>V~=IB54Cj9IhV^c&m{uUj4ozMSO zcde0Dy#M_%FmuzRb8>LMY#TVlQueIdwc1G>eE*Ke;6Hqzn=UDe%)Fl zTbKWqYs+}s>zTK!cOE)jSu(Rit#|Yl%+duFGpqWREt)Zt^*>q^=Z)q6AN}3>`JeQ6 zF@Ak8x^hJa^xyLK{O_BlQcakyf86IkvXq!pTU0e?W<{S7En@Zv@4WGd*^6e4#cw>$ znK^BS*0*1!-Pyi#G?Ln*phCP|(`L<|HoKCBpI0*N;`xiF%_uI%PCzS}KXY2;Oz+ZZ z@dYw2Kr&&q>@Jma7FExmv9NoUclt~(++t=IYeci7 zBYM`Ng)=q$9OkT<6<+&CK-HvMyr{CAKiJ9f&p)R9-!-pXPkr+J7#=HYQBZLGBZr=ON%{QoRcI3Bt^-Ipy^kp9Xq=eYG)ue^| zOr#R%&<(j(6zd_38-@9R;cE%<QOafaJi8n;3_t>dXZ2jp}i zn7sU->+I9X1QaESycH-WpkFOv{NI*6TEQM5OADA6_2-dF0ecO(R+!|eaX9A0C&i61 z944|t!vuH_QUdI9Bi;#WBa=MWIYuXCTa#T6MG13vmCB>@?s*jsOwwxInZb@K<&Nzr*k>SRppQ4a+uXbyUnTrE@`{q~(w&z$ zk0Z~yJLWhTEdbFg&`!dW&CNR#?RJVHvS{}~=pXByEMVtah?z?t475=BA&5MXy>{506{%CO&eS6caBto(0QzShb&TlqUy{-u>4wDQ*N{!i<+ zoozXGojDW7--eNp&X2jG{b*wS4S)Yk4+}jsJJ`|2BVX z`K{~!?f$oJuXX+3wcnb)b^YJ*x5l@wbKIF+R^A%ly1mx*e@FlS_wl#;kH0ZC)Y}7p zaWL1b{`8i18&I^K{kJ4{SSu%gEr8EzuTOG$TYyq&wyMjU0b;tUy4>!g+R$Cq<%S-0 zt(U6vmYt7xkWX^CA!jLB)#WBzFvouE{0sk17k?)oKiBbRtVh}Q8rq}PVwN2j+ZF3! zwjTFW3NlCR0uW@oV)+bqpEiiy?M9b1aB zX55Y+7igOrlMReZJDIA^M=^)`IJGYKLuT7FCzUy4J51n-kN4b#iow6b8lPZXA~J5p zt|vaxO~yE_%Td;noP0CWr5*MIMofowordO(GED4*0hSIoK+lB1ZSRM$ zIOB1QLBc6g@fZs*%n3uJl3~=5tUxMW;~ip#N~MR94~I=SRVsPLJ{T}zm{f)s1JQEA zaH;r=Vdz1EPb#L-5vnB=N~Ofe!agctq*Tr|8Y!)){khPy)K~%gB%Gc)1(i9*T)10; zDOxW!marYaRH}@#(7A*(9xnUq$XG6eluVLZfk&T^lQ$`!`D_)HiZHyzSyjH4LS zgmLZ)R8|=e!6_5YOS}>UtBuPj;DYqafVtU7z|bX3?r7CsD~*r#;oF3@@w&BokVj6brdCHL2jLYV4;w=tHF#b2-nWNnO5 z<5BYrPwWj_PoBu~G$R&eV<^VRQ=M|5BsD-^8zB)XdCx$U=g+aJK;Hw@BQ`p*6bLQv zEU4}IOYAuqp7lVzW}}^yr&Ug;G4Jt|!DJjR{R`lmNF$c1a-m_*GqH<7^%tV?2OBMv z)?o}J$9N`s1_D+s&3qZt8-6U3m3ZJsb|l@BJ7HVTxVTe5OWQaJ)TWGvR>?#3PA8$Z zbUxbZFbT*Q&kr3_nWy-SzoXTdl#p?&w;Js+CNU|u8T}={-Iy%-9mX=r?=r5F z{2t>m$?rAZl>9#98_EA>q@bTMDGwT_NdB-fS@K7Xm6AVZ+$Q-G#`BUtX?!U8Q^wDd zKW(JI2r(&ZjXsh;W0;b!Gs+}?*0@RX=Zr@r|CjN)sCS{A!L-MW0X_CKUluEwMSRwhV#$A%XW;96t zy78{$+l?QrJO#lmCglwy-^xoQ-(f7W@@pl3(|E+nUz2>N(PZTwOyTY+hTi^JDJ1Ca z-R+(gjf*M?iAx1GvcrvjA=jL$d!D7;g|d(W2WR4#?_Kn84pQbZM-J= z65|`mml-Zx(ZsaB*f>e@Ry4C9gN0l{{p;EctcD z2gsNG8S^`NqFxx2KGaA=w7Gckf(otsAY;^Sc#L~Z;!g-%#lvAT{*9*J7qm+zfa%il z_~?+SC%z2R=w#8`gIvqTN8;ix_$Wn9yNt9Q+UrT&QR@RqAy_9DW<1%tV;-hU2L@bh zk-Z3Y*`C-oh`QOHn4Opi*{+!3Anh=n1P;%K7}0E(CkWOQ#?2HinN#`kr#RN93UD&& zT{z7;rlxbp+2!vD2`9BlFeNTF9KF>x`w0pUzT{X`Z`bn#{jD-2{J0Fh8`E zhryTpC2*Z~=>{?;r+kpjBBF+#Q!!&QpH>1Gf1QLX0#6RioB66UfjlO0@}XKNCo_N7 zIrD9Y5HMH^pOfTTGXFYZr*%3jjNb}H0r^^w$HAO=k~84}}2Y}26lva%P zN}*DIfh+S-1@`bS24+sz_3aSQL>i8elQk!+T8h~1C~TZrsJjX0`k<`Piq!KWdpcZ~ zj`SfFKeUu5pw@oLxR(iXCh#9 zS}j)Ms-(0Nxt6IuXD_=r6Fxv*3Z1xSsc}#Qo)rLO?oxuekU8lJ%3jH{IR>wa^hES9 zYGNm=TFNK*=#hYllR3|s;6%`8fIQ0j3IjL2==3iTc?Ifx|=~*YcJEU*%Z8C2qy# zy#<%2JK{rTJD1>s5w`7AmdZE@(^9U-=klrrT8C>U))?v4skxzC6q!Q_YhGfEc`-_+F8QSy+vz&&t6!mQyVpf29Q83DkV`@%_AzE z{2sh2bGInSZAr8#&2t0dR_67(dlBGF3bzC$L`YWx+DI`V!n2biZqk!(0*0w2oy#>9 z0WSGjiuyj8rFWRcs^Fd1fxDzvSb59uUw1xgKooI4% z4U6_k>$wl+$lTP48M(QGY}vM;H>5KoH#e3o+a7^lWHxqUMsDsmTedCeuhN;3o7>P9 zZTHv=&&y2FJ259ax2Ms@)f7=g9zC5z6f%fJEU3UDM!$R`t}&7)=>|8ZF)6=D-aW;o z8)}0ZqZ{0yUdT&^&Rva|wAT!^k^9h48@R6wwSfy8YU9>uaN`z})?}y+-9Cf+w-x$~ z@+Df@d(Je-p#Ue(@bUrW_oIc(Tl7?(XnkX~kKJg4#@;WwNC|wZ9qQ6rOBGorBJ&4l$kpU|Qp&o^6Z~7&!0nwiKd`#sBrxMo8JEb(swk?`bjQ9qI8FIqRSwk3ouM zbW&x6<#Z|IuJKBcc*n$ip;*px@;7AZcZy|fJGzo;r9{eLX&}qEm<&)&c^|{;eah)R z7nPJL__#vC63<*taV~ynp2sn{y&tPhVvsm~Xerm?vqtanPjuP)nInaHDd0SzDT?IH z&?~!x&SB$uO&QIz3sCP~6_|N^v%s6d>-|#K*-f726gc@_n6OK#em$T(+eP(K8%0iU z=b0eaYGv|y_c)ViXP*C@r2xx^{J#Os8{?EwopZuvqKzFPJ4KSIb6*CrK4=B70KJlYzC+o2z(v#B5D)>g62lZB8CLVG|p0hw4T}UXzvFd`Mv#~sPmZHn#L2RVQy8Y3Z8$3Kuf*>;FGTt zoA5NOwjvDMmd#?I-pOOd!x&Vfn?KES7B&CU*_pn}K-(g2dL|I}jjq#|8GKc1JvVS3 zecS$7WW+EWw^p=g4cyoJL)In87%v&BThk<8%+6dUTN;M&C|*mhAp7MKuXze@fjad^ zcx6(+$wRr5SGZd8ayWU?GvX{fqARFp1*9jPrA);Wy9Hi=(Z_!i5o#XbEg37Z?M`YE zD39|N@x3?`B%P{8ou_*Xd=XqMslSquV}qS6;UXF;C4U7z*G8Q~&r1Mh?^4t(0oy4z zR+lSi-VUh#(P?m2cY}Akj3qA&TDz!p*~4FfPD)Y&c%2XxV72fR20zKEROCH_fYlVE z9-3z`RX9Zvgd+qjX({~cO&{>RKzXGR?SppeH5mV-L?>@JR0F4Oq0nNTcO9xP zG_L01`=O+9YEQ}gk0{Pr3cT|Fv-;5&){D85e`KpWB^vR9M8-z*96*~BmPo2@gzX!+Zg9jpresU8+J2BxU(ak!FL6SR{x$*8+Jcv zavbsBq0#$*|7V1Tp;_zuCTx@INZ{YeAz%y8uam^th1jv^abHLLlUQ(hAM*t;2aXl6 zO2>bo#jglE;@80^^;moZDIH0AqEscLHf$Q&f5{R5S2WiP_&r9s%Z}vE=q=6U z2WD&(`xU0*YmS6b7;EY`8<+(V?6AGSHaX%CK|3nh8Q~%v?ypS^?9cuvvB;tER z?U2-X_J0da-|9@{TNnO-eJ@}J+gRm%{qIIc9&;w~xWz#}3+VG&k?etzYn@3?fRZE^ z0lm~F(fZ$oA=>Cn9*GD|D_#f8Ux}rDRvSYBf5n-64OAe>6F|RkEJ@Kf=*Jt*3zG1^ z34!^5SQ=3YD0&rKZ#jEloWBL;XapN^ORZ=(JpX;?cn~IMX<9d=sDP;ZYDI@(sV|%- zVG0z0#(yjwO{k4dfW^OYCQ-OH`g~9xa3&BFH~Il+`Gcx>PX7_=oCfge{GsHYC}XrkYfkdARD;B=q^HitOdctyRGIRt@*JJ3k{;y!Nzo93jAvUp<;Xs=t zVaJ@MfN1@^Lmbl2LK7anD9$)12|XJV zTS^w=bwKqqq~bE3Li2iYBAq5K(1;17mpETQCtpK5d)ZbmTODU9Xq+T$(U3OH8I#O) zAcYRsffFT#ils2>ci_ZJp(-6{%oO@z2X-%oAs~gKQfTuIY@_78czk@yk0yL1m%^F4 z4oD~kQ7O<)7G&ki*RIvebi73-lwn^>;YE7~)<+yc>0fZodQ@&iO3gygt5MLd)7zo= zPZZToft*fOwUnpuxms_qQQC-X4EO@H|0Y0tkRnplg1kl_2dh!QkL2lzf_A-rD`ro( zQHkwO21vHG@^Kn)iYuKCkVEX1_z;nqU>`7j3EZGlDd^IEgyG-RlQ`CC9Hm{V>|LzA zrFY<5`m;U{yxwx{ZM_|-v`#3$r+Z3SOq+pO@V=hN3ZC?JV7LL~jtzEud1$ZKM3_M@ zX;%u8Ua!#=N;*sVNqR!b0O`#LsyGT(*o8cd)RuzU-p-E)`SCP9v~>FGL6n@`a*pW{ zoVF{y;0FCS3jIP)c^x^4+B*3M+vGX96xm?FkKf_j69ML8mmI1J}6DOgb8#bk5#uC`apRX_Z1dFT}*{NTYQfgOR#O@5Y(x z#g9yA6%jL6DKk@gwX$$0?_BLtJ*5e!Vl$3L7lww;9czrRZsdVFE&YN z+*xdEz>&UDFQ2gt@hF2z4B7+hP60X>@->%*A9UpPBSFKc zGw^Oj!P$(Dh>zwj)}9sr>xAFec}`h9cdqt)D%I|!^nM|k6+Yu0@?uNYP5a&V%JkbV z>!oRDb4qeVu$_@FXa7anWq)_7Iv!~_()2swG5hlwdK*xsH%(6j$Nu329YOT~(imFt z8VGIcTsP4N02+op_3y-pT;h5l-K2|Ue-dCf2bOLCWrC%tk?*%uYp;vBV=x52IPpCW zPUDmwN+ebtfYbEc2fAZ6aS9ipJ_yOt2bIYvoP*>hm1_tf_o47tR*Fz*7lW9K<;lf+s6LZqo^Nuf{HlYd}`IoHEr`4UNH zzk_k$5NZbrVPw#r*;w--E`s7ymZPKqO@^Vk~?0w#bjM zmmid4ki=dN^i1q^0U(o*_?$v}O^-AcEh)5qv|X=U%U-vG6+>$Vi1l@gbn^A1m_Zh{$M3iOkZIU$I5*1Jl=J zq)5^3SJaL~M9D1p(GsO=DKJW+KH$-wAm%Jcio--fl2Oe=p(m1?R5GgPp*9{#MwNGD zx3a=feFKG;kz`bJKwkloGOBLO`WPfNsy%&5XYCZw*rPfW=pjgIREe=i)gnJ;REt4* zCX$Tm7^=ouFcpvskod?DOpi1bEh%(@-cIj@K5`b^4Hm{F8G)F6;NlvZ}Do zh$vzG7OewAZu(p=6i31N3O*uXeeg6ag!(J8pd!S-8VT{Qsm+C!&aL{psTE9Nh`k$qB%H>h#W{7k=dW_ti!0C1E<#;lJO+FNd@k721 zsVy1W-i;3}o#)5hC^?VdLkvfK2XG;O#hFjN(x~G$XX^VXYw0`?#`OWc4if>&l!K-DV{2(n=aKX*N||wtlxN{!Z#YjTwU*9vZv|;?uxTQi zZFKgEXtv4LjHm5;NWadekL(y8b9PfQdDz`dn(#3+)c7rDRz%~soP8BN&-VvOKc#Pr z-imc@b;@!s+nfc!%I57hwRubH1c7&{&Z66Qs}eU|_u5-JQrzcEN5t;Z(6y0t-t=R z-*(X$Ya2rozROWT8lMTBn;hxep>xl8+zk+R6&9T)$4H)wcn$mzlI&SlLPA@oImriN zP3t$KvP#?UkX>$e0&Z16)~~XnO#5EJT#0ZKz`JqbIOIs+7U*Aq@!GZ9g=qG$qU)Ok zvmo^=*N!-3g4Cfl1*seN&PN={+tJzp+!maS)a_P?Om!NifL)FHWk?<80p`pHk|Xe| zLq=db5ZjPsBz|+qMtcY&3BNO?IdjM6p)(89h{^A(3waMPTO)6 zW+G{)t%3BLEhY@4Jce^{TZTc`1NgWWWY-|Mo#eYf$=E+4bvuM19H3yCsCQ&KA7&kZ1+U*+t&cN}!ukQ6ixkh( z&s#%%06|k3+`i7vaiDeZXmTz{0!WT@R31R#Z%A&sfU6H6ub}n}lIs*yG7)f-kYY!n zB0Igc!<1ZD1RVO8y`Sq33vf>$dx7gfd=-+LSlJ8kI~R=GvKMf)gDqJhCIM0p&_0*$cc+ z)wmb95s)=VeA*22`J}*w`!E#wH>>YEvif?@R!rK!J1q7<4W%ShovIL@nj*=yX2s?B zBFqG1O?Y`5?{clnFp?I}CA!X%pleS-g4a3p_5q;df*X&sQyh|(#Fc4Pgw8HGf#TzJW`9hc zNuW9j^c|2KT#E*yFi-?=I^G&lHCj>v;NMvT!NaLJ2K1wmWNMy+!UQBOiJ`-0b3{sK zDt=6gynhS?4+9GSH^&?#i76{kxQrFXlv`1_2}xqgCUn-tnDRIv|0I;L?h!I3752(Br-v?Nj{^U_43G;9n79yOeDS9N^6D zdkXle%Te(DiX`hrD(-SUNTO3d3b{yeTrZB$Xj~)41H!-YC2PgjNE7jh?V?W^aMO^K zJ_O^*pbLc~#2o=0;_NK$vlO%!A&L9kio#7uZc@b3eZ+0z=r(x-MO=n8ahYu(e;!F( z<}53M2BcLe!3icV!@m#aKoXb9MxhguxXdU@qRX5D2w&5S%kaB-QI{zr4PC|${Ai@e z(~6>RNUlk!ypO_Gq`H2Jth_oIM4Q@(?fu9pM5fRBL}43}3~mo<%PIULAm1a& z;I4}3Hw1VYT)yFVAgRG6*m}f*4@Hb(0`tA2ThCKLP79`jCxyJUU=9jhkd!62L|Qo) zOh+6&&ps7&wB#Vr42aM@ZaIOjO-O`UokK3M=}ret5$Te+33xc-Wp>G4+)JE2AGLWV zfqtU!a6|CVh-|y$u=-Wv%-ByJZV2Xpeio8!2x?Kd0!fRffM+6&&Jg9Ya)wza&^(FcCL*JvZFX-~J)Avfk>`*_QoW4+Hosgw-%KL(O~Q|D99Z6Fk-l9 zNwMN6T26Z~$YtRO(+NrDKwlJkBdIxHvpF=oWY2*ctvN6fv_2%61LvYJffdeyY7}_P zl{xS%O~^TL6CgJt$s9Nk(eD-DWe)ruxciaR93VLI#B*44hxjbOd%#U_#vVXjhV=z- zJ&oihBA&xKB0~EUK-(Q{@4}`)hPDZGjie<)hE~IM!x2DaXir9^6H+XPR)*9TrE4)s zGNgBofG7^>2+$2fQbQ`kWD}3KG?ihR0Ga@j3{x6}M2Bf|M9*kRv0|7!)S1J?OPOjU z8Kx^ys6|r4WV1OmyVS#K+8!p}HQkIP!}J&m53|BydL4zAkz|;tQk zIJrEwm0$JZvH(e}ycdO!SfQ1VqHqvNtjw=hh?TwAXLm*tE3b}d^(gRSyb_ibTe*4p5;a&6_(mW_4Yt#20Q(qu#9(D0nSvw++fE6QVEj%*p=e2Q z!e9q6L^8`)fO$ER80<)|2qrX+9}_bp(%K`ri4ePYz)cYBeiVME>`p+`?&Co0M~d3LpCx>xD1er^2rdQ5 zA|$apuc)GS9~Mz2T2idA`$9A;cK<7wZ$=WkKZwHLk(AwSHiu@HS}%exfc9TVV)tDr zyuk|XegK6qlGwcfdWqdrPR4N$N$g${(a#UO*u4vIUL<9Ag01H?dg?6}!&w#(GrZO8 z9t_?*q^Qws9$Xg5BSxD9lCel)wDXQJ+Cvegq9w%%quo2>J3zUWOz_3!-opk}{gj z=FsdCUc<>_J1bvp-HIeedlH3zvO=TnKw&GA7_Hnk+V_AQKoX-hMD)AZHku;`;*pfm z2)3U#t1NHj&07^*Q7#rr&h-gF>x%_v`~;`mEZ8^bTAR08@IPhqKXCr>_>)@myM2n3 z?f+==AHRKfYyJyb@DD^_7yWx2xBc<0_!Dkv!7scS$L;$*$FY4^Fa7vRLEeeHrgh*8 zij&vEbbqmd?X+}$GxR>xooVo}$U72zFXlX_d@n}c)pP|e?W-8P9#t<$h(-+1b%`J3v}GzgIhl^c5}XwRC=8cLm|Ew}i`^sJ@Qq7j8ZRHjQ7B z>F;n;NA##by*iOsMME9(Q#^7tG0f3XzEC83lTY-%L+ij6#_=1#x*r<#@=-6%{;4GW zw#4Zz-VJ5I*F8u#tFO42jx=_Ir{WPvI4~Wo#&q8qiC%g z6%Htci$KziDVTu&FreN9y@~n@Nc|RTGgN2BcEfcdlDx#3sXEoBJ6;_Dc8ku}T>5RQ zd(JgCU*4@d-d5e|=*+L;6@%(Dq>dk;&D=Bb#TLH5nCOuA7tS?zU5-Z1b);}${t2>& zkmA>2hkZdGr7PAdFrMQ`U3dmU&IiD30m;iqjyF(w7lpT3;akQ=6uv@|s}WlOzGV;# z8fT(hjT{2{Ad*~-#Pz^Rha^`c9Z|?YLi>D4dX?2aeh>-l=Q;YVW&4)`(+@;_$ikMJb(Y4W_IM>mwiE?;`m`)IQ{eE^klgWcSgRtpj&fPu1)$5JQ1s@J5V?8eAN87rBsY)42lzxCdohgO zJU#}Jhmqvw@l_PIAj!?+AWGuR<7a^EC6t%dqp3vXb>T$P@aFL+;J-ss&%oQQ_T;kq z`hh+HGp_%iURG=IeC>aGzLJ2ScfbfNbfm_iBaU2*T zti+-6cNFeMa+BXR2$1clZ944FjB&1i}|mAk?yrwb6|O!lT)!?x>!OBymz#TbnOYWu*aFWoh|Ui(p1QpLZN)I zvDGxEXZ%degQ^UQTJ&HZ&=_4WmvhB#1~uYtR)Ye@!L2ymV&zW zD%xJ`7+gZ@?FHs~NMFt7_yvo*QQ&=@`(xVZ8$i~g_9znM@K!4>;@UGY?8_Xzmr)LH z$-*G|l7uoDZ8}GU194uSW!7Z;8MJ&8Et4??0z62VU)7NN?%CG-xHUs9W3Rkm2e|;2%f3QM--HO5{BsafiCI0$3Y9AxXJC@f@!?tKLcE0DA{x3zHZO<=U#`_X^z z-h2_arJoN%z@_nL=&p72m_H6J@YTv1NWTurO@zE>`8#U&B1yDsK;cCsiFT_=!f3}u z@^wO+QMn7yXtaBbG>mq8f&U0eo+Qq(=llDts$Gh=>Z=`no})sXZzuPK>mtc~>yJVn zl1#Ni6i!1@GwqFtv<5VJgQM@Kl)#xb9yH@fm%(MvrgLaJgf3H-y6M1|BFXIf6AG7- zL5rucUWhD|w_#e_w6%^J+jIk0=o>DKzH1td!mR;cFU5vQiF4VIUH^z`M;sy?lyT zn-qgnuOs&8L=f`WTmm8!$xVdZZ4QmlE(Zulz?&z4mX|!$psOS;5putFC2Ch7$<5EB zDEy5T-fg~(!kb7E1#OW|`IR@^J}()M5WulfbJND_+8vOLYwdf1m$~W8gOehuJJ2{@ zRX@tcc{1++crub4GG7EVdNQ97=|i-n41hys9Q(t2&tYI5iX;|069qq#I%L{x4$UrQ zTL!cbnNvYK1xcb~H3}E8!b9fuC|r#shs^ENmemnnguyNaEHrL7zT{wXfZhWCP9zzdFHqRa3hzD>^YIN;BpI85DC8lDIr;zM z#GG>gDJ7J*{YL?fn)9tl>(P>G9_F0H)@jaqFb9#uoPR~(W+Y`!n+^A#mZ;X|d=#_~ zBZ)aTq0qnz&AAta_mIS#N!T2SIi3CC7)WByJrVsn125)m2i*T+?mfVxtg`>{x6dS# zK1m3nB{UTwArPtwMg^6iNY#L43@H#vBbm@40`>|DVkOwt0_v^}#om#%ti7!T*L7WY z?Ye8*<^MV7-uu4qObDRv|Mz_7dG5?D=bU@)x#ym9?tROoBMEU*wfH2xHN1>-?)j3@ zPUX>`z%~>B>=<0hsvta+6L#Y(m1+Z-5K15qU)ErJ9R$kxNJB=Va3tC{oPd^5D9lFf zWTYTjCwh04bvQB`QF9?uU@{7P6Iv6RZZZ#j^?39`b~lwO*n~U{xF?a=guI5#D@bfY zP6vp06WTf|xl!e{gifa8V?ck1#2*f{#||!&MK32RaDQSJ80XnLa5%yRB%Zxd$c#V| zH>7Qo1h9+c&n;%L7Z^+e*hD0rt5cAvK;ppQQHj<$Fi$X=OTG?6`;Awra4k16k>qpDx2o0Qwz-(&r{NIvR^j{ z|71oPciZ`3=SFcbk|zNKcN};8I9THF69Lsm|FfZ8Y}>8|ua_fn+_4>*dyzE0Z*Y8p zKtf!QfTstH+y@DX7TFtsd4-VZzQG@m`Hqn&;{W|nh4dqkerM#IJR5KnL1h&~!H_tD zIs};!RG1HGz$#X9K60{?NnmP-J6hYk&kZnjj zlAXxxKoSwuOA<-frUMBP)Qvz&pa_a1r?&w324Pa<^iO0yMoM~DBB{t}VUQxHg`k;2 z8w1s>yE*tx{ve9_hM1x#Dl`HeA#oJd1DWnrpeU*knITA;W5^k%O+q51C88)NQ&!U^ zp-@zJ+9)_*Ng#S)?mW=#qfSX6K)WDX08A^+g*wSB*%vDq%FT4|(r;*qTE0U&m zFEHVSe+Jh+FRa>i?FF>M3m(2==3*|ieu^?-VVn7m^5cT&@bx&SIteiyb5(R;pH?l_&4X`Vbj3p>+Mdns2&{K{NA@cxIDxp|cqUJf2b|SGk zZE{JTg7&|e{WlXyT5j(EKE4W<~GVMwWj!h<;irNfYT zFs&}h%fw(Bh$IbW8bGEX@n9;Ei69Bzuv#MN+V8|*?go-KpcVi&5+)5u^;Ue5MB)J@ z%_tT_salPzg~TVKxiK^nomL~8y$-jRd(q49jiEmgYqa?|55&)5ZfIku;7sjlhU-1_ zRKU>Uptv7u79ZWam|@3P0ntxdxgNq z=>T~;aiiP{p+8*UK}T<$y3dXti0|k>QU|Cbqf&UK&K(tL&H%YusiVUM zV1k)tsq7Ydm#qP*H7qz246q97Ow(8z8k&Wgxs}x1isws zK70jgI%)(KHS!ozZeKJ#SB0k2@X~=aYHA*fohFj=Kt>sgIN>`Q zXQ}`Z;gXE?l4f-mtu(K^w#sLT3f9EeBqMZ7Y4Bjaw5WIk=nea=iKW|zLeOpTZa@fwQzA?Q0u*x|5;^`Dp#LE)1Y`&eROcRiZoSa!7BBhhI=t>|y0)xI@4!V>FoplH{9Z1d^AJ20E5;N!|vuB)Icg^p(_)f1!rG{+wHrn&VlD&JsL!wrSJiS^5Di zZKxA+n8_@C4R$^xmd^Ke`c_P*GZe0by`-I zEhZ&T6Q8M)fhaT3j?Nb$CC!jvBv(&h3){tl(sCQX`_mG2A*0?5w9Ul(e2GeTx||0P zA36v>6mKH_+@+Q*is$_XNg44if0E}5;VowdUPk9TiT4Nh!TWvSeYHeg$*BJU+Bd}e z`##=}1c;CKb}i}8@w|_oUdD`c)^G?4FA(s&c3EmS0osQVaEqp7;0$J9XsMzzk1KSyE-#JQ`1gp5WHW^s5^o7DDnPBiArw&;dtJi_k68?maU#u`dyDQ z=8DXB50J;W_h!D=#*QxODIYqce&3}+u8T$0a#vtP2Q`WjUCJZ+8Ke1{Mr7s)t~mY^ zT=CvVSki1?>+Q1D8_`ETmOfJ>>e{QUk7X5>y?}lIwZxVtL@5!tH+GHeWi*M++fO?FYIuH9=pOLMe zVEXp-M&^M0KBjte?C6pX^P%r!s;`Yj#k1X6*x)pa5na#1I1i&aoksMIkLP8AE8kRq z?rXh5wt6Ev)yLACYD8U6^$oFXCEdRNQ+;DBsy1o^Ha(-$g+O&T2m8VwTz!~_;Tksp z>K=^pE~KPM5`4Vaw&=sy@ZDV@h~SAd+Pf(r%gsrWnwgP*HPNIE-SeRLMj%0D;hnNJ|XJV@3|2hKxq@NF+WDIU1QGk%&j4`h!H#wOfeCUZE?9N1}WJ zpk^X5AEre3DD}&pyKI z(R>LK6TShN>ySX0X17ja7}^)WF#9DGv;dH1^ezDX0V%0bf;@1USc$;`%p&1_?=q!w zNkkVPvnXMqqVo)BJVkV@a2YrH>9Eu;mkqi`f1+oWgNe}LcDH>dN8D8nyGlY9g!chvh z7x2jXCJmAxF#{R|wpD|zy+OEBLgy0hv1lm*ULlfk7z#%qa~KuqX4)CZOhXb2L{TtY zT4>>qd0hTOM2!|mRT=JJLlV>RmdmlqB{Bv$I3>Z30*9ux1@O&CNq^ZB_oT$C!O(hz zfg1^(Lbx;?X94dFB%Y4{N_<>Q0+^bP4QRd;iKpX6WUfb&N}QL?c}>?!iSUBZHbwYu zG~9{Aghxv-+}P?P`~;dGLt?_OAoCKEoaaL%hM}EIgj*86A;L7;4*~Q6Qj&^kW9EuR zyGr8fT07w`2_4fWNBb|}eT&3QZIobGNj|3R!+?UsOl2VxMv_c*NDM=}kq9qMIEM%m zQ~d$d7b!^vtDTto%4KRN;jRkpQcR5o-bf^7%IpUA_(N~pS5t5lnkOJJQzsxZ6G<{< zOAJH%lnAd*=(SKXRSTeMq$CxE#xO+&c#6c;wWLhoo|pU>;gSJf3cSTgY=F;4=3FX} z0q#KNDk_ixz7Lsuk=Ot?xxDuQHD!RGK{Gw$#KT+cf(!$Q8s6(@eiey__c1abA<_6~ zHWiA=udp!B59KZbB zB22T{4?y`yNuwl4jNphV6)>6F4TO7D=nloyDBz7iVx|PR$?M`EUqM}{6c z15-33sz*GyM1-$Qp1v4>G$St%Nj`jE=pM$LJ}hjg-APe?dV{hMqgUfN?Chsq;}FMMP- zx)7SvM><);-0s$ctPw1e!x$_Z z?b`@e#i2L*(33G<-plQnwrAFjV09e&#Xj_76#AE4qSwTs-|j;{U!kW>@2dCOIP~Xz z=sOj9*JGa-hyG6=dcsOM_Dg1U)q7nWdZ>qhq**^&p>OFD{j@mrK|b`e6nd}=bbVqR z_Cz1{lL~ut7lPN1j>Dek!=@V>dDgoUoE~>d@0{(!E>qZD_I+er-|am;v9&Agu2rTn z4tfljf&Qnx-@R>H}UjUqT!rx64atVj_ zmjWkOUyriD$<_P2IJx{6Iob)Qfv`2>RKU=4Q3s!vK*hYxpj4zCP4A%kQ=c+4f^q)F z#9dAIf_Tq-@hho5IUIKuA{k}C_!*fWk+SI>RIf_(J`$au3d^Qfn00DdiOQsJBs|#$ zUReQy!dj;33Qw7fFz%VU^sMGnyYL3|HR+7X(Tg2eaW^hc&I73kiU z(a4NMO6n&`xJ-L3fCnPep9*v@-~?n! zk@#M~DxmPafOAn(gT(g&{>kO9743X4;3BlOA&Gkdsak$`QndUsSzLo(+*bJ-%^gk3 zxxhISDU}*{Qm#em8YG^SXOVe?3Uq(vkI4KBiJx}3l;BB@1xJE;B$ng#sP*KS>2~Yo z0DuqVIDuFoIi3LInMf?hT4bt`gd7!`p{ZORVdJCZxD>F9kywsvk-2~hB*)v3xeCd4~mF*i$ zfuUdh!NnwGH17t%&yb9BQK&fzPaPv!n^1TXna7a=x1wO(jjvrOy+k#SqQEyh*GR&+ zT^*DQjX=wJAVqgijReSnNU86lfhYQW7xr6JVfBU1B_1$MZGc-qu++d4y&k0tka(hB zMdmpw&_wS>=HE!X`V>i1vvgj4e?J@I@m8N|*R@Qv<7VgVbI>K-usC%hMvCNHefE_iAAaO0 z*td*}x~6iIWiwXdtn)yFCa5p)^N@IMh9gr*1-i-kL}aE@f#zm4GAogI5mpm}vGbX|7BC$9NkvRZ~#d!vCOX8f0n&XgIoI_o%)}x)pS&6m?k`O0Vi%(KV|1!?S ztwAk?7U75Pyr|qjiHE;$GtVb618M>2HX-p^T!YLiqyVi&UV{NzgS_^V^uA?`@5TmQ z-;r7<-1g~mTZRCGp0>FGj1Mygop2$I1ZD9M6xDhU*6>46mxG11Nc<4gHnd-P0VG8a z);xpShmiOoD7v4KAAtF${1DV2WDZ2) zhoJre5bq(VpQz+M1QjxXK@UM40_agl{Nab7*7YqDCC$r;3OodrdjTX%`m_Q#%aB-~ zE*~`l zdkk~BwhR=~ki;9C%VmEsgfa*3$DcBz^rVY`Ly9*L@cofk_ezi%O$B;m^9jgIM`GPO znDmRD;cY@q1J&+E;Skh%Iyi}7NC#J;eFYMIaws0&=CX1kV8$E0INW^(Adew&AZ$#= z5q%{Rb{d#^Ts2XL<- zrBW-u+Pq*2MvTO-Hopd$4OE!Y4{-)Ek09}@&Cdb+ERfHMe`v@LW8LV>wy03XN&|NLN)mCtIdxEOhH}1m|c+(bSphY%_2wB2A8Vo(9N$NU6`DJC1e^93c9~g+^2% z+WBD}V9A*VrlUusRBB+4IuNDaNbFH-kvWA5xuJ8w|6fmx`#OLyF`j}6OgY)VsYMv z%oZdePKAc8nLvITkcGQl_S)eR-< zO=Qw5U^I}jKSDv1!apBb`dEKOWiwhEk@%0X6a<1iP`F4Rb{g^CzaJbHKvp2}pJCjH z%(Y0V1jQcX5tJT4Vvq4IGH)OS$YTV_z%v~EgWG>m{UZ_^_3?yFM!n}OaEL^o>@UF7 zEXgTUjX&0xs5}D@%OwT0zTZ-kWL+>73ha{XCn5P(8O>_ccPo_R)RxSnUSi6@`E&xa7ZK6 zOdGw6Ub2dbk$n9SCW09y{;5MOoC5u*aCJD38P0LJamRs;$3PZOE-^&C_lN_^e_lT! ze*|>et@jNDuLTO}aN1xXs3al9-p7SUXQ5dkA+tP&^jOXBuZ2S6LS_m!*V#UC;)q+< zC-S89&j*8r5bppQv2U0IV}>oeJ%Fbcf}p8A(3K=A8X+wq;DZzsEMMHf<$|HY13Q@e zV?80c4?Ymx_XHn9gnE#$3M8f&5TOps*GsxrGvkG-8=e-)-_Y2;eBedUTWwe;f{NO3 za1->6zW8X3)RtdwAQYh<3OABv;_^JoodljVcN#`hy{iN?k}(st)AcZ|ow2bT#ti8Y zx6K}tpDd(V634P{NTmhZq1{WmH>S}1jw?W)jVVGlhY|xZic}WTsZ6{a#tSPycnHlr zEv&=CdMG6Ht1*Qjju@k>rANi_eirf*8&j0fCJ0J$We}+&3o(l{okx+RX#Lc8r$5#> znz$nd%5s+SDx5fq*F||4J*m#AuSsFxl|a<-*^vA)fsiI$ACM9bnSFZnnb|E}r$3OHE6q|+)8@hOVl;K09uV)R zb#pb6it|0&rD^rtxm<&!|JXj00z)p)VYWns)94>Q+7K}v0*N7lfpU|W07-BQd=mrf zRMNdl+LxBt22wS#xLV^IhJ`$==$;y@(N9}!1F^j@w(4vhgCUj{8FCFQmU9MH&!vB1 zS%R{hVcaK3Gfrfdxny|o$Ao%?i6iBfmd7?LX7eDC6^BFkv|3kU)dh)GyIlEFIH&83 zEc+C;8^N7E5Vmx+o+Vw#8XeJtc7_KFY~>8j6t(2YQR@!zES>dL&KM2)Y~9kwg@_$* zZqA7z*_a}RMbPK^p`n_?crMS=*@@VA{S4)T8d_B*aexh$qE zm)k~#>R*GGD@Yc$guFsQib|}$D`U8t7-NI4(%JVzT-xIZL2TTKm4t9Z*Y%%LlIaHp zO;q$rL{_7yw?9%7((6bEps@jo4s0D97BnImdLJY8z+ALy52L8>q&hCXOSzBf>vQ`0 z557zXA*q&*FRKrI4WcjJg%76OVfeBq;>($duRsmHf(xj)n7&TOSHd}zTT5RX>8k@@ zfmVeeLaLP`zd@GFW@UcQLz09eSJlB8in0dG^jTtor-<%Wgm#IfSsr%80xkF z^ITnbbURryET~Pno#>d)JH}wD3sBu8JIOIWULk4{sOA`gIdi$F2}wMo4`gd6fv~!w zZ2r+EBB4q4K=T2;+#YHkRAL9rt5=p2#YgoDJH_lr5Gb8MzdebRV}^7)?0jv99~Olny;-WvGdF=M!B8BY`wmsoCje#69sjh zyQttw!+hEXdsK5QeStar7*47Lwfi|Im*7u}(PVC0soVBR)a3*EYSG@!4mscapJ1^E zv$&mDoFsUIbPK35>V8$w?9jBU%bDhFkTuJG6J`Pv`XTT`W{3U}Pgk_lbgk`ry3(94 z?C_y>sPO-UINTYd!LJocZ0^G75}g`3#bGoV#=s1k(Dw{iv1lBjvwqDW%74AuNo9;v zJ9kcL5JHJ{^F0hgE|PDJTDw2BsdZCsr(JD_$JryyvzHd^u(Qk`q1-HrQoCmdjp=<} zO1b8BKuIxwUb5EieuDNp|ISuVYzun3LZwyKXcn^GYz5Z7!^^Z8Noi7VSkVf*E$E zlW7Oq?9xl^-X-?Pa=Z6xdpw3%YKMX&i1p903VH!1<#nk&Wp;PxH9O@HYD_PP5&9{l z$$iW14DK(Y%;zBjQ)hv|Mz325n_+&fmzUVx3DPO#?^=6wVXd84YfmV#L*qnKl^r^? zRthRrRJmj>gfAF(Ou2m+0L+$6t2aq=`>n~-wMi&g9noG*UloE4^Nf|;ULop|9rI}j zhLzpHjptMwe4V@0%|9&V@^-3xo#Bx6tY2(PMrOt{^@vQ$<8JNx|E|y!-U9E$BVpUE-n{9x}EB*1EUocqI+`(qH#z&D#m1fj{qIT)f6gX z9(h&6eFu5*)>0G4GCdK?JSxwQVd2PdXC7nsJlYPNXlGw)kF2#zSF=4Vq3`h!A_QHy z&Q3B@Ry*d-P9~B0|Jv?8QQ5`Xm`Of`mgrvWBFCGEYS}J6;j@bn?xYHPbivv<;qK8a zN-7V+EcTdmjGcbE-D8}M6Ozz6NCSGCzS+j+;U=#fGKy&ui z3Oih4_WT;-CWJpoNxZ<4fFS0rCP6&?e_0TB3qd>~1@WM+2P-NH#ELYZ)r0JLH(`1o z0APywguXp07NKrlFWerUu7*VKr7sTfc_r>4)K`CEV?M)SV#qvG50+qqXZ{4r1I_OJw>V_%AfbY zh*V>u{OuyjFM%SvQU2N(3-k-U=P!!#`@7=~~ z%dmCx>BTT^S(a`Oa?G0pw1rp;;1u(8vjX|`D@p*xj?=t*8E=%LfDN1X2gpgESdQ!f z;#1_xf$5mDc`HI^8(>x_%4J{}o&F0P^l`#GmQ$%UVBU|Gu(=R{+bp~PFk-L|Lghn9 z$=58WplF1N1(0sOg@Ir_ba;E25l*(nOw`qO21-(Z?ce`GNrYE_SA_Ym zW9U8Ct|e|iUWWb5P{+Iy@<}lNwydNAZC9WWm}L*0SX*ERCfP#|!QQ48V>Qge(NuGS6!Ys z`OO&)B(ZWgVYm|wSnTfRGt0@d%YZc2sqgoa3Yix}H!{rIpsYB*Nj};R&$ct#Ny%P@ zl7-=5F}!Z(pA76W=m78dO;G9r==4@7bYJ4nd}=XAv82$@+6w|uNLms&xuZ3aDWJrb zzk;e4(n=AF0g$x1&eAv8Bi?ma$Tut5pOvF6Y(5z%=d*#wmbei;$LZt&W9`^FJE4M4 zEB0SSqcqS&sECuvp+u+=}f|bNM<>o78(e!xDpWzA?SN9VTo>~xHI{I z?RKX59U^h`b|*;^4i=&+XH7@e97St?VzffY?JJg>5a*MyC7EPAgsdMFvaVp!JcYJ_ zW=H#0h-sHrfU~~}Xvg*yIIJ|H<>+#!Fc4f9^OveFdfF>|z za^=}h{Oplnc=FX;VSnDsdoTGv7Z7H3 z9yy8x^X3)$4$RR;C~Xh(GdMBK$0Y`ZLb#ND&8h?^9SsSl&UMpdqe5oeTF(L)Fa>mI-3P zwW2-2e8IuapZasj>zkM(uRqBUpm5I@^~?wb_3!omfr{$uP=8L7q2Jzk^2iOFVKURQKF z*8W9@WS^_!BECiyf7(a#z%dmVhhI(Owf5A?)$j|K$O~>V3Q93Q$H@e^S*KGtn8kQF z>16rgz;B?rh=RoXmX)l=tiK4;(X$NY+m_Kqx|gig$ltN7P|mF(e;gns3Kw<)-yu=BZ_0(@?K6R>$o$ zev#nsz`%r3;t4QPJ2^D7S;|j$)|EgYyazsK*=i*Xm_IXB4{jF*+c68bvanyblY?j2 zSrbWiJC@P`4p@x2s0oF+L@3Pu?vPFp8Yw1`eDA-A=R!CEEU!0~l=~tr;$baX17-&Y zX!%rO?ph*-Mrh{EzJ@nN1No3-^A?A$mvgL!2#n{4m5AFh?4jmI zI`&w5xB@N>3xp7Ig6n?GsD8s0gkP`=IST`_J7`R!KN7k}G2H%f{6D->zh{nP=K+CS z0UXl^9owWpcjT5-*!T-S1OtH^*KQAP7mMV=rBShQ$C3L#eEPp(2?g1`%-wdmw|8H) zlvfMITadt~Si*5iUV^CmC3vs|*t<(<7I!TrBMIPM?)Ig-lP-4K>SVnupN@-%`@fZO zH4{4MGrOdba1Y=lLjG%*c>}yj?+P0i2XH8kZ!FMVxcZ8K?T>qjXYTDB&%{)vReSNw zy>2|yUf>I8Y(8i>Uksh5gc?EgbAAxwA++sKbd9&2q14PYQQKo*JS@0MYUg^Qyh z*zH1l)mwN=>2pmff8+WJ z_VRfpzw9cyxRc3z+F~Qcs=kBB@r85ttJpEI9}296qkf9w_PsmMc|t33aWCc;tKZ;2 z_iVVuVIXd?B6hc8FZ-&d@1R}9SBM?<=HVrSzbVYyhlgjUf-?(5&;4*+siH)l#o}%& z;xaq*k)#3R9D8TQ8(9=l25_OBH4!5WWEJAs)0P#2bYEanv} zc*?{c61$v7SLg*h3U&lDKuf6L{bDa6?pD!pFsV-7|FhD-U7?`K^eL82Rx63SKZ)Ap z#umE3y_XsNIK!8$%T?%fTfP17p$cvTNsqo{vdCqcfg9BLn`o}Vci73IO7o{>t5HfZ&#-WC0$*_x zPIh5C*5R}%jH86rRCljgp-4Qnmd6r9CWq`CwwBi!@dRcGc*TCHrs|9f(LG1K!-)u00Iq0W2*zR#~GP;}; zLt#}6J~d$(*p9dZ$YWEnBf4$hGm>y#TWtXpOBtM9%Coea1jfohB7|f~S4gs~Dww5s z$<~&LDZ_y{j|+GC3cV!BiZ1C+7&R_evfspvvt58nIZ+dCgmL0I=CUWtq10in?2g&o zX;u_eFyr?w*NFiLoOQr9ANLl;BXUu^fYW|D*2C5~Wfi_9!XK8aqXXM+6I`-&C_x^_ zlR|tKcb0M9eoTyi1VoySZ}&0EA{HxMkm2RNNsKB%tm_ZF>7qroPEObR)+XPgk~6dp zS7+p+lE1-x9-dmkYL)qZ_ZyH2`4HpEXMoQ{^97Gvsa$kqPTGZ5*9J&-ufxQVrNegH zQz*Gqdqbgc9E+vM6ra|hN>AM-wQHRt*A-AxE%!&qrzl9gw9ke6nnc{dHk zZ6!A#2Lb>&ow#hUS3%n5C0@G|%(v}ztbs6*;#aE2>3;R#5d3uv(lw`XusKxr?9F=C z$A=J~3x%XPfhtrKu*ErRiLy9P;t_We%g^wrLM$u^erSUvA?zzV+wJha2#n3OaDU`{ z`F3HS^Lh2DmH1WXB3-0}E!WD;RQVy7_OuSwrs9 zaaTOuu7PV0woShXZ$yy`eD|+mF5!4dT%Ry-PX$A~D&WKfnpIq>Ak7ywiSh8V8)76vicgsnC5Wq(G>l{ zdlI57ye&ulI%fAk7!sy=bOk?DG`A*N)3{KJM5=4%w9VBbvnNlF7LABRY8F@3G)L>2 z8Y9iomZIS?#UqL*Oj)P_Gg8}DU%w<$SzkA|v8FoGR9o9x6D1mBTAM3dT5B3Ao5xJ& z+_9C-6HjZHP*hac*jm#PjZ{}gD}TO+(Yd8iq%E1ie9U7&Q>*A6^%2ol?_sd`(rfsYOF`ZB2{T+)_ib zty)|escosL@uaHNwMJ?hnxjj!+S>ZI)_DM`Yi+6;HaxPhbx~_oW#e8MA5m3bQ`s_M zp;jBMsjugmsH$wPtf~V&nih;=ZcU`MZfOk{8|oVCFcpH|t|wo&(}$9@o0{V}i(NUxio05Gf?o)@7`oX~Ti>)OQq$7X)H1%9 znf3dQb9G^43=(kCX_P`OyF z`AB^=Q>u(=^*r@7B5h?XA6lfgzH%;2iVv?|n?I#;Nqtjg^|5t}YpS)T=sYYJl6x1H z12%`XqpS8JW>IOnutboI>ScCKOA{0Wi&QSqYF-@;bD-Rds=ynRsA$;eytc+xwq;tw z9MJ%6Z>?M?lwGRI{>?5J9^a^8Iv|`#Ra*-rUEkJ#8i=yF3E}|ds;26is)cBe)YmjZ z!K!N(Bk$?%qPpljSAmO)Jo&Me^l5Rdt`xDZct!w{YpH2%tKSFKD4Jv?LDmZ();BfI z&Eqd6nmmXKB7nk;YN?6NYaxA8&SF2D$AtYB-*L1uh^PJcFTN$L>?!OPoI|~KEXH3q zttQ&mLXwU~8llf~;oX{A8==F|riM9MgY+GdBPSjMHZehSDy!zVVZp=DXp3kCH8cYl zIs<6fAa~r6ra7m<@N4z;Fc$2MU??$jtyo%Qsbkk`(qc+rBemK^b=5Ue8)E!NS9Y*y7!6u= zGoda{)Nli+A#Yz%9R>y^Dn_-Pq*mk+?8%0>=>zuyNW5EDLx?ghX&mJUhZ0YYSQtrun9e zSDLFPG zQeOu%;_6MU3J+ryiK9RYN5~;Zn`-H&75@wxiAJx1)GEC|tgQV@4lF`!$~p3^L3A7sX{0@KTbkOM>l(44KvYI{4|+bo zi{TdWaI2eOl!3MgD2Td>ia=)}A_MZ5@X*3GN7`DcsM%u$^crB?AvC-aPP@AX?qj21Q1Ha{j!j z_sOSdnBV47gcfP8tRCU(4$|V;;&=?>i`C1+mryho!TtlkBmt;{-}=R>{m53t!c`Qw z*0R~4u`53=odwZo6+-b@Y;+;T#cF_|A!0@)SupnOT6A7rt5!=>tCV%$dqc!&6xi&I zK!4)%*crWg+c;{m&tIuc#dT!YpY3d-2)Q>5Ir_=}2sJ5S!7V&$?M#{6Md z3C)kxVh^GbT?Cr7O>!aZLzI=%CvXT ziYiEnOqf%LabU^%;XMb4CEhfjAD~=sbB);HHHr#psSNp$R(nSInvL@Y@lkZ z>YET+jij&%V*`VY6k^TAW|ggVSJdSY=V+ri;sR>CdqbzKy#DtpDiOpeJrsu$PNr<~L8d=a*2c_z)1f4ujF?$|TU^Z-QVUDeAosaEm1NN{{+9=bphc^G%%Ed>h z^MmQ?ye4*PV=YcmkvIxrWto5&t(n3Rc$=nr_ZUc8Y%z~eE)J>}L7ot2OU+!dt*XRI z@f6k5(`XZgv6ZcSSj3A5qHdnkG9RebZP?`tH#eW1O>|yUTPq@D+P-r%!+SYix>yS2 z8^q~^Je3)SO|aPI<*^BN*9n4jdGx~bE>5FnHiGBs$TV!AF#T|yh`!i1x5#Z{&DIPg!wbKyh}Dyra|04wW0M#-Sa8KIPnha4wIpiosL3<) zjyU+>qEUH8!wZHL49y$T5N&I$DVSkqEhg(7VSN*9kFIb>vU-jKO@LyjAkH>7sT z#3S&{CU;14OH-6X-60@OJJ=z$jZKuVtBMX$@)bn zkRgy;WkV?s#r%v%F@d^f)zjs z%{!Hm`hJuM_x!t6oHVL4o5@X$HFC)cZvYb@HsJ6QbgIHy8W%i|FTwx_5PptUWYI_{ z|9lTq~T{ z)KF76cTQVNbs<88LNETJJwicMl~$k?Hr6dJM8MQiQ#kUp`9;-54I@q)Q$2d_X-gK2 z8nbjk{oDl$TF0C=d~VgE#vya->*iDq8CEcS^pN7>A=Nbt3+o!I>f5So3g^)N+efNp z!Q9H?VMW!&!xt0}om1b^GPj{_(dc1An}-%v7B|kR95T16YKSlcg& zw#NC5P3Ww?uCZ%LE+o0f@cruv`q}y=qgN8FI{08Y(ElB!-!v_q z8S8q6e#`Xlp&t=ox!PJVkDLp3osnAD*}7V|GOntwYZ`_OPok`7j1HmDu2B@Rq>w3L zOFX2maU2$p8*rmR?UFc4VGLunv{gkpsNoX&z%O+XiMCXdmV5gN9Alsj6NfYM+Pb-v z7cn=YU%G07=m6K=sJb;;4K3&2x+eYsYi!5pcpVS`5Og&WNui2Ksb3l=E`tE8j<3iy zx1vJyf{Y;VW`^+Tv{#e|ZK47)!^*9yM@fWX$RLz#YFUDyrnRZ9rK$!s)@;1?5HErB ze;oDZ7)u+i&$LEg>R9;GuMX={=QaoB+nhT^g&)V4_n`;%8CLLFL!V_mYiuz=Wk!d! z#eC94#gpc1vf?%KS&Ja7yKDh*mwkzYic1{s7$}!If1rv#h>mA;?76f4`c$hwFi%vN zQwb9f^h~un1m@H(Fb~kDSqD@Bu8Mn{MtD~`sJv3(P4naVI`?Ir9rA5EmbM=MqG+wx z&oJyI+QfU2%HA2em_gXZ&Y_4DR8CLq5t&$eXi+15uE;aXd4 zg}cSxZKG@OYzniwPcYG4G+$J?0Zsdc*vRN?(~5S;W7! z!P*o5*4 z8*d$&YF%O6X6RFKHv(R^n&INC(uIBa);fn)@JzK@d?3@Ilhaq}{b)r{>bF~0*2Fg4OqdvfgRSUF}cy*c+pRkYFs+1 zbxd>Lz4WG_{$l;x!l=~8-<>hE!|Gm)PRBIkivUq00QpV1epuXw)V)6h-~V8L1}##}^@yc(_L~7an`vX)Xphi=n)I zJFEeNgPbb@pM#53Epv?9-HG8&_}mw*g#m-j1(?jiMaZizA-&{-$_Nj>lPMz;94xDn z-ANlGYb>p2my_0W;NB)}j_QVK>Or?m|H0`i8Y6g4m&Jj5qEOp?1 z{ZX;Hd9*YkE<`6CAXuLcxPbek1BBb94!D%!bbyfJb-;t&4;^5RV|Bp8-=hwwE=dOl zl?kEvbU;@5bU@bp1|3k{mFPA0o{{1)}$+1}dV{g(ClHH_#sq3d$U+V9fsZnjcC9DrtIF{Xe=HJcK=D5l) z0;__ZAXf!%3wDCMEx5BY^4x`Z9HotPJY$=h<-kD-VSi<+kst)h{Ja!-k)Ty z+uUy5pR_s!(5q9fN#*i2sq686Dv(*9c3m0(uSX+?V-TCL?{Fxh^XJYM9gx>+`H{vIzAT4AObn9pYh-;$hPu z_S22)5$Rap8xNc4>S6OGcsJ`W&YA$Yc{lLSfPS*|&%g_b`fTfk#5Y0!c_XwdWUjls z-P#rUPYA9534M_a0$(Jbmx|W&Qa7fe^iIZKX?TClSQ7^3n(&QbRPG9Y8b-IDhW{Nl z7h?pMWp2*o%sW{hWa-np9EkIb%l6|28LJ)6j}HBw6}Ub?zt;y=r5Z&Y)~eJiQmOoX z>RD-2emUdnF#Wz6{ya?e7iMnEq~Dh^zssch^-yPq%X));eGK@z91WJ&7-x}?-VE=e z0qg=f=9}nIhT}xdU=J(4eWd(ZKUrdA^jtk+&HcA-uKRMO^>6(z28w?%5W}C082&!f zTmg@KpSgp|JDj)i)C|DhcFqa_jKjU>CpnPA#g^4^Z*Cu_Oj55grKO_qL{4wL@ z4E+2V0>MwbJV*|DM2y16u8-S^Q2L3tLRHs7$1~o<>O+Rep#Jmlg-}nFNgOC|%)ASV ziSo-3D`k8nDeEMRD&s0k%O@dxVm*>XzxO6TN$$itH|=eT2d#@U?#iIwmovWN-?iZl zG>eSt>~>Wm-H2+|AN3D)V*xb<3r3bP$Wa{Wy2YvFMDTIO%XUla;R{w)(q6-jFnb*2 z3s$JfA7R2H1|$tluL!>B7NSQFLRL`SW{H(0;&H@fj;gY>AUt|7&0LJx zPs_r)BtTR(YQ|z3h4*nj9#h68OZy$|Pk(1zM(Xm6{h@=OyAmHt#Lq*C?A=AG8(+?{)NGf!98GH7+M$7@o%y6n+RQrH>G;tK1P7UkPn72vDso zxkd27!j9+qcL*ePCM_(spFbk&64QepNzOI7G@Vj0=Ai1#Ns%>{*4?)lSWRK`NnPsCrrctvOPXeli2=m)nWJp4SvI!k{?xTsqbcVH0-W;~d8bct?J zyGzQzhe5@clk2Wq&1u%6w3*hDf}HDD)?p>}P7wLiVP<;gi$d^pK;;jWg)$U|j#bF# zCZ3<@pd#HQJds*1PrNBn1q9AX zF5msc#Pw^E7R29#a0&IZ&|y#^^m8ZfQkTT9^Epr#X`y`nLRAT)1%E+@G4K~KGP(=T zCoQ@bd_dyotLfpREmaE=#^??!n2!ZQ4P*oyUn2$=%!HxH?8%+rU+Ja*&Lt|=vmSgx zb|Q~=h>-J%ti!$#1bRLMMS?eZ%lQe>jI{4Qn1`TB!iNxqT0e1<>9___>ol2#G?|4* zQ~d+Za}G`LbI!XCCY89+oXIY3vY5=|W5~hAHDMK^9#;&sphEC=x(i$q{>hAXy$Y$x zw+gARk!}dYyVh|=%W~@MWLZ5-$6w>>K?S9e-SQQk%>zaQoQ#A5Il!xnA)iF^nsfl@ zk)`2zRVY{mFzrd*F)iKu^1Svv0Q2f2N?{pwe7Iyw9otpOa(7}=3wlNJ2yQW5pC;o3 zXNDWCu@aoXo3(4gTMloUQZ4Cb|>>j!(6#Dg{t=$wd1*nLlKv!16ne+8K9PKW3hhg{E_}He(|R&_}YL zeUo9-I)4ps#m!) zb(gR7-?XdK-8T9+HGF)Odjq}q6bOGxMW>*WK_7FuzeI--y+r>`PvQPO)%#9A(?HXi z#tTM#(<3P_rJ(7$)SFZBb93s`sqqlcq`pT@Kc!uf4v%hHu1GZ2JmLY$>UeC>Ok3fj zvB5a{Sl(b9J5y{h{wz6_D(V)U&HYM=48*PKprWb{(onVJRLRyHB%>NuQC}mZl++XQ z>e-(UnxUdo{X~_m`9$#{Vn*s3og6f}j5C%NW!rI~{xKZM>Fw6`lt-Zs$h@EOEoW%O zj+4;Gvl@vY#8H)&1{Y~%Ma(Gl;l`9LDOf63| zv&u0S<&({2FabbBh@}TllDtS8?iQWRJIB$GAXim)pjU?>t6C-316f|cpr!9?BpcoX z?Dpu#OTXWNV(BXgCD(b14_f+=(Y>-fnPtRIUvpHYrA=q?OrI5GLrLdNFDL&!nJT4C z2ZtVX8bhbC)Q*G2S9jVJ@~5PP6*8{I-9$f5gABH z)#Z70;6c?YDdqX4|N$@sSxCcwAN1l+9f>2WWK=C0ABz28WPAx6tjHN}`1~qJh z^1&88V!dW@=3DE(oM9*+w7Ce_fLYdP{UmF28G6Kr1mZOpWA=(io2^h70I-)|B5^hS zB$A9M$-RZ&TZH)Xz}v-!aB z)E8!4fxz^tIxwwjmGU2i_{g1cUn4319-;#Up_Kn<#fK*u=L&a_85ml|5zyBoCd(}# z>#_%sLgPy*LuX}2un7bpo4_rKu268d=xjcDf*hZ!8|2kte5zKBZ;*d{zD6>Ey`a&( z2CzmC7$h`WL8$Rbve%u_zK>x#e;-`NAeMG8R@=?`gF4OmgF0T*d%X1yoje|It+Ky!@bjIs z8UN)6zp*XwOaSF)0^f-84GA|Vp!{Is*CG6T9r`ImG`>u}I0eOvQ!YDV} zEvY;4vq!f4%n$|U2HQR2hRW|47h=I)+ztj-1vx`KQ_FRUU()X0`i%O<@5KlL7~q_= z^KiB1;&#LXA|lvh$6V?B=!zmYpU zufr`(=DP1!TIV@0i$naE178Nr<;!tDR>H;vALf?CZHYkGmUsuQxq!eOeDMXCyF#Ca z(C~ipm0%qWuciDTGMA@bn~H{ir~ZH|P+zVDv;Ltt+K@8l-_kO1xo(|)BZZ|m>bKIx z%?lIOCE#Z@&Q)N(w}qY#VL?0{`Y1%pIOgM=Tu{apmX>HwxzxHe$x7@VL}mu^L96e< zvU0Qij4iY81wIML>?eVr1IYkx#yRG|4#v1DbVDd0(V1cAY?smA7|yGS??MjfGI*k_ zA1u%N+_HshVI46Ld`ZJa$R-2?J_;dQAoyzn3$*q$r!RJSR#5d%aa&9=!rK5pe`XNJ zSHvM@Aa4&B+7?r0OAn8JNGr3g@ zY2W9HLsHyhMi+@@A_}>jZj8FzzS>S$DlcbrSXbNE*s<{Bbv_ye?y_JNHPpVTDN;aYMoExOzyT8c#z zsQwT713J|`pg*O%CpD$R%a{o4vN);9nI`vGj<1QBx6ncw8dUW;EO%m{&L!eMt633y zR@2vav4@&s&uT#B8g~{dphVVX&NhdBA9Nn3U*<9vidBo@M2;Ype#Sr|SO*wx-Q*aG zIQI1gM?_uWhwx*(kn?+&r7SFutZ8fn?l#s5JM)8iA>vV(g(vI}ZD|HT+e1os@X8l# z%B^&Hpy+R8ia7pY>p`RQAqLDPnH^Su4okAK0|0UQWwH`KEg9+~BocJXYTRCpplk${ za`V>6U-XuNe*p+B_(H$g6gkp)k^8T8jmSyA;T;@ul0N2RA^Q8i~Wi_gxTf?M+&q#z)XY(VINn}i3)mpH+e3`^3 zWsW>>?2Ev!f}oAzt-c=WrGh&)j?1OlD;Bc8+VK1;FzZT#aLBS z#Xx6ObDM-xJ|sOrwHi8EOh?t?Vwf0u_iE@~d=s{BsGm(7DFnJ(OvvC<*K7J^uq@Wz z`7dr$lh5Ai!9Pd}a{K8P6{p+}aXaGRGR|9C1uWExS9E-@w$7vQ`ODDiBr(vj5~v(S zo?ca9X|o)JO%yZz1NV{0Ji`!G$AimOa5xX1X5}7^@gH7}B}a#GKCoFyAm^Q`5z&|$ zI>b>#HIf$}=Fx6k)xyW3-pW1{5z(QC^9}|b@eXE&9EKE%TXZ%*PMShHG*yQSEUFIt zsamyz$p_=^4$aqyK_$gsVDS-EJD5`yAGCvk0^BLf(^%T*PgPjjNlI*InirZ%ysl&R z;BpjPPG5+(Z#k?@`80WQ?R1iv>A1FRzHiQG*$bJ;)jJgj80q~^v ziA~NqX}6}S4GENoK2C~@(2YjiZ3<>{%8Niloc^NzrjFvpsaNrxNgZjArO~;L`*8-l z$itv_!`9GFYK@M|t|#KM>vr8D7i+EJyT^bOJVk=z0z+(ZDwA{;x#W8LE~qb$F#x>> z`vM+niZK9VB?XOQ61X*0bT(JZjacweS(hmSGIEWoid^Fqa*cE`60VVHs77@$a!7F* zbK95fEcRMKwV8rz3a(QIh!$yFYs71X#?!|c@9so`A{>E5*%kOZ;uMN%;~=1l)J9s! zALsW&%Q$0cW9jgEhx3s`zmElXoQDZSJjMZwZ6b0KauuxKY2N}@b?2)-*R z$}xInZxmjgOBKRC#}#%BIKIO^lNi5;?lFp3k0(BdAF@i9OQ>T|6d{9)Hd9%fI};yF zR8~nWBal~!mKIiUVLrDSkMoQ1$3U6b=zCx@V{DK`L}O~m=qu=0qpxbw6|LED8Fsw5 z#fdK7p(8%9yjyb3;i(>Ui_Yd5ydQ>rR&{w^9fqN5m6gi#8+~6R2DPU%X$7II)T4?I zvQmhAM#)I~SS4OnVQI%Jv7KdKYIhQ^2j>}mJ~o>GV>5wHEqS&)u;XKdX%W$w8ir@1 z@8Qti%gQ+n`gYg^Hu@mUMt_E6Tb^>dMQ8ICHi+czBnZT*>L5;4yGL>Q8Zn4HiBmx+ zah|I9km9uDVwfpzh0B)3Bgjk}hGjX9<_wmVSWh%O%c9*XzOkFNhF}M)>45+imLCpx zrVP);vtWQo4K-^Ck5YjiiAx=lyd00txfQe^Pm%OXh0$@#2dgFT0*EEQQo>_d6MB;@ zVnf14#;ag(Fs2Y-p3OEGgg{7aa^?&x0|8Adl|j2(=2ai`iV*+>S4(KwZL2Jb6S|;R zBw%!^z`0Y}HFBp$utVZ$tiW#3PF~>NLysp|NYxdjEym#6c{V=g#ae>F4%tcjUy3)`4+~8Cf?(2;F+%pZ+?m9s`koE$Le}{Zbar zAQyfNTE~ls)`KpV zW+kQ_0BMhfl*W!Tm&1IHJCg#QtHW=H@pE_9D_MLUOGKW|&n~7K1u%N_M?c?YUYdn| zV1c}T4$F)k`9Xj?XbAH-WHIvV!!L*Nvo`Y%X3<3y^WdEBq7Mfv!$&cDqqf>8+!;Eb zRN;fvKO-E&T$CMD;5q#eZ_EQXyHP))f-HKOT<5zA?Wq?(DOL| z7aoM_j1^7?rR`lTK=1(pLE#H9< zKc-?(CGuZ6Yl)jjLVqFIAe0)NF8B!JCH55}i=C?-oFwZhHVNo%@c@2w%3pzl1h@o@ z3;$g$aV#y(TKD@VT!^RJz5Kuwj_bi1370I2EvhT1Ej7DkG=sw*WHa45`2TfwEl^q% zSGxNDZ}3bCW}OZF`I;BeIzGph@Mqr5{??ldW>1g3tc@&_PbSetGj<@Om_R6|L?lD?!8rY z>(N!+w{GDPQE5j#Z7das4fSO1HVgVe-{G%veIUK}EUqYq zyUUI$qm0yVTaZ8YaGo4&q#m)+aj8QqLzb_~L@HbbeB9!O7#+qjFkS3qZvu`4#=xnx z1KBnhS^bq20FzjgeH7_;7B|vl^+OBl9iGUlgAol0HMZLhH`LQDDAW!%1-sBj#|w6g z#o6?}W{u(uxxf3i62M1q1cY1@_Td$$NS5_}u&%ItZWB^Ebcx6U}iXco@~ zFAyROV`!b9#FTtI2H`ldF}Uus!txEc)q;9=5Mjol6eOs8tR^4 zJEm(}X+I+)0rxa?JO^^yio;xdFEhR5pVrk z%eyAR4H3E+u0-Q>&hQuPw$!A?VW}`~1HMed@y3Ry*?{wD?-{!l*UlRDIpPXLS1dNf zU-upcwLC#o5TgnFy3=D?C_&RlIth3u`= z*|Wp+6IN$-_3FT&@5rqz5S>GCSZ)apr4ekj++v$xTzKHcBhBjdO17xtjpMMW()N79 zF3YWBk`K1$M#etSSo78Y8%oNoQVW~xzLqsyPsLe(yaNYr6gM{ z!Np1CuUMUcO(J^!6XVf)&&p@wE8EOj+H40&T!SR6o-0R(I$KuH4h;HEf0iSlXTd?w zf&3>{k*lQ=GI2NkwB))z!)IM<<&k;lz_fJV;5|5`$Dc9Uh{p zE=K#kIMf!7$Pk{wUS^*(RXr_^z@Tr+7dWrzGD3nbBRG^nuu+$ZeNBl)qVWB_2@(qF zG6y9e_Dzsi8zOb3mZSE#iUO}T#Eq9gS*eG6{fB)Uj;g_{4MD|p!-Q_w7*xZUE07Zy zSYLI9xTJnrXaZwIV>c(1{*ZnP8#+U32Ie)6-1x{i%I_+U!f-?{ z$e(17J}c-YIz_AveFgvISZ=^O!W$0YqYC!W!{O2MWb8)1Z3z~bk17#(r4jIy6L41S zql)(a564ngS zUl6f255glRdfNy)nC2rMiIWm|7u4uF9zZn?^(gT1@IM^c6~Mk1jX=L)AkHqXy+PI}n9X@1Wb z4)YJ5xFi_&prt)=9rk|2ONr>W6JU?QMqs;&LRmzNz*j zQWL6uy2viQcyc_n^-cI=Lg_&umzPda_R4gxD>Hi=V97hYR!_%kCm_7f+wbY< z{g9I0zSVR@p5~sB;PBuEr47P{*XDJr8tqQXrR`-#Sarxw?im(ln{Qo;V6IbGRcwqz zLx}B7t{M{?BRMKIMmk+cAW&zAI!tON8u!cx>}2%;?@?~^kMf-LD$H4T8CPty3ty*z zxYIvm5r_Q8*ckFL{|5NzLLfh3a(P%x=@>pyn!45KEy8SR>4J`PTb61OV0^)f+dAp-G>fa zB`T0ed}6{vj!N*HZ|=}TsmbISS=CC}p+|T8S)IJ^K?PP5XOtiHu7dHdta?Iwg?&8O zMB>r1xEg$&Og!m}{%&8;yZt@BL^y@^%ddBRHR7?1Pk~oP%jQ^463Z|ed|h&~sgq5T zaN=ep@*ywf#YX-9&!PP`KXj8B*Wi=P$t2i}A@AsgnHVFzeK-h*#5Zrft~L z56Dv?JQdpK;A~`d_5#$?naL!pAb)ug5|iiMUg9JZ7$bovu~8w+$9C;dZFagBlSw4C zjAukoNXgA4)`3A^&zCvtr~$!Y5-T{UL9kK-qcM)VNo*{VYXDO#p2YI&3QS_n>k6B$ z)W9*xhpBA$ z*y#RE?}HS+JR5Cm3HmRnw1WlK9!R9^Cp;$o#Cr5 zM@gHYNm_?Zogr(nL<{&)Sb%+xoL&4gxvn*%rZ^==OAs#Agi8(KQf@O+bQWc}+<&mw zX?O^}yAByvz6DP}_TCD+P#wU;=G-}mx@H6ZHf%!kkHu^{;q}LG!h0KrkVqtR&A3pf zH36XR%I~@KRtJ4X0bla&L_HV6(74{)K=BXGmO+`h@|5ryul%KEseGXozU$`p&sKbn<@e`CU??6#Z zDymVwyaOebh7pAFm0cN=noUctj>DmbOI^H?C-3@1UX6>_^77;*mGXOCOe;Jy|K6i} zg6{>&-|oV45`8!-ZQE{>I<<$;^W4^CP%a1qi=bK5~yMt zwzTKOr5-$0!=(2h4eddvHxM<04S6R{;!UQU(MXvb>< z#Elpzu78dlk9zc+=Y%OYI?kqBy)plauf*l@0Ka4nsUq2x6O?|@S7Owp6+XHfPCT|pIzn8-J9IaLjz5e>>O zb*^50%17@$-@zkk^f={5o^Cf1yM2vgA|clMD)MZEIM@iOw6@e-r-fxSdK+5wU$JDP z14Mg@9xkGzWlxqVf0QE&Xn0E;PSNn;${+3GiG~hUeq@}Fra4#nOI$pf*15`G=3vvb z#6n)0)?+Sy5LM5|Q0!pCFDBtk&m)nTgbROU+kM=lFAv%?2rfK-j1e=!V>o)*L@B@4 zSzjOW=)3st5l00y`j#BT%v{8htx1k0-RMnDsA(eaIM}DcLfY-^@vvIGAEGa@rqiUx z(}a-bTt%za(mjRu;*m4YMG;k0(1=k~TMv^cy6_U^%Z^CG#BdOFzQoa{sc;ZYo0f}$ zGw2w}pg|bS99&4Z=6|MueqH#rV(Ke?w3yy1**S>5Iq2u0`sW52KZ!~!Y3K~PXbvs7 zl9sKcY%4ybJdH&6aNbrHhn*#bja4(6E^~ z@c9_IoQO0VkowQ68SmViOB#=EjE`bWuE#e_Ma7t0Dtw9SABJA6rG;LsrG-9b z2@TU{<%?l5scAIhQss*&GSe5J%SVRC=+02hT335|_?dAr{W1M#^f@se7QW9oI>Yy6 z2dDK6^^Cv#|;qjLy>SBuu1+shCPTSW)H2 zl>Y?>n>niZ%Hknm5Yjv1;xSAY>B@M)p)yp6QR{V&e((Lkqrc)P5$x%GE}$2J6Ua)O zt`u|)bn)F7bk0Pt?jPNCN59lvJAoEgwcH(kiLYbI7gw_Kh^wC_W7$O%qQgc0;S`l) zdN9w$o9BxSR&#iE&?yq?C2xVACff7+tiLepd2p40Z`*HU~y`ec1^y6%zT9 zB3&UTUA(D~n2#u8|4`aD6#ZApDWo-Jx|9)XIHZ+;v8G$;;?JdejNjrtiFH&t9*x7r z8yy^Tu<179M@YJj_z{wBBVI~L9SKnL@8r=hGOuOmp~62G(l?5Kj;AEXe|o6oTgYof z3j?!!JSgKRpDKr7NjgJ{qbP&*)dLRBqv{KC;7Q7l`|8wAI%#jwz9M?P=oXB6kzY=1 zH`@u%mni-PB0rzX*5trrXbRS>2@;^ta3Yt%U-#%&=`Z=jE`N!A{SrI*jZ=hh5)7IX zbOuf27`Kt;Z--OdKVpQ9+|gFi$Oi3WR{3vUB)K$|QhKq#l{Dlm<@Y()lO{fLXsM`p zwDNzN6E9wnd5T-~GmlOLpGPx{yiM-);8XIq=&#}vlKWJ!5JQX02-JUZ4m<^GSC_Fh z)N{lm_8Ud-=|#b27gY~OP|6oCOx%!$VEo?g;!PuuTrACiJ(BVxcmfrbi0@>J9aA4bZbK2y|*{s+7F(crcwcCW#ts zPz%bX6d5Y3rjekEwu(%mNniBzz7XQgAoMi0b)elimU_Co_Iu`s_-tEfiHckpPveL?wRkZhI0LgOeXg;6^lAC!XUGek#Q z7)I;83d$GDWKJv}qhuT|2mGEBlA>aan$c#2TD|=MO?ZgZB8J*LD#S>?+@VrbQbog{ z${f@fpdv;eZ}e#VljF-2@z6tyaHoV!lJU{UBUAEUiccK@l~p{ zBh;|`%>b8x>L&; ztg3U;y+`ARsFhuzqvZhJ-|D(dAOZXw__ACi;Nt_(=cg1*LrRo1z8!^zxdHf6RqgaC zBBxt=*O~$IwHgoi8qllmP{Z=K8u4Y2q?Q;w$n@1Na%}q_Qeg1617D8(xE@e!@Ow1g zgya8@4S+umd|9emWpeWK2gb(**lPix8!gtW%MciOYmcXzYq0ZBYFnR*DBn({p7ZXR*fI3>a9KvwNf3xmkSWP z-!cGxkCl^~pS}U;9|4~A=Ei25#>)fHzdZoH2o=;{KF17zzX14}Sb1Eqxu>_Gt_w%d zHmz;r!=9C#$UM-|(G8Pu-hH;Ysk^DUt#?~vM;(qb@2#s(9yOhFqIE;;FzCjPe}pA= zuzM_l*g4>_!>p&`P=2qX!@RPZ$}pA;dbJj^ht{y(!zYd8^{n?Au#Aod2_B(**VuNnsvqe z*(y7C;o?hYEzB;y?6Ree%d*R6UAnN5Im}t#+2+=b;oODuFP)vmLD+TY^WnQ)n|mE< zQr(pPPcWa|(70qlv!PqLG7HwaNev%WeN#4dx3@vPOO`eu`IdD}y-goQK6O(|drLFu z^?BgPRatL(aVoO)~v43gfq z=4^Lc3m=G#d{BmH?}rTZSU&ZxVal5xTTl^quF$>Q{9_;n_HWDTyeOGqT+F6 zd;*otuHA$l&5B}{P07gkiT26j#l{R)Tu0ZImLzLGm6vE!x*mI5d%8ZEKripaS=j5c zSG8=~+yRNRXQR(>t*`Is>a_KlRjO{&wvOJWwYc~8n0u>)a1eM)Pq(V;?CNc)!$IP!Gx#G&CdF@p_txA&?# zU5RzQEn5-R&9APfOLyG5mR37ZwXOrNKoHv8Y`YpB18dP=v-{NmoRiDK}JKr5!}_> zj-lKM?CD%@VD~Wl{|9)1gQ=;rh^$VBT3EH6zbw^I^vAUEYYc!q{4lN4SGVQww)~;R z%T4BQ0#8LC&M)hwgO`TuDq)cBv;gvM(Krdswc;^e*&_zz?JCoTU;%YW4JasD}QHFcBh#(^IR8WN%jLffI3|(u zxp^~|JbdLY;5n`MwG%*`zsAnHYb^h(abkom+THi$@XNYM7CHBxmlPoUg1tM3U)C*s zp`ozLFCo{uasUE-_;LP4|FX_gOMt|6((2JbQT_#f2!S}itcy=xYbb6MLVM5E-*3Y>p^gfcwe1aZ60RJnN|HZEgrMc(wj~jshAivPU^=mth z8SW_G0#6x$e^-^^e`< BitVector is not stored +// 11 The BitVector is all one -> BitVector is not stored +// 10 The BitVector contains a bitmap -> BitVector is stored +// 01 The BitVector is not used (**) +// +// The serialized size of a MiniMap in memory therefore is at least +// one BitVector for the flags, and (optionally) additional BitVectors +// if they are required. +// +// (*) The code comments often use the Erlang format for binary +// representation, i.e. 2#10 for (binary) 01. +// +// (**) This flag is set to reduce the capacity of a MiniMap. This is +// a hamsterdb-specific extension. +// +// Tier 2 (highest): the SparseMap manages multiple MiniMaps. Each MiniMap +// has its own offset (relative to the offset of the SparseMap). In +// addition, the SparseMap manages the memory of the MiniMap, and +// is able to grow or shrink that memory as required. +// + +#ifndef SPARSEMAP_H +#define SPARSEMAP_H + +#include +#include +#include +#include +#include +#include + +#include "popcount.h" + + +namespace sparsemap { + +// +// This helper structure is returned by MiniMap::set() +// +template +struct MultiReturn +{ + // the return code - kOk, kNeedsToGrow, kNeedsToShrink + int code; + + // the position of the BitVector which is inserted/deleted + int position; + + // the value of the fill word (for growing) + BitVector fill; + + // Constructor + MultiReturn(int _code, int _position, BitVector _fill) + : code(_code), position(_position), fill(_fill) { + } +}; + + +// +// The MiniMap is usually not used directly; it is used by the SparseMap +// and can store up to 2048 bits. +// +template +class MiniMap { + public: + enum { + // number of bits that can be stored in a BitVector + kBitsPerVector = sizeof(BitVector) * 8, + + // number of flags that can be stored in a single index byte + kFlagsPerIndexByte = 4, + + // number of flags that can be stored in the index + kFlagsPerIndex = sizeof(BitVector) * kFlagsPerIndexByte, + + // maximum capacity of a MiniMap (in bits) + kMaxCapacity = kBitsPerVector * kFlagsPerIndex, + + // BitVector payload is all zeroes (2#00) + kPayloadZeroes = 0, + + // BitVector payload is all ones (2#11) + kPayloadOnes = 3, + + // BitVector payload is mixed (2#10) + kPayloadMixed = 2, + + // BitVector is not used (2#01) + kPayloadNone = 1, + + // a mask for checking flags (2 bits) + kFlagMask = 3, + + // return code for set(): ok, no further action required + kOk, + + // return code for set(): needs to grow this MiniMap + kNeedsToGrow, + + // return code for set(): needs to shrink this MiniMap + kNeedsToShrink + }; + + public: + // Constructor + MiniMap(uint8_t *data) + : m_data((BitVector *)data) { + } + + // Sets the capacity + void set_capacity(size_t capacity) { + if (capacity >= kMaxCapacity) + return; + + assert(capacity % kBitsPerVector == 0); + + size_t reduced = 0; + register uint8_t *p = (uint8_t *)m_data; + for (size_t i = sizeof(BitVector) - 1; i >= 0; i--) { + for (int j = kFlagsPerIndexByte - 1; j >= 0; j--) { + p[i] &= ~((BitVector)0x03 << (j * 2)); + p[i] |= ((BitVector)0x01 << (j * 2)); + reduced += kBitsPerVector; + if (capacity + reduced == kMaxCapacity) { + assert(get_capacity() == capacity); + return; + } + } + } + + assert(get_capacity() == capacity); + } + + // Returns the maximum capacity of this MiniMap + size_t get_capacity() { + size_t capacity = kMaxCapacity; + + register uint8_t *p = (uint8_t *)m_data; + for (size_t i = 0; i < sizeof(BitVector); i++, p++) { + if (!*p) + continue; + for (int j = 0; j < kFlagsPerIndexByte; j++) { + int flags = ((*p) & ((BitVector)kFlagMask << (j * 2))) >> (j * 2); + if (flags == kPayloadNone) + capacity -= kBitsPerVector; + } + } + return (capacity); + } + + // Returns true if this MiniMap is empty + bool is_empty() const { + // The MiniMap is empty if all flags (in m_data[0]) are zero. + if (m_data[0] == 0) + return (true); + + // It's also empty if all flags are Zero or None + register uint8_t *p = (uint8_t *)m_data; + for (size_t i = 0; i < sizeof(BitVector); i++, p++) { + if (*p) { + for (int j = 0; j < kFlagsPerIndexByte; j++) { + int flags = ((*p) & ((BitVector)kFlagMask << (j * 2))) >> (j * 2); + if (flags != kPayloadNone && flags != kPayloadZeroes) + return (false); + } + } + } + return (true); + } + + // Returns the size of the data buffer, in bytes + size_t get_size() const { + // At least one BitVector is required for the flags (m_data[0]) + size_t size = sizeof(BitVector); + // Use a lookup table for each byte of the flags + register uint8_t *p = (uint8_t *)m_data; + for (size_t i = 0; i < sizeof(BitVector); i++, p++) + size += sizeof(BitVector) * calc_vector_size(*p); + + return (size); + } + + // Returns the value of a bit at index |idx| + bool is_set(size_t idx) const { + // in which BitVector is |idx| stored? + int bv = idx / kBitsPerVector; + assert(bv < kFlagsPerIndex); + + // now retrieve the flags of that BitVector + int flags = ((*m_data) & ((BitVector)kFlagMask << (bv * 2))) >> (bv * 2); + switch (flags) { + case kPayloadZeroes: + case kPayloadNone: + return (false); + case kPayloadOnes: + return (true); + default: + assert(flags == kPayloadMixed); + // fall through + } + + // get the BitVector at |bv| + BitVector w = m_data[1 + get_position(bv)]; + // and finally check the bit in that BitVector + return ((w & ((BitVector)1 << (idx % kBitsPerVector))) > 0); + } + + // Sets the value of a bit at index |idx|. This function returns + // a MultiReturn structure. If MultiReturn::code is |kNeedsToGrow| + // or |kNeedsToShrink| then the caller has to perform the relevant + // actions and call set() again, this time with |retried| = true! + MultiReturn set(size_t idx, bool value, bool retried = false) { + // in which BitVector is |idx| stored? + int bv = idx / kBitsPerVector; + assert(bv < kFlagsPerIndex); + + // now retrieve the flags of that BitVector + int flags = ((*m_data) & ((BitVector)kFlagMask << (bv * 2))) >> (bv * 2); + assert(flags != kPayloadNone); + if (flags == kPayloadZeroes) { + // easy - set bit to 0 in a BitVector of zeroes + if (value == false) + return (MultiReturn(kOk, 0, 0)); + // the SparseMap must grow this MiniMap by one additional BitVector, + // then try again + if (!retried) + return (MultiReturn(kNeedsToGrow, + 1 + get_position(bv), 0)); + // new flags are 2#10 (currently, flags are set to 2#00 + // 2#00 | 2#10 = 2#10) + m_data[0] |= ((BitVector)0x2 << (bv * 2)); + // fall through + } + else if (flags == kPayloadOnes) { + // easy - set bit to 1 in a BitVector of ones + if (value == true) + return (MultiReturn(kOk, 0, 0)); + // the SparseMap must grow this MiniMap by one additional BitVector, + // then try again + if (!retried) + return (MultiReturn(kNeedsToGrow, + 1 + get_position(bv), (BitVector)-1)); + // new flags are 2#10 (currently, flags are set to 2#11; + // 2#11 ^ 2#01 = 2#10) + m_data[0] ^= ((BitVector)0x1 << (bv * 2)); + // fall through + } + + // now flip the bit + size_t position = 1 + get_position(bv); + BitVector w = m_data[position]; + if (value) + w |= (BitVector)1 << (idx % kBitsPerVector); + else + w &= ~((BitVector)1 << (idx % kBitsPerVector)); + + // if this BitVector is now all zeroes or ones then we can remove it + if (w == 0) { + m_data[0] &= ~((BitVector)kPayloadOnes << (bv * 2)); + return (MultiReturn(kNeedsToShrink, position, 0)); + } + if (w == (BitVector)-1) { + m_data[0] |= (BitVector)kPayloadOnes << (bv * 2); + return (MultiReturn(kNeedsToShrink, position, 0)); + } + + m_data[position] = w; + return (MultiReturn(kOk, 0, 0)); + } + + // Decompresses the whole bitmap; calls visitor's operator() for all bits + // Returns the number of (set) bits that were passed to the scanner + template + size_t scan(IndexedType start, Scanner &scanner, size_t skip) { + size_t ret = 0; + register uint8_t *p = (uint8_t *)m_data; + IndexedType buffer[kBitsPerVector]; + for (size_t i = 0; i < sizeof(BitVector); i++, p++) { + if (*p == 0) { + // skip the zeroes + continue; + } + + for (int j = 0; j < kFlagsPerIndexByte; j++) { + int flags = ((*p) & ((BitVector)kFlagMask << (j * 2))) >> (j * 2); + if (flags == kPayloadNone || flags == kPayloadZeroes) { + // ignore the zeroes + } + else if (flags == kPayloadOnes) { + if (skip) { + if (skip >= kBitsPerVector) { + skip -= kBitsPerVector; + ret += kBitsPerVector; + continue; + } + size_t n = 0; + for (size_t b = skip; b < kBitsPerVector; b++) + buffer[n++] = start + b; + scanner(&buffer[0], n); + ret += n; + skip = 0; + } + else { + for (size_t b = 0; b < kBitsPerVector; b++) + buffer[b] = start + b; + scanner(&buffer[0], kBitsPerVector); + ret += kBitsPerVector; + } + } + else if (flags == kPayloadMixed) { + BitVector w = m_data[1 + get_position(i * kFlagsPerIndexByte + j)]; + int n = 0; + if (skip) { + for (int b = 0; b < kBitsPerVector; b++) { + if (w & ((BitVector)1 << b)) { + if (skip) { + skip--; + continue; + } + buffer[n++] = start + b; + ret++; + } + } + } + else { + for (int b = 0; b < kBitsPerVector; b++) { + if (w & ((BitVector)1 << b)) + buffer[n++] = start + b; + } + ret += n; + } + assert(n > 0); + scanner(&buffer[0], n); + } + } + } + return (ret); + } + + // Returns the index of the 'nth' set bit; sets |*pnew_n| to 0 if the + // n'th bit was found in this MiniMap, or to the new, reduced value of |n| + size_t select(size_t n, ssize_t *pnew_n) { + size_t ret = 0; + + register uint8_t *p = (uint8_t *)m_data; + for (size_t i = 0; i < sizeof(BitVector); i++, p++) { + if (*p == 0) { + ret += kFlagsPerIndexByte * kBitsPerVector; + continue; + } + + for (int j = 0; j < kFlagsPerIndexByte; j++) { + int flags = ((*p) & ((BitVector)kFlagMask << (j * 2))) >> (j * 2); + if (flags == kPayloadNone) + continue; + if (flags == kPayloadZeroes) { + ret += kBitsPerVector; + continue; + } + if (flags == kPayloadOnes) { + if (n > kBitsPerVector) { + n -= kBitsPerVector; + ret += kBitsPerVector; + continue; + } + + *pnew_n = -1; + return (ret + n); + } + if (flags == kPayloadMixed) { + BitVector w = m_data[1 + get_position(i * kFlagsPerIndexByte + j)]; + for (int k = 0; k < kBitsPerVector; k++) { + if (w & ((BitVector)1 << k)) { + if (n == 0) { + *pnew_n = -1; + return (ret); + } + n--; + } + ret++; + } + } + } + } + + *pnew_n = n; + return (ret); + } + + // Counts the set bits in the range [0, idx] + size_t rank(size_t idx) { + size_t ret = 0; + + register uint8_t *p = (uint8_t *)m_data; + for (size_t i = 0; i < sizeof(BitVector); i++, p++) { + for (int j = 0; j < kFlagsPerIndexByte; j++) { + int flags = ((*p) & ((BitVector)kFlagMask << (j * 2))) >> (j * 2); + if (flags == kPayloadNone) + continue; + if (flags == kPayloadZeroes) { + if (idx > kBitsPerVector) + idx -= kBitsPerVector; + else + return (ret); + } + else if (flags == kPayloadOnes) { + if (idx > kBitsPerVector) { + idx -= kBitsPerVector; + ret += kBitsPerVector; + } + else + return (ret + idx); + } + else if (flags == kPayloadMixed) { + if (idx > kBitsPerVector) { + idx -= kBitsPerVector; + ret += popcount((uint64_t)m_data[1 + + get_position(i * kFlagsPerIndexByte + j)]); + } + else { + BitVector w = m_data[1 + get_position(i * kFlagsPerIndexByte + j)]; + for (size_t k = 0; k < idx; k++) { + if (w & ((BitVector)1 << k)) + ret++; + } + return (ret); + } + } + } + } + return (ret); + } + + private: + // Returns the position of a BitVector in m_data + size_t get_position(int bv) const { + // handle 4 indices (1 byte) at a time + size_t num_bytes = bv / (kFlagsPerIndexByte * kBitsPerVector); + + size_t position = 0; + register uint8_t *p = (uint8_t *)m_data; + for (size_t i = 0; i < num_bytes; i++, p++) + position += calc_vector_size(*p); + + bv -= num_bytes * kFlagsPerIndexByte; + for (int i = 0; i < bv; i++) { + int flags = ((*m_data) & ((BitVector)kFlagMask << (i * 2))) >> (i * 2); + if (flags == kPayloadMixed) + position++; + } + + return (position); + } + + // Calculates the number of BitVectors required by a single byte + // with flags (in m_data[0]) + size_t calc_vector_size(uint8_t b) const { + static int lookup[] = { + 0, 0, 1, 0, 0, 0, 1, 0, 1, 1, 2, 1, 0, 0, 1, 0, + 0, 0, 1, 0, 0, 0, 1, 0, 1, 1, 2, 1, 0, 0, 1, 0, + 1, 1, 2, 1, 1, 1, 2, 1, 2, 2, 3, 2, 1, 1, 2, 1, + 0, 0, 1, 0, 0, 0, 1, 0, 1, 1, 2, 1, 0, 0, 1, 0, + 0, 0, 1, 0, 0, 0, 1, 0, 1, 1, 2, 1, 0, 0, 1, 0, + 0, 0, 1, 0, 0, 0, 1, 0, 1, 1, 2, 1, 0, 0, 1, 0, + 1, 1, 2, 1, 1, 1, 2, 1, 2, 2, 3, 2, 1, 1, 2, 1, + 0, 0, 1, 0, 0, 0, 1, 0, 1, 1, 2, 1, 0, 0, 1, 0, + 1, 1, 2, 1, 1, 1, 2, 1, 2, 2, 3, 2, 1, 1, 2, 1, + 1, 1, 2, 1, 1, 1, 2, 1, 2, 2, 3, 2, 1, 1, 2, 1, + 2, 2, 3, 2, 2, 2, 3, 2, 3, 3, 4, 3, 2, 2, 3, 2, + 1, 1, 2, 1, 1, 1, 2, 1, 2, 2, 3, 2, 1, 1, 2, 1, + 0, 0, 1, 0, 0, 0, 1, 0, 1, 1, 2, 1, 0, 0, 1, 0, + 0, 0, 1, 0, 0, 0, 1, 0, 1, 1, 2, 1, 0, 0, 1, 0, + 1, 1, 2, 1, 1, 1, 2, 1, 2, 2, 3, 2, 1, 1, 2, 1, + 0, 0, 1, 0, 0, 0, 1, 0, 1, 1, 2, 1, 0, 0, 1, 0 + }; + return ((size_t)lookup[b]); + } + + // Pointer to the stored data; m_data[0] always contains the index + BitVector *m_data; +}; + + +// +// The SparseMap is the public interface of this library. +// +// |IndexedType| is the user's numerical data type which is mapped to +// a single bit in the bitmap. Usually this is uint32_t or uint64_t. +// |BitVector| is the storage type for a bit vector used by the MiniMap. +// Usually this is a uint64_t. +// +template +class SparseMap { + enum { + // metadata overhead: + // 4 bytes for minimap count + kSizeofOverhead = sizeof(uint32_t) + }; + + public: + // Constructor + SparseMap() + : m_data(0), m_data_size(0), m_data_used(0) { + } + + // Creates a new SparseMap at the specified buffer + void create(uint8_t *data, size_t data_size, + size_t capacity = std::numeric_limits::max()) { + m_data = data; + m_data_size = data_size; + clear(); + } + + // Opens an existing SparseMap at the specified buffer + void open(uint8_t *data, size_t data_size) { + m_data = data; + m_data_size = data_size; + } + + // Resizes the data range + void set_data_size(size_t data_size) { + m_data_size = data_size; + } + + // Returns the size of the underlying byte array + size_t get_range_size() const { + return (m_data_size); + } + + // Returns the value of a bit at index |idx| + bool is_set(size_t idx) { + assert(get_size() >= kSizeofOverhead); + + // Get the MiniMap which manages this index + ssize_t offset = get_minimap_offset(idx); + + // No MiniMaps available -> the bit is not set + if (offset == -1) + return (false); + + // Otherwise load the MiniMap + uint8_t *p = get_minimap_data(offset); + IndexedType start = *(IndexedType *)p; + + MiniMap minimap(p + sizeof(IndexedType)); + + // Check if the bit is out of bounds of the MiniMap; if yes then + // the bit is not set + if (idx < start || idx - start >= minimap.get_capacity()) + return (false); + + // Otherwise ask the MiniMap whether the bit is set + return (minimap.is_set(idx - start)); + } + + // Sets the bit at index |idx| to true or false, depending on |value| + void set(size_t idx, bool value) { + assert(get_size() >= kSizeofOverhead); + + // Get the MiniMap which manages this index + ssize_t offset = get_minimap_offset(idx); + bool dont_grow = false; + + // If there is no MiniMap and the bit is set to zero then return + // immediately; otherwise create an initial MiniMap + if (offset == -1) { + if (value == false) + return; + + uint8_t buf[sizeof(IndexedType) + sizeof(BitVector) * 2] = {0}; + append_data(&buf[0], sizeof(buf)); + + uint8_t *p = get_minimap_data(0); + *(IndexedType *)p = get_aligned_offset(idx); + + set_minimap_count(1); + + // we already inserted an additional BitVector; later on there + // is no need to grow the vector even further + dont_grow = true; + offset = 0; + } + + // Load the MiniMap + uint8_t *p = get_minimap_data(offset); + IndexedType start = *(IndexedType *)p; + + // The new index is smaller than the first MiniMap: create a new + // MiniMap and insert it at the front + if (idx < start) { + if (value == false) // nothing to do + return; + + uint8_t buf[sizeof(IndexedType) + sizeof(BitVector) * 2] = {0}; + insert_data(offset, &buf[0], sizeof(buf)); + + size_t aligned_idx = get_fully_aligned_offset(idx); + if (start - aligned_idx < MiniMap::kMaxCapacity) { + MiniMap minimap(p + sizeof(IndexedType)); + minimap.set_capacity(start - aligned_idx); + } + *(IndexedType *)p = start = aligned_idx; + + // we just added another minimap! + set_minimap_count(get_minimap_count() + 1); + + // we already inserted an additional BitVector; later on there + // is no need to grow the vector even further + dont_grow = true; + } + + // A MiniMap exists, but the new index exceeds its capacities: create + // a new MiniMap and insert it after the current one + else { + MiniMap minimap(p + sizeof(IndexedType)); + if (idx - start >= minimap.get_capacity()) { + if (value == false) // nothing to do + return; + + size_t size = minimap.get_size(); + offset += sizeof(IndexedType) + size; + p += sizeof(IndexedType) + size; + + uint8_t buf[sizeof(IndexedType) + sizeof(BitVector) * 2] = {0}; + insert_data(offset, &buf[0], sizeof(buf)); + + start += minimap.get_capacity(); + if ((size_t)start + MiniMap::kMaxCapacity < idx) + start = get_fully_aligned_offset(idx); + *(IndexedType *)p = start; + + // we just added another minimap! + set_minimap_count(get_minimap_count() + 1); + + // we already inserted an additional BitVector; later on there + // is no need to grow the vector even further + dont_grow = true; + } + } + + MiniMap minimap(p + sizeof(IndexedType)); + + // Now update the MiniMap + MultiReturn mret = minimap.set(idx - start, value); + switch (mret.code) { + case MiniMap::kOk: + break; + case MiniMap::kNeedsToGrow: + if (!dont_grow) { + offset += sizeof(IndexedType) + mret.position * sizeof(BitVector); + insert_data(offset, (uint8_t *)&mret.fill, sizeof(BitVector)); + } + mret = minimap.set(idx - start, value, true); + assert(mret.code == MiniMap::kOk); + break; + case MiniMap::kNeedsToShrink: + // if the MiniMap is empty then remove it + if (minimap.is_empty()) { + assert(mret.position == 1); + remove_data(offset, sizeof(IndexedType) + sizeof(BitVector) * 2); + set_minimap_count(get_minimap_count() - 1); + } + else { + offset += sizeof(IndexedType) + mret.position * sizeof(BitVector); + remove_data(offset, sizeof(BitVector)); + } + break; + default: + assert(!"shouldn't be here"); + break; + } + assert(get_size() >= kSizeofOverhead); + } + + // Clears the whole buffer + void clear() { + m_data_used = kSizeofOverhead; + set_minimap_count(0); + } + + // Returns the offset of the very first bit + IndexedType get_start_offset() { + if (get_minimap_count() == 0) + return (0); + return (*(IndexedType *)get_minimap_data(0)); + } + + // Returns the used size in the data buffer + size_t get_size() { + if (m_data_used) { + assert(m_data_used == get_size_impl()); + return (m_data_used); + } + return (m_data_used = get_size_impl()); + } + + // Decompresses the whole bitmap; calls visitor's operator() for all bits + template + void scan(Scanner &scanner, size_t skip) { + uint8_t *p = get_minimap_data(0); + + size_t count = get_minimap_count(); + for (size_t i = 0; i < count; i++) { + IndexedType start = *(IndexedType *)p; + p += sizeof(IndexedType); + MiniMap minimap(p); + size_t skipped = minimap.scan(start, scanner, skip); + if (skip) { + assert(skip >= skipped); + skip -= skipped; + } + p += minimap.get_size(); + } + } + + // Appends all MiniMaps from |sstart| to |other|, then reduces the + // MiniMap-count appropriately + // + // |sstart| must be BitVector-aligned! + void split(size_t sstart, SparseMap *other) { + assert(sstart % MiniMap::kBitsPerVector == 0); + + // |dst| points to the destination buffer + uint8_t *dst = other->get_minimap_end(); + + // |src| points to the source-MiniMap + uint8_t *src = get_minimap_data(0); + + // |sstart| is relative to the beginning of this SparseMap; better + // make it absolute + sstart += *(IndexedType *)src; + + bool in_middle = false; + uint8_t *prev = src; + size_t i, count = get_minimap_count(); + for (i = 0; i < count; i++) { + IndexedType start = *(IndexedType *)src; + MiniMap minimap(src + sizeof(IndexedType)); + if (start == sstart) + break; + if (start + minimap.get_capacity() > sstart) { + in_middle = true; + break; + } + if (start > sstart) { + src = prev; + i--; + break; + } + + prev = src; + src += sizeof(IndexedType) + minimap.get_size(); + } + if (i == count) { + assert(get_size() > kSizeofOverhead); + assert(other->get_size() > kSizeofOverhead); + return; + } + + // Now copy all the remaining MiniMaps + int moved = 0; + + // If |sstart| is in the middle of a MiniMap then this MiniMap has + // to be split + if (in_middle) { + uint8_t buf[sizeof(IndexedType) + sizeof(BitVector) * 2] = {0}; + memcpy(dst, &buf[0], sizeof(buf)); + + *(IndexedType *)dst = sstart; + dst += sizeof(IndexedType); + + // the |other| SparseMap now has one additional MiniMap + other->set_minimap_count(other->get_minimap_count() + 1); + if (other->m_data_used != 0) + other->m_data_used += sizeof(IndexedType) + sizeof(BitVector); + + src += sizeof(IndexedType); + MiniMap sminimap(src); + size_t capacity = sminimap.get_capacity(); + + MiniMap dminimap(dst); + dminimap.set_capacity(capacity - (sstart % capacity)); + + // now copy the bits + size_t d = sstart; + for (size_t j = sstart % capacity; j < capacity; j++, d++) { + if (sminimap.is_set(j)) + other->set(d, true); + } + + src += sminimap.get_size(); + size_t dsize = dminimap.get_size(); + dst += dsize; + i++; + + // reduce the capacity of the source-MiniMap + sminimap.set_capacity(sstart % capacity); + } + + // Now continue with all remaining minimaps + for (; i < count; i++) { + IndexedType start = *(IndexedType *)src; + src += sizeof(IndexedType); + MiniMap minimap(src); + size_t s = minimap.get_size(); + + *(IndexedType *)dst = start; + dst += sizeof(IndexedType); + memcpy(dst, src, s); + src += s; + dst += s; + + moved++; + } + + // force new calculation + other->m_data_used = 0; + m_data_used = 0; + + // Update the MiniMap counters + set_minimap_count(get_minimap_count() - moved); + other->set_minimap_count(other->get_minimap_count() + moved); + + assert(get_size() >= kSizeofOverhead); + assert(other->get_size() > kSizeofOverhead); + } + + // Returns the index of the 'nth' set bit; uses a 0-based index, + // i.e. n == 0 for the first bit which is set, n == 1 for the second bit etc + size_t select(size_t n) { + assert(get_size() >= kSizeofOverhead); + size_t result = 0; + size_t count = get_minimap_count(); + + uint8_t *p = get_minimap_data(0); + + for (size_t i = 0; i < count; i++) { + result = *(IndexedType *)p; + p += sizeof(IndexedType); + MiniMap minimap(p); + + ssize_t new_n = (ssize_t)n; + size_t index = minimap.select(n, &new_n); + if (new_n == -1) + return (result + index); + n = (size_t)new_n; + + p += minimap.get_size(); + } + assert(!"shouldn't be here"); + return (0); + } + + // Counts the set bits in the range [offset, idx] + size_t rank(size_t offset, size_t idx) { + assert(get_size() >= kSizeofOverhead); + size_t result = 0; + size_t count = get_minimap_count(); + + uint8_t *p = get_minimap_data(offset); + + for (size_t i = 0; i < count; i++) { + IndexedType start = *(IndexedType *)p; + if (start > idx) + return (result); + p += sizeof(IndexedType); + MiniMap minimap(p); + + result += minimap.rank(idx - start); + p += minimap.get_size(); + } + return (result); + } + + // Counts the set bits in the range [0, idx] + size_t rank(size_t idx) { + rank(0, idx); + } + + // Returns the number of MiniMaps + size_t get_minimap_count() const { + return (*(uint32_t *)&m_data[0]); + } + + private: + // Returns the used size in the data buffer + size_t get_size_impl() { + uint8_t *start = get_minimap_data(0); + uint8_t *p = start; + + size_t count = get_minimap_count(); + for (size_t i = 0; i < count; i++) { + p += sizeof(IndexedType); + MiniMap minimap(p); + p += minimap.get_size(); + } + return (kSizeofOverhead + p - start); + } + + // Returns the byte offset of a MiniMap in m_data + ssize_t get_minimap_offset(size_t idx) { + size_t count = get_minimap_count(); + if (count == 0) + return (-1); + + uint8_t *start = get_minimap_data(0); + uint8_t *p = start; + + for (size_t i = 0; i < count - 1; i++) { + IndexedType start = *(IndexedType *)p; + assert(start == get_aligned_offset(start)); + MiniMap minimap(p + sizeof(IndexedType)); + if (start >= idx || idx < start + minimap.get_capacity()) + break; + p += sizeof(IndexedType) + minimap.get_size(); + } + + return ((ssize_t)(p - start)); + } + + // Returns the data at the specified |offset| + uint8_t *get_minimap_data(size_t offset) { + return (&m_data[kSizeofOverhead + offset]); + } + + // Returns a pointer after the end of the used data + // TODO can also use m_data_used? + uint8_t *get_minimap_end() { + uint8_t *p = get_minimap_data(0); + + size_t count = get_minimap_count(); + for (size_t i = 0; i < count; i++) { + p += sizeof(IndexedType); + MiniMap minimap(p); + p += minimap.get_size(); + } + return (p); + } + + // Returns the aligned offset (aligned to BitVector capacity) + IndexedType get_aligned_offset(size_t idx) const { + const size_t capacity = MiniMap::kBitsPerVector; + return ((idx / capacity) * capacity); + } + + // Returns the aligned offset (aligned to MiniMap capacity) + IndexedType get_fully_aligned_offset(size_t idx) const { + const size_t capacity = MiniMap::kMaxCapacity; + return ((idx / capacity) * capacity); + } + + // Sets the number of MiniMaps + void set_minimap_count(size_t new_count) { + *(uint32_t *)&m_data[0] = (uint32_t)new_count; + } + + // Appends more data + void append_data(uint8_t *buffer, size_t buffer_size) { + memcpy(&m_data[m_data_used], buffer, buffer_size); + m_data_used += buffer_size; + } + + // Inserts data somewhere in the middle of m_data + void insert_data(size_t offset, uint8_t *buffer, size_t buffer_size) { + if (m_data_used + buffer_size > m_data_size) + throw std::overflow_error("buffer overflow"); + + uint8_t *p = get_minimap_data(offset); + memmove(p + buffer_size, p, m_data_used - offset); + memcpy(p, buffer, buffer_size); + m_data_used += buffer_size; + } + + // Removes data from m_data + void remove_data(size_t offset, size_t gap_size) { + assert(m_data_used >= offset + gap_size); + uint8_t *p = get_minimap_data(offset); + memmove(p, p + gap_size, m_data_used - offset - gap_size); + m_data_used -= gap_size; + } + + // The serialized bitmap data + uint8_t *m_data; + + // The total size of m_data + size_t m_data_size; + + // The used size of m_data + size_t m_data_used; +}; + +} // namespace sparsemap + +#endif // SPARSEMAP_H diff --git a/tests/munit.c b/tests/munit.c new file mode 100644 index 0000000..f42f8e9 --- /dev/null +++ b/tests/munit.c @@ -0,0 +1,2255 @@ +/* Copyright (c) 2013-2018 Evan Nemerson + * + * Permission is hereby granted, free of charge, to any person + * obtaining a copy of this software and associated documentation + * files (the "Software"), to deal in the Software without + * restriction, including without limitation the rights to use, copy, + * modify, merge, publish, distribute, sublicense, and/or sell copies + * of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS + * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN + * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN + * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +/*** Configuration ***/ + +/* This is just where the output from the test goes. It's really just + * meant to let you choose stdout or stderr, but if anyone really want + * to direct it to a file let me know, it would be fairly easy to + * support. */ +#if !defined(MUNIT_OUTPUT_FILE) +#define MUNIT_OUTPUT_FILE stdout +#endif + +/* This is a bit more useful; it tells µnit how to format the seconds in + * timed tests. If your tests run for longer you might want to reduce + * it, and if your computer is really fast and your tests are tiny you + * can increase it. */ +#if !defined(MUNIT_TEST_TIME_FORMAT) +#define MUNIT_TEST_TIME_FORMAT "0.8f" +#endif + +/* If you have long test names you might want to consider bumping + * this. The result information takes 43 characters. */ +#if !defined(MUNIT_TEST_NAME_LEN) +#define MUNIT_TEST_NAME_LEN 37 +#endif + +/* If you don't like the timing information, you can disable it by + * defining MUNIT_DISABLE_TIMING. */ +#if !defined(MUNIT_DISABLE_TIMING) +#define MUNIT_ENABLE_TIMING +#endif + +/*** End configuration ***/ + +#if defined(_POSIX_C_SOURCE) && (_POSIX_C_SOURCE < 200809L) +#undef _POSIX_C_SOURCE +#endif +#if !defined(_POSIX_C_SOURCE) +#define _POSIX_C_SOURCE 200809L +#endif + +/* Solaris freaks out if you try to use a POSIX or SUS standard without + * the "right" C standard. */ +#if defined(_XOPEN_SOURCE) +#undef _XOPEN_SOURCE +#endif + +#if defined(__STDC_VERSION__) +#if __STDC_VERSION__ >= 201112L +#define _XOPEN_SOURCE 700 +#elif __STDC_VERSION__ >= 199901L +#define _XOPEN_SOURCE 600 +#endif +#endif + +/* Because, according to Microsoft, POSIX is deprecated. You've got + * to appreciate the chutzpah. */ +#if defined(_MSC_VER) && !defined(_CRT_NONSTDC_NO_DEPRECATE) +#define _CRT_NONSTDC_NO_DEPRECATE +#endif + +#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) +#include +#elif defined(_WIN32) +/* https://msdn.microsoft.com/en-us/library/tf4dy80a.aspx */ +#endif + +#include +#include +#include +#include +#include +#include +#include +#include + +#if !defined(MUNIT_NO_NL_LANGINFO) && !defined(_WIN32) +#define MUNIT_NL_LANGINFO +#include +#include +#include +#endif + +#if !defined(_WIN32) +#include +#include + +#include +#else +#include +#include +#include +#if !defined(STDERR_FILENO) +#define STDERR_FILENO _fileno(stderr) +#endif +#endif + +#include "munit.h" + +#define MUNIT_STRINGIFY(x) #x +#define MUNIT_XSTRINGIFY(x) MUNIT_STRINGIFY(x) + +#if defined(__GNUC__) || defined(__INTEL_COMPILER) || defined(__SUNPRO_CC) || \ + defined(__IBMCPP__) +#define MUNIT_THREAD_LOCAL __thread +#elif (defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201102L)) || \ + defined(_Thread_local) +#define MUNIT_THREAD_LOCAL _Thread_local +#elif defined(_WIN32) +#define MUNIT_THREAD_LOCAL __declspec(thread) +#endif + +/* MSVC 12.0 will emit a warning at /W4 for code like 'do { ... } + * while (0)', or 'do { ... } while (1)'. I'm pretty sure nobody + * at Microsoft compiles with /W4. */ +#if defined(_MSC_VER) && (_MSC_VER <= 1800) +#pragma warning(disable : 4127) +#endif + +#if defined(_WIN32) || defined(__EMSCRIPTEN__) +#define MUNIT_NO_FORK +#endif + +#if defined(__EMSCRIPTEN__) +#define MUNIT_NO_BUFFER +#endif + +/*** Logging ***/ + +static MunitLogLevel munit_log_level_visible = MUNIT_LOG_INFO; +static MunitLogLevel munit_log_level_fatal = MUNIT_LOG_ERROR; + +#if defined(MUNIT_THREAD_LOCAL) +static MUNIT_THREAD_LOCAL munit_bool munit_error_jmp_buf_valid = 0; +static MUNIT_THREAD_LOCAL jmp_buf munit_error_jmp_buf; +#endif + +/* At certain warning levels, mingw will trigger warnings about + * suggesting the format attribute, which we've explicity *not* set + * because it will then choke on our attempts to use the MS-specific + * I64 modifier for size_t (which we have to use since MSVC doesn't + * support the C99 z modifier). */ + +#if defined(__MINGW32__) || defined(__MINGW64__) +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wsuggest-attribute=format" +#endif + +MUNIT_PRINTF(5, 0) +static void +munit_logf_exv(MunitLogLevel level, FILE *fp, const char *filename, int line, + const char *format, va_list ap) +{ + if (level < munit_log_level_visible) + return; + + switch (level) { + case MUNIT_LOG_DEBUG: + fputs("Debug", fp); + break; + case MUNIT_LOG_INFO: + fputs("Info", fp); + break; + case MUNIT_LOG_WARNING: + fputs("Warning", fp); + break; + case MUNIT_LOG_ERROR: + fputs("Error", fp); + break; + default: + munit_logf_ex(MUNIT_LOG_ERROR, filename, line, "Invalid log level (%d)", + level); + return; + } + + fputs(": ", fp); + if (filename != NULL) + fprintf(fp, "%s:%d: ", filename, line); + vfprintf(fp, format, ap); + fputc('\n', fp); +} + +MUNIT_PRINTF(3, 4) +static void +munit_logf_internal(MunitLogLevel level, FILE *fp, const char *format, ...) +{ + va_list ap; + + va_start(ap, format); + munit_logf_exv(level, fp, NULL, 0, format, ap); + va_end(ap); +} + +static void +munit_log_internal(MunitLogLevel level, FILE *fp, const char *message) +{ + munit_logf_internal(level, fp, "%s", message); +} + +void +munit_logf_ex(MunitLogLevel level, const char *filename, int line, + const char *format, ...) +{ + va_list ap; + + va_start(ap, format); + munit_logf_exv(level, stderr, filename, line, format, ap); + va_end(ap); + + if (level >= munit_log_level_fatal) { +#if defined(MUNIT_THREAD_LOCAL) + if (munit_error_jmp_buf_valid) + longjmp(munit_error_jmp_buf, 1); +#endif + abort(); + } +} + +void +munit_errorf_ex(const char *filename, int line, const char *format, ...) +{ + va_list ap; + + va_start(ap, format); + munit_logf_exv(MUNIT_LOG_ERROR, stderr, filename, line, format, ap); + va_end(ap); + +#if defined(MUNIT_THREAD_LOCAL) + if (munit_error_jmp_buf_valid) + longjmp(munit_error_jmp_buf, 1); +#endif + abort(); +} + +#if defined(__MINGW32__) || defined(__MINGW64__) +#pragma GCC diagnostic pop +#endif + +#if !defined(MUNIT_STRERROR_LEN) +#define MUNIT_STRERROR_LEN 80 +#endif + +static void +munit_log_errno(MunitLogLevel level, FILE *fp, const char *msg) +{ +#if defined(MUNIT_NO_STRERROR_R) || \ + (defined(__MINGW32__) && !defined(MINGW_HAS_SECURE_API)) + munit_logf_internal(level, fp, "%s: %s (%d)", msg, strerror(errno), errno); +#else + char munit_error_str[MUNIT_STRERROR_LEN]; + munit_error_str[0] = '\0'; + +#if !defined(_WIN32) + strerror_r(errno, munit_error_str, MUNIT_STRERROR_LEN); +#else + strerror_s(munit_error_str, MUNIT_STRERROR_LEN, errno); +#endif + + munit_logf_internal(level, fp, "%s: %s (%d)", msg, munit_error_str, errno); +#endif +} + +/*** Memory allocation ***/ + +void * +munit_malloc_ex(const char *filename, int line, size_t size) +{ + void *ptr; + + if (size == 0) + return NULL; + + ptr = calloc(1, size); + if (MUNIT_UNLIKELY(ptr == NULL)) { + munit_logf_ex(MUNIT_LOG_ERROR, filename, line, + "Failed to allocate %" MUNIT_SIZE_MODIFIER "u bytes.", size); + } + + return ptr; +} + +/*** Timer code ***/ + +#if defined(MUNIT_ENABLE_TIMING) + +#define psnip_uint64_t munit_uint64_t +#define psnip_uint32_t munit_uint32_t + +/* Code copied from portable-snippets + * . If you need to + * change something, please do it there so we can keep the code in + * sync. */ + +/* Clocks (v1) + * Portable Snippets - https://gitub.com/nemequ/portable-snippets + * Created by Evan Nemerson + * + * To the extent possible under law, the authors have waived all + * copyright and related or neighboring rights to this code. For + * details, see the Creative Commons Zero 1.0 Universal license at + * https://creativecommons.org/publicdomain/zero/1.0/ + */ + +#if !defined(PSNIP_CLOCK_H) +#define PSNIP_CLOCK_H + +#if !defined(psnip_uint64_t) +#include "../exact-int/exact-int.h" +#endif + +#if !defined(PSNIP_CLOCK_STATIC_INLINE) +#if defined(__GNUC__) +#define PSNIP_CLOCK__COMPILER_ATTRIBUTES __attribute__((__unused__)) +#else +#define PSNIP_CLOCK__COMPILER_ATTRIBUTES +#endif + +#define PSNIP_CLOCK__FUNCTION PSNIP_CLOCK__COMPILER_ATTRIBUTES static +#endif + +enum PsnipClockType { + /* This clock provides the current time, in units since 1970-01-01 + * 00:00:00 UTC not including leap seconds. In other words, UNIX + * time. Keep in mind that this clock doesn't account for leap + * seconds, and can go backwards (think NTP adjustments). */ + PSNIP_CLOCK_TYPE_WALL = 1, + /* The CPU time is a clock which increases only when the current + * process is active (i.e., it doesn't increment while blocking on + * I/O). */ + PSNIP_CLOCK_TYPE_CPU = 2, + /* Monotonic time is always running (unlike CPU time), but it only + ever moves forward unless you reboot the system. Things like NTP + adjustments have no effect on this clock. */ + PSNIP_CLOCK_TYPE_MONOTONIC = 3 +}; + +struct PsnipClockTimespec { + psnip_uint64_t seconds; + psnip_uint64_t nanoseconds; +}; + +/* Methods we support: */ + +#define PSNIP_CLOCK_METHOD_CLOCK_GETTIME 1 +#define PSNIP_CLOCK_METHOD_TIME 2 +#define PSNIP_CLOCK_METHOD_GETTIMEOFDAY 3 +#define PSNIP_CLOCK_METHOD_QUERYPERFORMANCECOUNTER 4 +#define PSNIP_CLOCK_METHOD_MACH_ABSOLUTE_TIME 5 +#define PSNIP_CLOCK_METHOD_CLOCK 6 +#define PSNIP_CLOCK_METHOD_GETPROCESSTIMES 7 +#define PSNIP_CLOCK_METHOD_GETRUSAGE 8 +#define PSNIP_CLOCK_METHOD_GETSYSTEMTIMEPRECISEASFILETIME 9 +#define PSNIP_CLOCK_METHOD_GETTICKCOUNT64 10 + +#include + +#if defined(HEDLEY_UNREACHABLE) +#define PSNIP_CLOCK_UNREACHABLE() HEDLEY_UNREACHABLE() +#else +#define PSNIP_CLOCK_UNREACHABLE() assert(0) +#endif + +/* Choose an implementation */ + +/* #undef PSNIP_CLOCK_WALL_METHOD */ +/* #undef PSNIP_CLOCK_CPU_METHOD */ +/* #undef PSNIP_CLOCK_MONOTONIC_METHOD */ + +/* We want to be able to detect the libc implementation, so we include + ( isn't available everywhere). */ + +#if defined(__unix__) || defined(__unix) || defined(__linux__) +#include +#include +#endif + +#if defined(_POSIX_TIMERS) && (_POSIX_TIMERS > 0) +/* These are known to work without librt. If you know of others + * please let us know so we can add them. */ +#if (defined(__GLIBC__) && \ + (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 17))) || \ + (defined(__FreeBSD__)) +#define PSNIP_CLOCK_HAVE_CLOCK_GETTIME +#elif !defined(PSNIP_CLOCK_NO_LIBRT) +#define PSNIP_CLOCK_HAVE_CLOCK_GETTIME +#endif +#endif + +#if defined(_WIN32) +#if !defined(PSNIP_CLOCK_CPU_METHOD) +#define PSNIP_CLOCK_CPU_METHOD PSNIP_CLOCK_METHOD_GETPROCESSTIMES +#endif +#if !defined(PSNIP_CLOCK_MONOTONIC_METHOD) +#define PSNIP_CLOCK_MONOTONIC_METHOD PSNIP_CLOCK_METHOD_QUERYPERFORMANCECOUNTER +#endif +#endif + +#if defined(__MACH__) && !defined(__gnu_hurd__) +#if !defined(PSNIP_CLOCK_MONOTONIC_METHOD) +#define PSNIP_CLOCK_MONOTONIC_METHOD PSNIP_CLOCK_METHOD_MACH_ABSOLUTE_TIME +#endif +#endif + +#if defined(PSNIP_CLOCK_HAVE_CLOCK_GETTIME) +#include +#if !defined(PSNIP_CLOCK_WALL_METHOD) +#if defined(CLOCK_REALTIME_PRECISE) +#define PSNIP_CLOCK_WALL_METHOD PSNIP_CLOCK_METHOD_CLOCK_GETTIME +#define PSNIP_CLOCK_CLOCK_GETTIME_WALL CLOCK_REALTIME_PRECISE +#elif !defined(__sun) +#define PSNIP_CLOCK_WALL_METHOD PSNIP_CLOCK_METHOD_CLOCK_GETTIME +#define PSNIP_CLOCK_CLOCK_GETTIME_WALL CLOCK_REALTIME +#endif +#endif +#if !defined(PSNIP_CLOCK_CPU_METHOD) +#if defined(_POSIX_CPUTIME) || defined(CLOCK_PROCESS_CPUTIME_ID) +#define PSNIP_CLOCK_CPU_METHOD PSNIP_CLOCK_METHOD_CLOCK_GETTIME +#define PSNIP_CLOCK_CLOCK_GETTIME_CPU CLOCK_PROCESS_CPUTIME_ID +#elif defined(CLOCK_VIRTUAL) +#define PSNIP_CLOCK_CPU_METHOD PSNIP_CLOCK_METHOD_CLOCK_GETTIME +#define PSNIP_CLOCK_CLOCK_GETTIME_CPU CLOCK_VIRTUAL +#endif +#endif +#if !defined(PSNIP_CLOCK_MONOTONIC_METHOD) +#if defined(CLOCK_MONOTONIC_RAW) +#define PSNIP_CLOCK_MONOTONIC_METHOD PSNIP_CLOCK_METHOD_CLOCK_GETTIME +#define PSNIP_CLOCK_CLOCK_GETTIME_MONOTONIC CLOCK_MONOTONIC +#elif defined(CLOCK_MONOTONIC_PRECISE) +#define PSNIP_CLOCK_MONOTONIC_METHOD PSNIP_CLOCK_METHOD_CLOCK_GETTIME +#define PSNIP_CLOCK_CLOCK_GETTIME_MONOTONIC CLOCK_MONOTONIC_PRECISE +#elif defined(_POSIX_MONOTONIC_CLOCK) || defined(CLOCK_MONOTONIC) +#define PSNIP_CLOCK_MONOTONIC_METHOD PSNIP_CLOCK_METHOD_CLOCK_GETTIME +#define PSNIP_CLOCK_CLOCK_GETTIME_MONOTONIC CLOCK_MONOTONIC +#endif +#endif +#endif + +#if defined(_POSIX_VERSION) && (_POSIX_VERSION >= 200112L) +#if !defined(PSNIP_CLOCK_WALL_METHOD) +#define PSNIP_CLOCK_WALL_METHOD PSNIP_CLOCK_METHOD_GETTIMEOFDAY +#endif +#endif + +#if !defined(PSNIP_CLOCK_WALL_METHOD) +#define PSNIP_CLOCK_WALL_METHOD PSNIP_CLOCK_METHOD_TIME +#endif + +#if !defined(PSNIP_CLOCK_CPU_METHOD) +#define PSNIP_CLOCK_CPU_METHOD PSNIP_CLOCK_METHOD_CLOCK +#endif + +/* Primarily here for testing. */ +#if !defined(PSNIP_CLOCK_MONOTONIC_METHOD) && \ + defined(PSNIP_CLOCK_REQUIRE_MONOTONIC) +#error No monotonic clock found. +#endif + +/* Implementations */ + +#if (defined(PSNIP_CLOCK_CPU_METHOD) && \ + (PSNIP_CLOCK_CPU_METHOD == PSNIP_CLOCK_METHOD_CLOCK_GETTIME)) || \ + (defined(PSNIP_CLOCK_WALL_METHOD) && \ + (PSNIP_CLOCK_WALL_METHOD == PSNIP_CLOCK_METHOD_CLOCK_GETTIME)) || \ + (defined(PSNIP_CLOCK_MONOTONIC_METHOD) && \ + (PSNIP_CLOCK_MONOTONIC_METHOD == PSNIP_CLOCK_METHOD_CLOCK_GETTIME)) || \ + (defined(PSNIP_CLOCK_CPU_METHOD) && \ + (PSNIP_CLOCK_CPU_METHOD == PSNIP_CLOCK_METHOD_CLOCK)) || \ + (defined(PSNIP_CLOCK_WALL_METHOD) && \ + (PSNIP_CLOCK_WALL_METHOD == PSNIP_CLOCK_METHOD_CLOCK)) || \ + (defined(PSNIP_CLOCK_MONOTONIC_METHOD) && \ + (PSNIP_CLOCK_MONOTONIC_METHOD == PSNIP_CLOCK_METHOD_CLOCK)) || \ + (defined(PSNIP_CLOCK_CPU_METHOD) && \ + (PSNIP_CLOCK_CPU_METHOD == PSNIP_CLOCK_METHOD_TIME)) || \ + (defined(PSNIP_CLOCK_WALL_METHOD) && \ + (PSNIP_CLOCK_WALL_METHOD == PSNIP_CLOCK_METHOD_TIME)) || \ + (defined(PSNIP_CLOCK_MONOTONIC_METHOD) && \ + (PSNIP_CLOCK_MONOTONIC_METHOD == PSNIP_CLOCK_METHOD_TIME)) +#include +#endif + +#if (defined(PSNIP_CLOCK_CPU_METHOD) && \ + (PSNIP_CLOCK_CPU_METHOD == PSNIP_CLOCK_METHOD_GETTIMEOFDAY)) || \ + (defined(PSNIP_CLOCK_WALL_METHOD) && \ + (PSNIP_CLOCK_WALL_METHOD == PSNIP_CLOCK_METHOD_GETTIMEOFDAY)) || \ + (defined(PSNIP_CLOCK_MONOTONIC_METHOD) && \ + (PSNIP_CLOCK_MONOTONIC_METHOD == PSNIP_CLOCK_METHOD_GETTIMEOFDAY)) +#include +#endif + +#if (defined(PSNIP_CLOCK_CPU_METHOD) && \ + (PSNIP_CLOCK_CPU_METHOD == PSNIP_CLOCK_METHOD_GETPROCESSTIMES)) || \ + (defined(PSNIP_CLOCK_WALL_METHOD) && \ + (PSNIP_CLOCK_WALL_METHOD == PSNIP_CLOCK_METHOD_GETPROCESSTIMES)) || \ + (defined(PSNIP_CLOCK_MONOTONIC_METHOD) && \ + (PSNIP_CLOCK_MONOTONIC_METHOD == PSNIP_CLOCK_METHOD_GETPROCESSTIMES)) || \ + (defined(PSNIP_CLOCK_CPU_METHOD) && \ + (PSNIP_CLOCK_CPU_METHOD == PSNIP_CLOCK_METHOD_GETTICKCOUNT64)) || \ + (defined(PSNIP_CLOCK_WALL_METHOD) && \ + (PSNIP_CLOCK_WALL_METHOD == PSNIP_CLOCK_METHOD_GETTICKCOUNT64)) || \ + (defined(PSNIP_CLOCK_MONOTONIC_METHOD) && \ + (PSNIP_CLOCK_MONOTONIC_METHOD == PSNIP_CLOCK_METHOD_GETTICKCOUNT64)) +#include +#endif + +#if (defined(PSNIP_CLOCK_CPU_METHOD) && \ + (PSNIP_CLOCK_CPU_METHOD == PSNIP_CLOCK_METHOD_GETRUSAGE)) || \ + (defined(PSNIP_CLOCK_WALL_METHOD) && \ + (PSNIP_CLOCK_WALL_METHOD == PSNIP_CLOCK_METHOD_GETRUSAGE)) || \ + (defined(PSNIP_CLOCK_MONOTONIC_METHOD) && \ + (PSNIP_CLOCK_MONOTONIC_METHOD == PSNIP_CLOCK_METHOD_GETRUSAGE)) +#include +#include +#endif + +#if (defined(PSNIP_CLOCK_CPU_METHOD) && \ + (PSNIP_CLOCK_CPU_METHOD == PSNIP_CLOCK_METHOD_MACH_ABSOLUTE_TIME)) || \ + (defined(PSNIP_CLOCK_WALL_METHOD) && \ + (PSNIP_CLOCK_WALL_METHOD == PSNIP_CLOCK_METHOD_MACH_ABSOLUTE_TIME)) || \ + (defined(PSNIP_CLOCK_MONOTONIC_METHOD) && \ + (PSNIP_CLOCK_MONOTONIC_METHOD == PSNIP_CLOCK_METHOD_MACH_ABSOLUTE_TIME)) +#include +#include +#include +#endif + +/*** Implementations ***/ + +#define PSNIP_CLOCK_NSEC_PER_SEC ((psnip_uint32_t)(1000000000ULL)) + +#if (defined(PSNIP_CLOCK_CPU_METHOD) && \ + (PSNIP_CLOCK_CPU_METHOD == PSNIP_CLOCK_METHOD_CLOCK_GETTIME)) || \ + (defined(PSNIP_CLOCK_WALL_METHOD) && \ + (PSNIP_CLOCK_WALL_METHOD == PSNIP_CLOCK_METHOD_CLOCK_GETTIME)) || \ + (defined(PSNIP_CLOCK_MONOTONIC_METHOD) && \ + (PSNIP_CLOCK_MONOTONIC_METHOD == PSNIP_CLOCK_METHOD_CLOCK_GETTIME)) +PSNIP_CLOCK__FUNCTION psnip_uint32_t +psnip_clock__clock_getres(clockid_t clk_id) +{ + struct timespec res; + int r; + + r = clock_getres(clk_id, &res); + if (r != 0) + return 0; + + return (psnip_uint32_t)(PSNIP_CLOCK_NSEC_PER_SEC / res.tv_nsec); +} + +PSNIP_CLOCK__FUNCTION int +psnip_clock__clock_gettime(clockid_t clk_id, struct PsnipClockTimespec *res) +{ + struct timespec ts; + + if (clock_gettime(clk_id, &ts) != 0) + return -10; + + res->seconds = (psnip_uint64_t)(ts.tv_sec); + res->nanoseconds = (psnip_uint64_t)(ts.tv_nsec); + + return 0; +} +#endif + +PSNIP_CLOCK__FUNCTION psnip_uint32_t +psnip_clock_wall_get_precision(void) +{ +#if !defined(PSNIP_CLOCK_WALL_METHOD) + return 0; +#elif defined(PSNIP_CLOCK_WALL_METHOD) && \ + PSNIP_CLOCK_WALL_METHOD == PSNIP_CLOCK_METHOD_CLOCK_GETTIME + return psnip_clock__clock_getres(PSNIP_CLOCK_CLOCK_GETTIME_WALL); +#elif defined(PSNIP_CLOCK_WALL_METHOD) && \ + PSNIP_CLOCK_WALL_METHOD == PSNIP_CLOCK_METHOD_GETTIMEOFDAY + return 1000000; +#elif defined(PSNIP_CLOCK_WALL_METHOD) && \ + PSNIP_CLOCK_WALL_METHOD == PSNIP_CLOCK_METHOD_TIME + return 1; +#else + return 0; +#endif +} + +PSNIP_CLOCK__FUNCTION int +psnip_clock_wall_get_time(struct PsnipClockTimespec *res) +{ + (void)res; + +#if !defined(PSNIP_CLOCK_WALL_METHOD) + return -2; +#elif defined(PSNIP_CLOCK_WALL_METHOD) && \ + PSNIP_CLOCK_WALL_METHOD == PSNIP_CLOCK_METHOD_CLOCK_GETTIME + return psnip_clock__clock_gettime(PSNIP_CLOCK_CLOCK_GETTIME_WALL, res); +#elif defined(PSNIP_CLOCK_WALL_METHOD) && \ + PSNIP_CLOCK_WALL_METHOD == PSNIP_CLOCK_METHOD_TIME + res->seconds = time(NULL); + res->nanoseconds = 0; +#elif defined(PSNIP_CLOCK_WALL_METHOD) && \ + PSNIP_CLOCK_WALL_METHOD == PSNIP_CLOCK_METHOD_GETTIMEOFDAY + struct timeval tv; + + if (gettimeofday(&tv, NULL) != 0) + return -6; + + res->seconds = tv.tv_sec; + res->nanoseconds = tv.tv_usec * 1000; +#else + return -2; +#endif + + return 0; +} + +PSNIP_CLOCK__FUNCTION psnip_uint32_t +psnip_clock_cpu_get_precision(void) +{ +#if !defined(PSNIP_CLOCK_CPU_METHOD) + return 0; +#elif defined(PSNIP_CLOCK_CPU_METHOD) && \ + PSNIP_CLOCK_CPU_METHOD == PSNIP_CLOCK_METHOD_CLOCK_GETTIME + return psnip_clock__clock_getres(PSNIP_CLOCK_CLOCK_GETTIME_CPU); +#elif defined(PSNIP_CLOCK_CPU_METHOD) && \ + PSNIP_CLOCK_CPU_METHOD == PSNIP_CLOCK_METHOD_CLOCK + return CLOCKS_PER_SEC; +#elif defined(PSNIP_CLOCK_CPU_METHOD) && \ + PSNIP_CLOCK_CPU_METHOD == PSNIP_CLOCK_METHOD_GETPROCESSTIMES + return PSNIP_CLOCK_NSEC_PER_SEC / 100; +#else + return 0; +#endif +} + +PSNIP_CLOCK__FUNCTION int +psnip_clock_cpu_get_time(struct PsnipClockTimespec *res) +{ +#if !defined(PSNIP_CLOCK_CPU_METHOD) + (void)res; + return -2; +#elif defined(PSNIP_CLOCK_CPU_METHOD) && \ + PSNIP_CLOCK_CPU_METHOD == PSNIP_CLOCK_METHOD_CLOCK_GETTIME + return psnip_clock__clock_gettime(PSNIP_CLOCK_CLOCK_GETTIME_CPU, res); +#elif defined(PSNIP_CLOCK_CPU_METHOD) && \ + PSNIP_CLOCK_CPU_METHOD == PSNIP_CLOCK_METHOD_CLOCK + clock_t t = clock(); + if (t == ((clock_t)-1)) + return -5; + res->seconds = t / CLOCKS_PER_SEC; + res->nanoseconds = (t % CLOCKS_PER_SEC) * + (PSNIP_CLOCK_NSEC_PER_SEC / CLOCKS_PER_SEC); +#elif defined(PSNIP_CLOCK_CPU_METHOD) && \ + PSNIP_CLOCK_CPU_METHOD == PSNIP_CLOCK_METHOD_GETPROCESSTIMES + FILETIME CreationTime, ExitTime, KernelTime, UserTime; + LARGE_INTEGER date, adjust; + + if (!GetProcessTimes(GetCurrentProcess(), &CreationTime, &ExitTime, + &KernelTime, &UserTime)) + return -7; + + /* http://www.frenk.com/2009/12/convert-filetime-to-unix-timestamp/ */ + date.HighPart = UserTime.dwHighDateTime; + date.LowPart = UserTime.dwLowDateTime; + adjust.QuadPart = 11644473600000 * 10000; + date.QuadPart -= adjust.QuadPart; + + res->seconds = date.QuadPart / 10000000; + res->nanoseconds = (date.QuadPart % 10000000) * + (PSNIP_CLOCK_NSEC_PER_SEC / 100); +#elif PSNIP_CLOCK_CPU_METHOD == PSNIP_CLOCK_METHOD_GETRUSAGE + struct rusage usage; + if (getrusage(RUSAGE_SELF, &usage) != 0) + return -8; + + res->seconds = usage.ru_utime.tv_sec; + res->nanoseconds = tv.tv_usec * 1000; +#else + (void)res; + return -2; +#endif + + return 0; +} + +PSNIP_CLOCK__FUNCTION psnip_uint32_t +psnip_clock_monotonic_get_precision(void) +{ +#if !defined(PSNIP_CLOCK_MONOTONIC_METHOD) + return 0; +#elif defined(PSNIP_CLOCK_MONOTONIC_METHOD) && \ + PSNIP_CLOCK_MONOTONIC_METHOD == PSNIP_CLOCK_METHOD_CLOCK_GETTIME + return psnip_clock__clock_getres(PSNIP_CLOCK_CLOCK_GETTIME_MONOTONIC); +#elif defined(PSNIP_CLOCK_MONOTONIC_METHOD) && \ + PSNIP_CLOCK_MONOTONIC_METHOD == PSNIP_CLOCK_METHOD_MACH_ABSOLUTE_TIME + static mach_timebase_info_data_t tbi = { + 0, + }; + if (tbi.denom == 0) + mach_timebase_info(&tbi); + return (psnip_uint32_t)(tbi.numer / tbi.denom); +#elif defined(PSNIP_CLOCK_MONOTONIC_METHOD) && \ + PSNIP_CLOCK_MONOTONIC_METHOD == PSNIP_CLOCK_METHOD_GETTICKCOUNT64 + return 1000; +#elif defined(PSNIP_CLOCK_MONOTONIC_METHOD) && \ + PSNIP_CLOCK_MONOTONIC_METHOD == PSNIP_CLOCK_METHOD_QUERYPERFORMANCECOUNTER + LARGE_INTEGER Frequency; + QueryPerformanceFrequency(&Frequency); + return (psnip_uint32_t)((Frequency.QuadPart > PSNIP_CLOCK_NSEC_PER_SEC) ? + PSNIP_CLOCK_NSEC_PER_SEC : + Frequency.QuadPart); +#else + return 0; +#endif +} + +PSNIP_CLOCK__FUNCTION int +psnip_clock_monotonic_get_time(struct PsnipClockTimespec *res) +{ +#if !defined(PSNIP_CLOCK_MONOTONIC_METHOD) + (void)res; + return -2; +#elif defined(PSNIP_CLOCK_MONOTONIC_METHOD) && \ + PSNIP_CLOCK_MONOTONIC_METHOD == PSNIP_CLOCK_METHOD_CLOCK_GETTIME + return psnip_clock__clock_gettime(PSNIP_CLOCK_CLOCK_GETTIME_MONOTONIC, res); +#elif defined(PSNIP_CLOCK_MONOTONIC_METHOD) && \ + PSNIP_CLOCK_MONOTONIC_METHOD == PSNIP_CLOCK_METHOD_MACH_ABSOLUTE_TIME + psnip_uint64_t nsec = mach_absolute_time(); + static mach_timebase_info_data_t tbi = { + 0, + }; + if (tbi.denom == 0) + mach_timebase_info(&tbi); + nsec *= ((psnip_uint64_t)tbi.numer) / ((psnip_uint64_t)tbi.denom); + res->seconds = nsec / PSNIP_CLOCK_NSEC_PER_SEC; + res->nanoseconds = nsec % PSNIP_CLOCK_NSEC_PER_SEC; +#elif defined(PSNIP_CLOCK_MONOTONIC_METHOD) && \ + PSNIP_CLOCK_MONOTONIC_METHOD == PSNIP_CLOCK_METHOD_QUERYPERFORMANCECOUNTER + LARGE_INTEGER t, f; + if (QueryPerformanceCounter(&t) == 0) + return -12; + + QueryPerformanceFrequency(&f); + res->seconds = t.QuadPart / f.QuadPart; + res->nanoseconds = t.QuadPart % f.QuadPart; + if (f.QuadPart > PSNIP_CLOCK_NSEC_PER_SEC) + res->nanoseconds /= f.QuadPart / PSNIP_CLOCK_NSEC_PER_SEC; + else + res->nanoseconds *= PSNIP_CLOCK_NSEC_PER_SEC / f.QuadPart; +#elif defined(PSNIP_CLOCK_MONOTONIC_METHOD) && \ + PSNIP_CLOCK_MONOTONIC_METHOD == PSNIP_CLOCK_METHOD_GETTICKCOUNT64 + const ULONGLONG msec = GetTickCount64(); + res->seconds = msec / 1000; + res->nanoseconds = sec % 1000; +#else + return -2; +#endif + + return 0; +} + +/* Returns the number of ticks per second for the specified clock. + * For example, a clock with millisecond precision would return 1000, + * and a clock with 1 second (such as the time() function) would + * return 1. + * + * If the requested clock isn't available, it will return 0. + * Hopefully this will be rare, but if it happens to you please let us + * know so we can work on finding a way to support your system. + * + * Note that different clocks on the same system often have a + * different precisions. + */ +PSNIP_CLOCK__FUNCTION psnip_uint32_t +psnip_clock_get_precision(enum PsnipClockType clock_type) +{ + switch (clock_type) { + case PSNIP_CLOCK_TYPE_MONOTONIC: + return psnip_clock_monotonic_get_precision(); + case PSNIP_CLOCK_TYPE_CPU: + return psnip_clock_cpu_get_precision(); + case PSNIP_CLOCK_TYPE_WALL: + return psnip_clock_wall_get_precision(); + } + + PSNIP_CLOCK_UNREACHABLE(); + return 0; +} + +/* Set the provided timespec to the requested time. Returns 0 on + * success, or a negative value on failure. */ +PSNIP_CLOCK__FUNCTION int +psnip_clock_get_time(enum PsnipClockType clock_type, + struct PsnipClockTimespec *res) +{ + assert(res != NULL); + + switch (clock_type) { + case PSNIP_CLOCK_TYPE_MONOTONIC: + return psnip_clock_monotonic_get_time(res); + case PSNIP_CLOCK_TYPE_CPU: + return psnip_clock_cpu_get_time(res); + case PSNIP_CLOCK_TYPE_WALL: + return psnip_clock_wall_get_time(res); + } + + return -1; +} + +#endif /* !defined(PSNIP_CLOCK_H) */ + +static psnip_uint64_t +munit_clock_get_elapsed(struct PsnipClockTimespec *start, + struct PsnipClockTimespec *end) +{ + psnip_uint64_t r = (end->seconds - start->seconds) * PSNIP_CLOCK_NSEC_PER_SEC; + if (end->nanoseconds < start->nanoseconds) { + r -= (start->nanoseconds - end->nanoseconds); + } else { + r += (end->nanoseconds - start->nanoseconds); + } + return r; +} + +#else +#include +#endif /* defined(MUNIT_ENABLE_TIMING) */ + +/*** PRNG stuff ***/ + +/* This is (unless I screwed up, which is entirely possible) the + * version of PCG with 32-bit state. It was chosen because it has a + * small enough state that we should reliably be able to use CAS + * instead of requiring a lock for thread-safety. + * + * If I did screw up, I probably will not bother changing it unless + * there is a significant bias. It's really not important this be + * particularly strong, as long as it is fairly random it's much more + * important that it be reproducible, so bug reports have a better + * chance of being reproducible. */ + +#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L) && \ + !defined(__STDC_NO_ATOMICS__) && !defined(__EMSCRIPTEN__) && \ + (!defined(__GNUC_MINOR__) || (__GNUC__ > 4) || \ + (__GNUC__ == 4 && __GNUC_MINOR__ > 8)) +#define HAVE_STDATOMIC +#elif defined(__clang__) +#if __has_extension(c_atomic) +#define HAVE_CLANG_ATOMICS +#endif +#endif + +/* Workaround for http://llvm.org/bugs/show_bug.cgi?id=26911 */ +#if defined(__clang__) && defined(_WIN32) +#undef HAVE_STDATOMIC +#if defined(__c2__) +#undef HAVE_CLANG_ATOMICS +#endif +#endif + +#if defined(_OPENMP) +#define ATOMIC_UINT32_T uint32_t +#define ATOMIC_UINT32_INIT(x) (x) +#elif defined(HAVE_STDATOMIC) +#include +#define ATOMIC_UINT32_T _Atomic uint32_t +#define ATOMIC_UINT32_INIT(x) ATOMIC_VAR_INIT(x) +#elif defined(HAVE_CLANG_ATOMICS) +#define ATOMIC_UINT32_T _Atomic uint32_t +#define ATOMIC_UINT32_INIT(x) (x) +#elif defined(_WIN32) +#define ATOMIC_UINT32_T volatile LONG +#define ATOMIC_UINT32_INIT(x) (x) +#else +#define ATOMIC_UINT32_T volatile uint32_t +#define ATOMIC_UINT32_INIT(x) (x) +#endif + +static ATOMIC_UINT32_T munit_rand_state = ATOMIC_UINT32_INIT(42); + +#if defined(_OPENMP) +static inline void +munit_atomic_store(ATOMIC_UINT32_T *dest, ATOMIC_UINT32_T value) +{ +#pragma omp critical(munit_atomics) + *dest = value; +} + +static inline uint32_t +munit_atomic_load(ATOMIC_UINT32_T *src) +{ + int ret; +#pragma omp critical(munit_atomics) + ret = *src; + return ret; +} + +static inline uint32_t +munit_atomic_cas(ATOMIC_UINT32_T *dest, ATOMIC_UINT32_T *expected, + ATOMIC_UINT32_T desired) +{ + munit_bool ret; + +#pragma omp critical(munit_atomics) + { + if (*dest == *expected) { + *dest = desired; + ret = 1; + } else { + ret = 0; + } + } + + return ret; +} +#elif defined(HAVE_STDATOMIC) +#define munit_atomic_store(dest, value) atomic_store(dest, value) +#define munit_atomic_load(src) atomic_load(src) +#define munit_atomic_cas(dest, expected, value) \ + atomic_compare_exchange_weak(dest, expected, value) +#elif defined(HAVE_CLANG_ATOMICS) +#define munit_atomic_store(dest, value) \ + __c11_atomic_store(dest, value, __ATOMIC_SEQ_CST) +#define munit_atomic_load(src) __c11_atomic_load(src, __ATOMIC_SEQ_CST) +#define munit_atomic_cas(dest, expected, value) \ + __c11_atomic_compare_exchange_weak(dest, expected, value, __ATOMIC_SEQ_CST, \ + __ATOMIC_SEQ_CST) +#elif defined(__GNUC__) && (__GNUC__ > 4) || \ + (__GNUC__ == 4 && __GNUC_MINOR__ >= 7) +#define munit_atomic_store(dest, value) \ + __atomic_store_n(dest, value, __ATOMIC_SEQ_CST) +#define munit_atomic_load(src) __atomic_load_n(src, __ATOMIC_SEQ_CST) +#define munit_atomic_cas(dest, expected, value) \ + __atomic_compare_exchange_n(dest, expected, value, 1, __ATOMIC_SEQ_CST, \ + __ATOMIC_SEQ_CST) +#elif defined(__GNUC__) && (__GNUC__ >= 4) +#define munit_atomic_store(dest, value) \ + do { \ + *(dest) = (value); \ + } while (0) +#define munit_atomic_load(src) (*(src)) +#define munit_atomic_cas(dest, expected, value) \ + __sync_bool_compare_and_swap(dest, *expected, value) +#elif defined(_WIN32) /* Untested */ +#define munit_atomic_store(dest, value) \ + do { \ + *(dest) = (value); \ + } while (0) +#define munit_atomic_load(src) (*(src)) +#define munit_atomic_cas(dest, expected, value) \ + InterlockedCompareExchange((dest), (value), *(expected)) +#else +#warning No atomic implementation, PRNG will not be thread-safe +#define munit_atomic_store(dest, value) \ + do { \ + *(dest) = (value); \ + } while (0) +#define munit_atomic_load(src) (*(src)) +static inline munit_bool +munit_atomic_cas(ATOMIC_UINT32_T *dest, ATOMIC_UINT32_T *expected, + ATOMIC_UINT32_T desired) +{ + if (*dest == *expected) { + *dest = desired; + return 1; + } else { + return 0; + } +} +#endif + +#define MUNIT_PRNG_MULTIPLIER (747796405U) +#define MUNIT_PRNG_INCREMENT (1729U) + +static munit_uint32_t +munit_rand_next_state(munit_uint32_t state) +{ + return state * MUNIT_PRNG_MULTIPLIER + MUNIT_PRNG_INCREMENT; +} + +static munit_uint32_t +munit_rand_from_state(munit_uint32_t state) +{ + munit_uint32_t res = ((state >> ((state >> 28) + 4)) ^ state) * (277803737U); + res ^= res >> 22; + return res; +} + +void +munit_rand_seed(munit_uint32_t seed) +{ + munit_uint32_t state = munit_rand_next_state(seed + MUNIT_PRNG_INCREMENT); + munit_atomic_store(&munit_rand_state, state); +} + +static munit_uint32_t +munit_rand_generate_seed(void) +{ + munit_uint32_t seed, state; +#if defined(MUNIT_ENABLE_TIMING) + struct PsnipClockTimespec wc = { + 0, + }; + + psnip_clock_get_time(PSNIP_CLOCK_TYPE_WALL, &wc); + seed = (munit_uint32_t)wc.nanoseconds; +#else + seed = (munit_uint32_t)time(NULL); +#endif + + state = munit_rand_next_state(seed + MUNIT_PRNG_INCREMENT); + return munit_rand_from_state(state); +} + +static munit_uint32_t +munit_rand_state_uint32(munit_uint32_t *state) +{ + const munit_uint32_t old = *state; + *state = munit_rand_next_state(old); + return munit_rand_from_state(old); +} + +munit_uint32_t +munit_rand_uint32(void) +{ + munit_uint32_t old, state; + + do { + old = munit_atomic_load(&munit_rand_state); + state = munit_rand_next_state(old); + } while (!munit_atomic_cas(&munit_rand_state, &old, state)); + + return munit_rand_from_state(old); +} + +static void +munit_rand_state_memory(munit_uint32_t *state, size_t size, + munit_uint8_t data[MUNIT_ARRAY_PARAM(size)]) +{ + size_t members_remaining = size / sizeof(munit_uint32_t); + size_t bytes_remaining = size % sizeof(munit_uint32_t); + munit_uint8_t *b = data; + munit_uint32_t rv; + while (members_remaining-- > 0) { + rv = munit_rand_state_uint32(state); + memcpy(b, &rv, sizeof(munit_uint32_t)); + b += sizeof(munit_uint32_t); + } + if (bytes_remaining != 0) { + rv = munit_rand_state_uint32(state); + memcpy(b, &rv, bytes_remaining); + } +} + +void +munit_rand_memory(size_t size, munit_uint8_t data[MUNIT_ARRAY_PARAM(size)]) +{ + munit_uint32_t old, state; + + do { + state = old = munit_atomic_load(&munit_rand_state); + munit_rand_state_memory(&state, size, data); + } while (!munit_atomic_cas(&munit_rand_state, &old, state)); +} + +static munit_uint32_t +munit_rand_state_at_most(munit_uint32_t *state, munit_uint32_t salt, + munit_uint32_t max) +{ + /* We want (UINT32_MAX + 1) % max, which in unsigned arithmetic is the same + * as (UINT32_MAX + 1 - max) % max = -max % max. We compute -max using not + * to avoid compiler warnings. + */ + const munit_uint32_t min = (~max + 1U) % max; + munit_uint32_t x; + + if (max == (~((munit_uint32_t)0U))) + return munit_rand_state_uint32(state) ^ salt; + + max++; + + do { + x = munit_rand_state_uint32(state) ^ salt; + } while (x < min); + + return x % max; +} + +static munit_uint32_t +munit_rand_at_most(munit_uint32_t salt, munit_uint32_t max) +{ + munit_uint32_t old, state; + munit_uint32_t retval; + + do { + state = old = munit_atomic_load(&munit_rand_state); + retval = munit_rand_state_at_most(&state, salt, max); + } while (!munit_atomic_cas(&munit_rand_state, &old, state)); + + return retval; +} + +int +munit_rand_int_range(int min, int max) +{ + munit_uint64_t range = (munit_uint64_t)max - (munit_uint64_t)min; + + if (min > max) + return munit_rand_int_range(max, min); + + if (range > (~((munit_uint32_t)0U))) + range = (~((munit_uint32_t)0U)); + + return min + munit_rand_at_most(0, (munit_uint32_t)range); +} + +double +munit_rand_double(void) +{ + munit_uint32_t old, state; + double retval = 0.0; + + do { + state = old = munit_atomic_load(&munit_rand_state); + + /* See http://mumble.net/~campbell/tmp/random_real.c for how to do + * this right. Patches welcome if you feel that this is too + * biased. */ + retval = munit_rand_state_uint32(&state) / ((~((munit_uint32_t)0U)) + 1.0); + } while (!munit_atomic_cas(&munit_rand_state, &old, state)); + + return retval; +} + +/*** Test suite handling ***/ + +typedef struct { + unsigned int successful; + unsigned int skipped; + unsigned int failed; + unsigned int errored; +#if defined(MUNIT_ENABLE_TIMING) + munit_uint64_t cpu_clock; + munit_uint64_t wall_clock; +#endif +} MunitReport; + +typedef struct { + const char *prefix; + const MunitSuite *suite; + const char **tests; + munit_uint32_t seed; + unsigned int iterations; + MunitParameter *parameters; + munit_bool single_parameter_mode; + void *user_data; + MunitReport report; + munit_bool colorize; + munit_bool fork; + munit_bool show_stderr; + munit_bool fatal_failures; +} MunitTestRunner; + +const char * +munit_parameters_get(const MunitParameter params[], const char *key) +{ + const MunitParameter *param; + + for (param = params; param != NULL && param->name != NULL; param++) + if (strcmp(param->name, key) == 0) + return param->value; + return NULL; +} + +#if defined(MUNIT_ENABLE_TIMING) +static void +munit_print_time(FILE *fp, munit_uint64_t nanoseconds) +{ + fprintf(fp, "%" MUNIT_TEST_TIME_FORMAT, + ((double)nanoseconds) / ((double)PSNIP_CLOCK_NSEC_PER_SEC)); +} +#endif + +/* Add a paramter to an array of parameters. */ +static MunitResult +munit_parameters_add(size_t *params_size, + MunitParameter *params[MUNIT_ARRAY_PARAM(*params_size)], char *name, + char *value) +{ + *params = realloc(*params, sizeof(MunitParameter) * (*params_size + 2)); + if (*params == NULL) + return MUNIT_ERROR; + + (*params)[*params_size].name = name; + (*params)[*params_size].value = value; + (*params_size)++; + (*params)[*params_size].name = NULL; + (*params)[*params_size].value = NULL; + + return MUNIT_OK; +} + +/* Concatenate two strings, but just return one of the components + * unaltered if the other is NULL or "". */ +static char * +munit_maybe_concat(size_t *len, char *prefix, char *suffix) +{ + char *res; + size_t res_l; + const size_t prefix_l = prefix != NULL ? strlen(prefix) : 0; + const size_t suffix_l = suffix != NULL ? strlen(suffix) : 0; + if (prefix_l == 0 && suffix_l == 0) { + res = NULL; + res_l = 0; + } else if (prefix_l == 0 && suffix_l != 0) { + res = suffix; + res_l = suffix_l; + } else if (prefix_l != 0 && suffix_l == 0) { + res = prefix; + res_l = prefix_l; + } else { + res_l = prefix_l + suffix_l; + res = malloc(res_l + 1); + memcpy(res, prefix, prefix_l); + memcpy(res + prefix_l, suffix, suffix_l); + res[res_l] = 0; + } + + if (len != NULL) + *len = res_l; + + return res; +} + +/* Possbily free a string returned by munit_maybe_concat. */ +static void +munit_maybe_free_concat(char *s, const char *prefix, const char *suffix) +{ + if (prefix != s && suffix != s) + free(s); +} + +/* Cheap string hash function, just used to salt the PRNG. */ +static munit_uint32_t +munit_str_hash(const char *name) +{ + const char *p; + munit_uint32_t h = 5381U; + + for (p = name; *p != '\0'; p++) + h = (h << 5) + h + *p; + + return h; +} + +static void +munit_splice(int from, int to) +{ + munit_uint8_t buf[1024]; +#if !defined(_WIN32) + ssize_t len; + ssize_t bytes_written; + ssize_t write_res; +#else + int len; + int bytes_written; + int write_res; +#endif + do { + len = read(from, buf, sizeof(buf)); + if (len > 0) { + bytes_written = 0; + do { + write_res = write(to, buf + bytes_written, len - bytes_written); + if (write_res < 0) + break; + bytes_written += write_res; + } while (bytes_written < len); + } else + break; + } while (1); +} + +/* This is the part that should be handled in the child process */ +static MunitResult +munit_test_runner_exec(MunitTestRunner *runner, const MunitTest *test, + const MunitParameter params[], MunitReport *report) +{ + unsigned int iterations = runner->iterations; + MunitResult result = MUNIT_FAIL; +#if defined(MUNIT_ENABLE_TIMING) + struct PsnipClockTimespec wall_clock_begin = { 0, }, wall_clock_end = { 0, }; + struct PsnipClockTimespec cpu_clock_begin = { 0, }, cpu_clock_end = { 0, }; +#endif + unsigned int i = 0; + + if ((test->options & MUNIT_TEST_OPTION_SINGLE_ITERATION) == + MUNIT_TEST_OPTION_SINGLE_ITERATION) + iterations = 1; + else if (iterations == 0) + iterations = runner->suite->iterations; + + munit_rand_seed(runner->seed); + + do { + void *data = (test->setup == NULL) ? runner->user_data : + test->setup(params, runner->user_data); + +#if defined(MUNIT_ENABLE_TIMING) + psnip_clock_get_time(PSNIP_CLOCK_TYPE_WALL, &wall_clock_begin); + psnip_clock_get_time(PSNIP_CLOCK_TYPE_CPU, &cpu_clock_begin); +#endif + + result = test->test(params, data); + +#if defined(MUNIT_ENABLE_TIMING) + psnip_clock_get_time(PSNIP_CLOCK_TYPE_WALL, &wall_clock_end); + psnip_clock_get_time(PSNIP_CLOCK_TYPE_CPU, &cpu_clock_end); +#endif + + if (test->tear_down != NULL) + test->tear_down(data); + + if (MUNIT_LIKELY(result == MUNIT_OK)) { + report->successful++; +#if defined(MUNIT_ENABLE_TIMING) + report->wall_clock += munit_clock_get_elapsed(&wall_clock_begin, + &wall_clock_end); + report->cpu_clock += munit_clock_get_elapsed(&cpu_clock_begin, + &cpu_clock_end); +#endif + } else { + switch ((int)result) { + case MUNIT_SKIP: + report->skipped++; + break; + case MUNIT_FAIL: + report->failed++; + break; + case MUNIT_ERROR: + report->errored++; + break; + default: + break; + } + break; + } + } while (++i < iterations); + + return result; +} + +#if defined(MUNIT_EMOTICON) +#define MUNIT_RESULT_STRING_OK ":)" +#define MUNIT_RESULT_STRING_SKIP ":|" +#define MUNIT_RESULT_STRING_FAIL ":(" +#define MUNIT_RESULT_STRING_ERROR ":o" +#define MUNIT_RESULT_STRING_TODO ":/" +#else +#define MUNIT_RESULT_STRING_OK "OK " +#define MUNIT_RESULT_STRING_SKIP "SKIP " +#define MUNIT_RESULT_STRING_FAIL "FAIL " +#define MUNIT_RESULT_STRING_ERROR "ERROR" +#define MUNIT_RESULT_STRING_TODO "TODO " +#endif + +static void +munit_test_runner_print_color(const MunitTestRunner *runner, const char *string, + char color) +{ + if (runner->colorize) + fprintf(MUNIT_OUTPUT_FILE, "\x1b[3%cm%s\x1b[39m", color, string); + else + fputs(string, MUNIT_OUTPUT_FILE); +} + +#if !defined(MUNIT_NO_BUFFER) +static int +munit_replace_stderr(FILE *stderr_buf) +{ + if (stderr_buf != NULL) { + const int orig_stderr = dup(STDERR_FILENO); + + int errfd = fileno(stderr_buf); + if (MUNIT_UNLIKELY(errfd == -1)) { + exit(EXIT_FAILURE); + } + + dup2(errfd, STDERR_FILENO); + + return orig_stderr; + } + + return -1; +} + +static void +munit_restore_stderr(int orig_stderr) +{ + if (orig_stderr != -1) { + dup2(orig_stderr, STDERR_FILENO); + close(orig_stderr); + } +} +#endif /* !defined(MUNIT_NO_BUFFER) */ + +/* Run a test with the specified parameters. */ +static void +munit_test_runner_run_test_with_params(MunitTestRunner *runner, + const MunitTest *test, const MunitParameter params[]) +{ + MunitResult result = MUNIT_OK; + MunitReport report = { + 0, + 0, + 0, + 0, +#if defined(MUNIT_ENABLE_TIMING) + 0, + 0 +#endif + }; + unsigned int output_l; + munit_bool first; + const MunitParameter *param; + FILE *stderr_buf; +#if !defined(MUNIT_NO_FORK) + int pipefd[2]; + pid_t fork_pid; + int orig_stderr; + ssize_t bytes_written = 0; + ssize_t write_res; + ssize_t bytes_read = 0; + ssize_t read_res; + int status = 0; + pid_t changed_pid; +#endif + + if (params != NULL) { + output_l = 2; + fputs(" ", MUNIT_OUTPUT_FILE); + first = 1; + for (param = params; param != NULL && param->name != NULL; param++) { + if (!first) { + fputs(", ", MUNIT_OUTPUT_FILE); + output_l += 2; + } else { + first = 0; + } + + output_l += fprintf(MUNIT_OUTPUT_FILE, "%s=%s", param->name, + param->value); + } + while (output_l++ < MUNIT_TEST_NAME_LEN) { + fputc(' ', MUNIT_OUTPUT_FILE); + } + } + + fflush(MUNIT_OUTPUT_FILE); + + stderr_buf = NULL; +#if !defined(_WIN32) || defined(__MINGW32__) + stderr_buf = tmpfile(); +#else + tmpfile_s(&stderr_buf); +#endif + if (stderr_buf == NULL) { + munit_log_errno(MUNIT_LOG_ERROR, stderr, + "unable to create buffer for stderr"); + result = MUNIT_ERROR; + goto print_result; + } + +#if !defined(MUNIT_NO_FORK) + if (runner->fork) { + pipefd[0] = -1; + pipefd[1] = -1; + if (pipe(pipefd) != 0) { + munit_log_errno(MUNIT_LOG_ERROR, stderr, "unable to create pipe"); + result = MUNIT_ERROR; + goto print_result; + } + + fork_pid = fork(); + if (fork_pid == 0) { + close(pipefd[0]); + + orig_stderr = munit_replace_stderr(stderr_buf); + munit_test_runner_exec(runner, test, params, &report); + + /* Note that we don't restore stderr. This is so we can buffer + * things written to stderr later on (such as by + * asan/tsan/ubsan, valgrind, etc.) */ + close(orig_stderr); + + do { + write_res = write(pipefd[1], + ((munit_uint8_t *)(&report)) + bytes_written, + sizeof(report) - bytes_written); + if (write_res < 0) { + if (stderr_buf != NULL) { + munit_log_errno(MUNIT_LOG_ERROR, stderr, "unable to write to pipe"); + } + exit(EXIT_FAILURE); + } + bytes_written += write_res; + } while ((size_t)bytes_written < sizeof(report)); + + if (stderr_buf != NULL) + fclose(stderr_buf); + close(pipefd[1]); + + exit(EXIT_SUCCESS); + } else if (fork_pid == -1) { + close(pipefd[0]); + close(pipefd[1]); + if (stderr_buf != NULL) { + munit_log_errno(MUNIT_LOG_ERROR, stderr, "unable to fork"); + } + report.errored++; + result = MUNIT_ERROR; + } else { + close(pipefd[1]); + do { + read_res = read(pipefd[0], ((munit_uint8_t *)(&report)) + bytes_read, + sizeof(report) - bytes_read); + if (read_res < 1) + break; + bytes_read += read_res; + } while (bytes_read < (ssize_t)sizeof(report)); + + changed_pid = waitpid(fork_pid, &status, 0); + + if (MUNIT_LIKELY(changed_pid == fork_pid) && + MUNIT_LIKELY(WIFEXITED(status))) { + if (bytes_read != sizeof(report)) { + munit_logf_internal(MUNIT_LOG_ERROR, stderr_buf, + "child exited unexpectedly with status %d", WEXITSTATUS(status)); + report.errored++; + } else if (WEXITSTATUS(status) != EXIT_SUCCESS) { + munit_logf_internal(MUNIT_LOG_ERROR, stderr_buf, + "child exited with status %d", WEXITSTATUS(status)); + report.errored++; + } + } else { + if (WIFSIGNALED(status)) { +#if defined(_XOPEN_VERSION) && (_XOPEN_VERSION >= 700) + munit_logf_internal(MUNIT_LOG_ERROR, stderr_buf, + "child killed by signal %d (%s)", WTERMSIG(status), + strsignal(WTERMSIG(status))); +#else + munit_logf_internal(MUNIT_LOG_ERROR, stderr_buf, + "child killed by signal %d", WTERMSIG(status)); +#endif + } else if (WIFSTOPPED(status)) { + munit_logf_internal(MUNIT_LOG_ERROR, stderr_buf, + "child stopped by signal %d", WSTOPSIG(status)); + } + report.errored++; + } + + close(pipefd[0]); + waitpid(fork_pid, NULL, 0); + } + } else +#endif + { +#if !defined(MUNIT_NO_BUFFER) + const volatile int orig_stderr = munit_replace_stderr(stderr_buf); +#endif + +#if defined(MUNIT_THREAD_LOCAL) + if (MUNIT_UNLIKELY(setjmp(munit_error_jmp_buf) != 0)) { + result = MUNIT_FAIL; + report.failed++; + } else { + munit_error_jmp_buf_valid = 1; + result = munit_test_runner_exec(runner, test, params, &report); + } +#else + result = munit_test_runner_exec(runner, test, params, &report); +#endif + +#if !defined(MUNIT_NO_BUFFER) + munit_restore_stderr(orig_stderr); +#endif + + /* Here just so that the label is used on Windows and we don't get + * a warning */ + goto print_result; + } + +print_result: + + fputs("[ ", MUNIT_OUTPUT_FILE); + if ((test->options & MUNIT_TEST_OPTION_TODO) == MUNIT_TEST_OPTION_TODO) { + if (report.failed != 0 || report.errored != 0 || report.skipped != 0) { + munit_test_runner_print_color(runner, MUNIT_RESULT_STRING_TODO, '3'); + result = MUNIT_OK; + } else { + munit_test_runner_print_color(runner, MUNIT_RESULT_STRING_ERROR, '1'); + if (MUNIT_LIKELY(stderr_buf != NULL)) + munit_log_internal(MUNIT_LOG_ERROR, stderr_buf, + "Test marked TODO, but was successful."); + runner->report.failed++; + result = MUNIT_ERROR; + } + } else if (report.failed > 0) { + munit_test_runner_print_color(runner, MUNIT_RESULT_STRING_FAIL, '1'); + runner->report.failed++; + result = MUNIT_FAIL; + } else if (report.errored > 0) { + munit_test_runner_print_color(runner, MUNIT_RESULT_STRING_ERROR, '1'); + runner->report.errored++; + result = MUNIT_ERROR; + } else if (report.skipped > 0) { + munit_test_runner_print_color(runner, MUNIT_RESULT_STRING_SKIP, '3'); + runner->report.skipped++; + result = MUNIT_SKIP; + } else if (report.successful > 1) { + munit_test_runner_print_color(runner, MUNIT_RESULT_STRING_OK, '2'); +#if defined(MUNIT_ENABLE_TIMING) + fputs(" ] [ ", MUNIT_OUTPUT_FILE); + munit_print_time(MUNIT_OUTPUT_FILE, report.wall_clock / report.successful); + fputs(" / ", MUNIT_OUTPUT_FILE); + munit_print_time(MUNIT_OUTPUT_FILE, report.cpu_clock / report.successful); + fprintf(MUNIT_OUTPUT_FILE, + " CPU ]\n %-" MUNIT_XSTRINGIFY(MUNIT_TEST_NAME_LEN) "s Total: [ ", ""); + munit_print_time(MUNIT_OUTPUT_FILE, report.wall_clock); + fputs(" / ", MUNIT_OUTPUT_FILE); + munit_print_time(MUNIT_OUTPUT_FILE, report.cpu_clock); + fputs(" CPU", MUNIT_OUTPUT_FILE); +#endif + runner->report.successful++; + result = MUNIT_OK; + } else if (report.successful > 0) { + munit_test_runner_print_color(runner, MUNIT_RESULT_STRING_OK, '2'); +#if defined(MUNIT_ENABLE_TIMING) + fputs(" ] [ ", MUNIT_OUTPUT_FILE); + munit_print_time(MUNIT_OUTPUT_FILE, report.wall_clock); + fputs(" / ", MUNIT_OUTPUT_FILE); + munit_print_time(MUNIT_OUTPUT_FILE, report.cpu_clock); + fputs(" CPU", MUNIT_OUTPUT_FILE); +#endif + runner->report.successful++; + result = MUNIT_OK; + } + fputs(" ]\n", MUNIT_OUTPUT_FILE); + + if (stderr_buf != NULL) { + if (result == MUNIT_FAIL || result == MUNIT_ERROR || runner->show_stderr) { + fflush(MUNIT_OUTPUT_FILE); + + rewind(stderr_buf); + munit_splice(fileno(stderr_buf), STDERR_FILENO); + + fflush(stderr); + } + + fclose(stderr_buf); + } +} + +static void +munit_test_runner_run_test_wild(MunitTestRunner *runner, const MunitTest *test, + const char *test_name, MunitParameter *params, MunitParameter *p) +{ + const MunitParameterEnum *pe; + char **values; + MunitParameter *next; + + for (pe = test->parameters; pe != NULL && pe->name != NULL; pe++) { + if (p->name == pe->name) + break; + } + + if (pe == NULL) + return; + + for (values = pe->values; *values != NULL; values++) { + next = p + 1; + p->value = *values; + if (next->name == NULL) { + munit_test_runner_run_test_with_params(runner, test, params); + } else { + munit_test_runner_run_test_wild(runner, test, test_name, params, next); + } + if (runner->fatal_failures && + (runner->report.failed != 0 || runner->report.errored != 0)) + break; + } +} + +/* Run a single test, with every combination of parameters + * requested. */ +static void +munit_test_runner_run_test(MunitTestRunner *runner, const MunitTest *test, + const char *prefix) +{ + char *test_name = munit_maybe_concat(NULL, (char *)prefix, + (char *)test->name); + /* The array of parameters to pass to + * munit_test_runner_run_test_with_params */ + MunitParameter *params = NULL; + size_t params_l = 0; + /* Wildcard parameters are parameters which have possible values + * specified in the test, but no specific value was passed to the + * CLI. That means we want to run the test once for every + * possible combination of parameter values or, if --single was + * passed to the CLI, a single time with a random set of + * parameters. */ + MunitParameter *wild_params = NULL; + size_t wild_params_l = 0; + const MunitParameterEnum *pe; + const MunitParameter *cli_p; + munit_bool filled; + unsigned int possible; + char **vals; + size_t first_wild; + const MunitParameter *wp; + int pidx; + + munit_rand_seed(runner->seed); + + fprintf(MUNIT_OUTPUT_FILE, "%-" MUNIT_XSTRINGIFY(MUNIT_TEST_NAME_LEN) "s", + test_name); + + if (test->parameters == NULL) { + /* No parameters. Simple, nice. */ + munit_test_runner_run_test_with_params(runner, test, NULL); + } else { + fputc('\n', MUNIT_OUTPUT_FILE); + + for (pe = test->parameters; pe != NULL && pe->name != NULL; pe++) { + /* Did we received a value for this parameter from the CLI? */ + filled = 0; + for (cli_p = runner->parameters; cli_p != NULL && cli_p->name != NULL; + cli_p++) { + if (strcmp(cli_p->name, pe->name) == 0) { + if (MUNIT_UNLIKELY(munit_parameters_add(¶ms_l, ¶ms, pe->name, + cli_p->value) != MUNIT_OK)) + goto cleanup; + filled = 1; + break; + } + } + if (filled) + continue; + + /* Nothing from CLI, is the enum NULL/empty? We're not a + * fuzzer… */ + if (pe->values == NULL || pe->values[0] == NULL) + continue; + + /* If --single was passed to the CLI, choose a value from the + * list of possibilities randomly. */ + if (runner->single_parameter_mode) { + possible = 0; + for (vals = pe->values; *vals != NULL; vals++) + possible++; + /* We want the tests to be reproducible, even if you're only + * running a single test, but we don't want every test with + * the same number of parameters to choose the same parameter + * number, so use the test name as a primitive salt. */ + pidx = munit_rand_at_most(munit_str_hash(test_name), possible - 1); + if (MUNIT_UNLIKELY(munit_parameters_add(¶ms_l, ¶ms, pe->name, + pe->values[pidx]) != MUNIT_OK)) + goto cleanup; + } else { + /* We want to try every permutation. Put in a placeholder + * entry, we'll iterate through them later. */ + if (MUNIT_UNLIKELY(munit_parameters_add(&wild_params_l, &wild_params, + pe->name, NULL) != MUNIT_OK)) + goto cleanup; + } + } + + if (wild_params_l != 0) { + first_wild = params_l; + for (wp = wild_params; wp != NULL && wp->name != NULL; wp++) { + for (pe = test->parameters; + pe != NULL && pe->name != NULL && pe->values != NULL; pe++) { + if (strcmp(wp->name, pe->name) == 0) { + if (MUNIT_UNLIKELY(munit_parameters_add(¶ms_l, ¶ms, + pe->name, pe->values[0]) != MUNIT_OK)) + goto cleanup; + } + } + } + + munit_test_runner_run_test_wild(runner, test, test_name, params, + params + first_wild); + } else { + munit_test_runner_run_test_with_params(runner, test, params); + } + + cleanup: + free(params); + free(wild_params); + } + + munit_maybe_free_concat(test_name, prefix, test->name); +} + +/* Recurse through the suite and run all the tests. If a list of + * tests to run was provied on the command line, run only those + * tests. */ +static void +munit_test_runner_run_suite(MunitTestRunner *runner, const MunitSuite *suite, + const char *prefix) +{ + size_t pre_l; + char *pre = munit_maybe_concat(&pre_l, (char *)prefix, (char *)suite->prefix); + const MunitTest *test; + const char **test_name; + const MunitSuite *child_suite; + + /* Run the tests. */ + for (test = suite->tests; test != NULL && test->test != NULL; test++) { + if (runner->tests != NULL) { /* Specific tests were requested on the CLI */ + for (test_name = runner->tests; test_name != NULL && *test_name != NULL; + test_name++) { + if ((pre_l == 0 || strncmp(pre, *test_name, pre_l) == 0) && + strncmp(test->name, *test_name + pre_l, strlen(*test_name + pre_l)) == + 0) { + munit_test_runner_run_test(runner, test, pre); + if (runner->fatal_failures && + (runner->report.failed != 0 || runner->report.errored != 0)) + goto cleanup; + } + } + } else { /* Run all tests */ + munit_test_runner_run_test(runner, test, pre); + } + } + + if (runner->fatal_failures && + (runner->report.failed != 0 || runner->report.errored != 0)) + goto cleanup; + + /* Run any child suites. */ + for (child_suite = suite->suites; + child_suite != NULL && child_suite->prefix != NULL; child_suite++) { + munit_test_runner_run_suite(runner, child_suite, pre); + } + +cleanup: + + munit_maybe_free_concat(pre, prefix, suite->prefix); +} + +static void +munit_test_runner_run(MunitTestRunner *runner) +{ + munit_test_runner_run_suite(runner, runner->suite, NULL); +} + +static void +munit_print_help(int argc, char *const argv[MUNIT_ARRAY_PARAM(argc + 1)], + void *user_data, const MunitArgument arguments[]) +{ + const MunitArgument *arg; + (void)argc; + + printf("USAGE: %s [OPTIONS...] [TEST...]\n\n", argv[0]); + puts( + " --seed SEED\n" + " Value used to seed the PRNG. Must be a 32-bit integer in decimal\n" + " notation with no separators (commas, decimals, spaces, etc.), or\n" + " hexidecimal prefixed by \"0x\".\n" + " --iterations N\n" + " Run each test N times. 0 means the default number.\n" + " --param name value\n" + " A parameter key/value pair which will be passed to any test with\n" + " takes a parameter of that name. If not provided, the test will be\n" + " run once for each possible parameter value.\n" + " --list Write a list of all available tests.\n" + " --list-params\n" + " Write a list of all available tests and their possible parameters.\n" + " --single Run each parameterized test in a single configuration instead of\n" + " every possible combination\n" + " --log-visible debug|info|warning|error\n" + " --log-fatal debug|info|warning|error\n" + " Set the level at which messages of different severities are visible,\n" + " or cause the test to terminate.\n" +#if !defined(MUNIT_NO_FORK) + " --no-fork Do not execute tests in a child process. If this option is supplied\n" + " and a test crashes (including by failing an assertion), no further\n" + " tests will be performed.\n" +#endif + " --fatal-failures\n" + " Stop executing tests as soon as a failure is found.\n" + " --show-stderr\n" + " Show data written to stderr by the tests, even if the test succeeds.\n" + " --color auto|always|never\n" + " Colorize (or don't) the output.\n" + /* 12345678901234567890123456789012345678901234567890123456789012345678901234567890 + */ + " --help Print this help message and exit.\n"); +#if defined(MUNIT_NL_LANGINFO) + setlocale(LC_ALL, ""); + fputs((strcasecmp("UTF-8", nl_langinfo(CODESET)) == 0) ? "µnit" : "munit", + stdout); +#else + puts("munit"); +#endif + printf(" %d.%d.%d\n" + "Full documentation at: https://nemequ.github.io/munit/\n", + (MUNIT_CURRENT_VERSION >> 16) & 0xff, (MUNIT_CURRENT_VERSION >> 8) & 0xff, + (MUNIT_CURRENT_VERSION >> 0) & 0xff); + for (arg = arguments; arg != NULL && arg->name != NULL; arg++) + arg->write_help(arg, user_data); +} + +static const MunitArgument * +munit_arguments_find(const MunitArgument arguments[], const char *name) +{ + const MunitArgument *arg; + + for (arg = arguments; arg != NULL && arg->name != NULL; arg++) + if (strcmp(arg->name, name) == 0) + return arg; + + return NULL; +} + +static void +munit_suite_list_tests(const MunitSuite *suite, munit_bool show_params, + const char *prefix) +{ + size_t pre_l; + char *pre = munit_maybe_concat(&pre_l, (char *)prefix, (char *)suite->prefix); + const MunitTest *test; + const MunitParameterEnum *params; + munit_bool first; + char **val; + const MunitSuite *child_suite; + + for (test = suite->tests; test != NULL && test->name != NULL; test++) { + if (pre != NULL) + fputs(pre, stdout); + puts(test->name); + + if (show_params) { + for (params = test->parameters; params != NULL && params->name != NULL; + params++) { + fprintf(stdout, " - %s: ", params->name); + if (params->values == NULL) { + puts("Any"); + } else { + first = 1; + for (val = params->values; *val != NULL; val++) { + if (!first) { + fputs(", ", stdout); + } else { + first = 0; + } + fputs(*val, stdout); + } + putc('\n', stdout); + } + } + } + } + + for (child_suite = suite->suites; + child_suite != NULL && child_suite->prefix != NULL; child_suite++) { + munit_suite_list_tests(child_suite, show_params, pre); + } + + munit_maybe_free_concat(pre, prefix, suite->prefix); +} + +static munit_bool +munit_stream_supports_ansi(FILE *stream) +{ +#if !defined(_WIN32) + return isatty(fileno(stream)); +#else + +#if !defined(__MINGW32__) + size_t ansicon_size = 0; +#endif + + if (isatty(fileno(stream))) { +#if !defined(__MINGW32__) + getenv_s(&ansicon_size, NULL, 0, "ANSICON"); + return ansicon_size != 0; +#else + return getenv("ANSICON") != NULL; +#endif + } + return 0; +#endif +} + +int +munit_suite_main_custom(const MunitSuite *suite, void *user_data, int argc, + char *const argv[MUNIT_ARRAY_PARAM(argc + 1)], + const MunitArgument arguments[]) +{ + int result = EXIT_FAILURE; + MunitTestRunner runner; + size_t parameters_size = 0; + size_t tests_size = 0; + int arg; + + char *envptr; + unsigned long ts; + char *endptr; + unsigned long long iterations; + MunitLogLevel level; + const MunitArgument *argument; + const char **runner_tests; + unsigned int tests_run; + unsigned int tests_total; + + runner.prefix = NULL; + runner.suite = NULL; + runner.tests = NULL; + runner.seed = 0; + runner.iterations = 0; + runner.parameters = NULL; + runner.single_parameter_mode = 0; + runner.user_data = NULL; + + runner.report.successful = 0; + runner.report.skipped = 0; + runner.report.failed = 0; + runner.report.errored = 0; +#if defined(MUNIT_ENABLE_TIMING) + runner.report.cpu_clock = 0; + runner.report.wall_clock = 0; +#endif + + runner.colorize = 0; +#if !defined(_WIN32) + runner.fork = 1; +#else + runner.fork = 0; +#endif + runner.show_stderr = 0; + runner.fatal_failures = 0; + runner.suite = suite; + runner.user_data = user_data; + runner.seed = munit_rand_generate_seed(); + runner.colorize = munit_stream_supports_ansi(MUNIT_OUTPUT_FILE); + + for (arg = 1; arg < argc; arg++) { + if (strncmp("--", argv[arg], 2) == 0) { + if (strcmp("seed", argv[arg] + 2) == 0) { + if (arg + 1 >= argc) { + munit_logf_internal(MUNIT_LOG_ERROR, stderr, + "%s requires an argument", argv[arg]); + goto cleanup; + } + + envptr = argv[arg + 1]; + ts = strtoul(argv[arg + 1], &envptr, 0); + if (*envptr != '\0' || ts > (~((munit_uint32_t)0U))) { + munit_logf_internal(MUNIT_LOG_ERROR, stderr, + "invalid value ('%s') passed to %s", argv[arg + 1], argv[arg]); + goto cleanup; + } + runner.seed = (munit_uint32_t)ts; + + arg++; + } else if (strcmp("iterations", argv[arg] + 2) == 0) { + if (arg + 1 >= argc) { + munit_logf_internal(MUNIT_LOG_ERROR, stderr, + "%s requires an argument", argv[arg]); + goto cleanup; + } + + endptr = argv[arg + 1]; + iterations = strtoul(argv[arg + 1], &endptr, 0); + if (*endptr != '\0' || iterations > UINT_MAX) { + munit_logf_internal(MUNIT_LOG_ERROR, stderr, + "invalid value ('%s') passed to %s", argv[arg + 1], argv[arg]); + goto cleanup; + } + + runner.iterations = (unsigned int)iterations; + + arg++; + } else if (strcmp("param", argv[arg] + 2) == 0) { + if (arg + 2 >= argc) { + munit_logf_internal(MUNIT_LOG_ERROR, stderr, + "%s requires two arguments", argv[arg]); + goto cleanup; + } + + runner.parameters = realloc(runner.parameters, + sizeof(MunitParameter) * (parameters_size + 2)); + if (runner.parameters == NULL) { + munit_log_internal(MUNIT_LOG_ERROR, stderr, + "failed to allocate memory"); + goto cleanup; + } + runner.parameters[parameters_size].name = (char *)argv[arg + 1]; + runner.parameters[parameters_size].value = (char *)argv[arg + 2]; + parameters_size++; + runner.parameters[parameters_size].name = NULL; + runner.parameters[parameters_size].value = NULL; + arg += 2; + } else if (strcmp("color", argv[arg] + 2) == 0) { + if (arg + 1 >= argc) { + munit_logf_internal(MUNIT_LOG_ERROR, stderr, + "%s requires an argument", argv[arg]); + goto cleanup; + } + + if (strcmp(argv[arg + 1], "always") == 0) + runner.colorize = 1; + else if (strcmp(argv[arg + 1], "never") == 0) + runner.colorize = 0; + else if (strcmp(argv[arg + 1], "auto") == 0) + runner.colorize = munit_stream_supports_ansi(MUNIT_OUTPUT_FILE); + else { + munit_logf_internal(MUNIT_LOG_ERROR, stderr, + "invalid value ('%s') passed to %s", argv[arg + 1], argv[arg]); + goto cleanup; + } + + arg++; + } else if (strcmp("help", argv[arg] + 2) == 0) { + munit_print_help(argc, argv, user_data, arguments); + result = EXIT_SUCCESS; + goto cleanup; + } else if (strcmp("single", argv[arg] + 2) == 0) { + runner.single_parameter_mode = 1; + } else if (strcmp("show-stderr", argv[arg] + 2) == 0) { + runner.show_stderr = 1; +#if !defined(_WIN32) + } else if (strcmp("no-fork", argv[arg] + 2) == 0) { + runner.fork = 0; +#endif + } else if (strcmp("fatal-failures", argv[arg] + 2) == 0) { + runner.fatal_failures = 1; + } else if (strcmp("log-visible", argv[arg] + 2) == 0 || + strcmp("log-fatal", argv[arg] + 2) == 0) { + if (arg + 1 >= argc) { + munit_logf_internal(MUNIT_LOG_ERROR, stderr, + "%s requires an argument", argv[arg]); + goto cleanup; + } + + if (strcmp(argv[arg + 1], "debug") == 0) + level = MUNIT_LOG_DEBUG; + else if (strcmp(argv[arg + 1], "info") == 0) + level = MUNIT_LOG_INFO; + else if (strcmp(argv[arg + 1], "warning") == 0) + level = MUNIT_LOG_WARNING; + else if (strcmp(argv[arg + 1], "error") == 0) + level = MUNIT_LOG_ERROR; + else { + munit_logf_internal(MUNIT_LOG_ERROR, stderr, + "invalid value ('%s') passed to %s", argv[arg + 1], argv[arg]); + goto cleanup; + } + + if (strcmp("log-visible", argv[arg] + 2) == 0) + munit_log_level_visible = level; + else + munit_log_level_fatal = level; + + arg++; + } else if (strcmp("list", argv[arg] + 2) == 0) { + munit_suite_list_tests(suite, 0, NULL); + result = EXIT_SUCCESS; + goto cleanup; + } else if (strcmp("list-params", argv[arg] + 2) == 0) { + munit_suite_list_tests(suite, 1, NULL); + result = EXIT_SUCCESS; + goto cleanup; + } else { + argument = munit_arguments_find(arguments, argv[arg] + 2); + if (argument == NULL) { + munit_logf_internal(MUNIT_LOG_ERROR, stderr, + "unknown argument ('%s')", argv[arg]); + goto cleanup; + } + + if (!argument->parse_argument(suite, user_data, &arg, argc, argv)) + goto cleanup; + } + } else { + runner_tests = realloc((void *)runner.tests, + sizeof(char *) * (tests_size + 2)); + if (runner_tests == NULL) { + munit_log_internal(MUNIT_LOG_ERROR, stderr, + "failed to allocate memory"); + goto cleanup; + } + runner.tests = runner_tests; + runner.tests[tests_size++] = argv[arg]; + runner.tests[tests_size] = NULL; + } + } + + fflush(stderr); + fprintf(MUNIT_OUTPUT_FILE, + "Running test suite with seed 0x%08" PRIx32 "...\n", runner.seed); + + munit_test_runner_run(&runner); + + tests_run = runner.report.successful + runner.report.failed + + runner.report.errored; + tests_total = tests_run + runner.report.skipped; + if (tests_run == 0) { + fprintf(stderr, "No tests run, %d (100%%) skipped.\n", + runner.report.skipped); + } else { + fprintf(MUNIT_OUTPUT_FILE, + "%d of %d (%0.0f%%) tests successful, %d (%0.0f%%) test skipped.\n", + runner.report.successful, tests_run, + (((double)runner.report.successful) / ((double)tests_run)) * 100.0, + runner.report.skipped, + (((double)runner.report.skipped) / ((double)tests_total)) * 100.0); + } + + if (runner.report.failed == 0 && runner.report.errored == 0) { + result = EXIT_SUCCESS; + } + +cleanup: + free(runner.parameters); + free((void *)runner.tests); + + return result; +} + +int +munit_suite_main(const MunitSuite *suite, void *user_data, int argc, + char *const argv[MUNIT_ARRAY_PARAM(argc + 1)]) +{ + return munit_suite_main_custom(suite, user_data, argc, argv, NULL); +}