tigerbeetle-node 0.3.3 → 0.5.0

package/src/tigerbeetle/scripts/install_zig.bat

@@ -0,0 +1,109 @@
+@echo off
+
+set DEFAULT_RELEASE=0.8.1
+
+:: Determine the Zig build:
+if "%~1"=="" (
+    set ZIG_RELEASE=%DEFAULT_RELEASE%
+) else if "%~1"=="latest" (
+    set ZIG_RELEASE=builds
+) else (
+    set ZIG_RELEASE=%~1
+)
+
+:: Checks format of release version.
+echo.%ZIG_RELEASE% | findstr /b /r /c:"builds" /c:"^[0-9][0-9]*.[0-9][0-9]*.[0-9][0-9]*">nul || (echo.Unexpected release format. && exit 1)
+
+set ZIG_OS=windows
+set ZIG_ARCH=x86_64
+
+set ZIG_TARGET=zig-%ZIG_OS%-%ZIG_ARCH%
+
+:: Determine the build, split the JSON line on whitespace and extract the 2nd field:
+for /f "tokens=2" %%a in ('curl --silent https://ziglang.org/download/index.json ^| findstr %ZIG_TARGET% ^| findstr %ZIG_RELEASE%' ) do (
+  set ZIG_URL=%%a
+)
+
+:: Then remove quotes and commas:
+for /f %%b in ("%ZIG_URL:,=%") do (
+    set ZIG_URL=%%~b
+)
+
+:: Checks the ZIG_URL variable follows the expected format.
+echo.%ZIG_URL% | findstr /b /r /c:"https://ziglang.org/builds/" /c:"https://ziglang.org/download/%ZIG_RELEASE%">nul || (echo.Unexpected release URL format. && exit 1)
+
+if "%ZIG_RELEASE%"=="builds" (
+    echo Installing Zig latest build...
+) else (
+    echo Installing Zig %ZIG_RELEASE% release build...
+)
+
+:: Using variable modifiers to determine the directory and filename from the URL:
+:: %~ni Expands %i to a file name only and %~xi Expands %i to a file name extension only.
+for /f %%i in ("%ZIG_URL%") do (
+    set ZIG_DIRECTORY=%%~ni
+    set ZIG_TARBALL=%%~nxi
+)
+
+:: Checks the ZIG_DIRECTORY variable follows the expected format.
+echo.%ZIG_DIRECTORY% | findstr /b /r /c:"zig-win64-" /c:"zig-windows-x86_64-">nul || (echo.Unexpected zip directory name format. && exit 1)
+
+:: Making sure we download to the same output document, without wget adding "-1" etc. if the file was previously partially downloaded:
+if exist %ZIG_TARBALL% (
+  del /q %ZIG_TARBALL%
+  if exist %ZIG_TARBALL% (
+    echo Failed to delete %ZIG_TARBALL%.
+    exit 1
+  )
+)
+
+echo Downloading %ZIG_URL%...
+curl --silent --progress-bar --output %ZIG_TARBALL% %ZIG_URL%
+if not exist  %ZIG_TARBALL% (
+  echo Failed to download Zig zip file.
+  exit 1
+)
+
+:: Replace any existing Zig installation so that we can install or upgrade:
+echo Removing any existing 'zig' and %ZIG_DIRECTORY% folders before extracting.
+if exist zig\ (
+  rd /s /q zig\
+  :: Ensure the directory has been deleted.
+  if exist zig\ (
+    echo The ‘zig’ directory could not be deleted.
+    exit 1
+  )
+)
+
+if exist %ZIG_DIRECTORY%\ (
+  rd /s /q %ZIG_DIRECTORY%
+  :: Ensure the directory has been deleted.
+  if exist %ZIG_DIRECTORY% (
+    echo The %ZIG_DIRECTORY% directory could not be deleted.
+    exit 1
+  )
+)
+
+:: Extract and then remove the downloaded tarball:
+echo Extracting %ZIG_TARBALL%...
+powershell -Command "Expand-Archive %ZIG_TARBALL% -DestinationPath ."
+if not exist %ZIG_TARBALL% (
+  echo Failed to extract zip file.
+  exit 1
+)
+
+echo Installing %ZIG_DIRECTORY% to 'zig' in current working directory...
+ren %ZIG_DIRECTORY% zig
+if exist %ZIG_DIRECTORY% (
+  echo Failed to rename %ZIG_DIRECTORY% to zig.
+  exit 1
+)
+
+:: Removes the zip file
+del /q %ZIG_TARBALL%
+if exist %ZIG_TARBALL% (
+  echo Failed to delete %ZIG_TARBALL% file.
+  exit 1
+)
+
+echo "Congratulations, you have successfully installed Zig version %ZIG_RELEASE%. Enjoy!"

package/src/tigerbeetle/scripts/install_zig.sh

@@ -1,12 +1,23 @@
 #!/bin/bash
 set -e
 
-if [ "$1" == "0.8.0" ]; then
-    ZIG_RELEASE="0.8.0"
-    echo "Installing Zig $ZIG_RELEASE release build..."
-else
+# Default to the 0.8.1 build, or allow the latest dev build, or an explicit release version:
+if [ -z "$1" ]; then
+    ZIG_RELEASE="0.8.1"
+elif [ "$1" == "latest" ]; then
     ZIG_RELEASE="builds"
+else
+    ZIG_RELEASE=$1
+fi
+
+# Validate the release version explicitly:
+if [[ $ZIG_RELEASE =~ ^builds$ ]]; then
     echo "Installing Zig latest build..."
+elif [[ $ZIG_RELEASE =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+    echo "Installing Zig $ZIG_RELEASE release build..."
+else
+    echo "Release version invalid"
+    exit 1
 fi
 
 # Determine the architecture:
@@ -32,6 +43,12 @@ else
     ZIG_URL=`curl --silent https://ziglang.org/download/index.json | grep "$ZIG_TARGET" | grep "$ZIG_RELEASE" | awk '{print $2}' | sed 's/[",]//g'`
 fi
 
+# Ensure that the release is actually hosted on the ziglang.org website:
+if [ -z "$ZIG_URL" ]; then
+    echo "Release not found on ziglang.org"
+    exit 1
+fi
+
 # Work out the filename from the URL, as well as the directory without the ".tar.xz" file extension:
 ZIG_TARBALL=`basename "$ZIG_URL"`
 ZIG_DIRECTORY=`basename "$ZIG_TARBALL" .tar.xz`

package/src/tigerbeetle/scripts/vopr.bat

@@ -0,0 +1,48 @@
+:: Installs Zig if needed and runs the VOPR
+@echo off
+
+:: Install Zig if a zig folder does not already exist:
+if not exist zig\ (
+    :: Installs the latest version of Zig
+    call scripts\install_zig.bat
+    :: Checks that the Zig folder now exists
+    if not exist zig\ (
+        echo The Zig installation failed.
+        exit 1
+    )
+    echo Running the TigerBeetle VOPR for the first time...
+    echo Visit https://www.tigerbeetle.com
+)
+
+:: If a seed is provided as an argument then replay the seed, otherwise test 1,000 seeds:
+if not "%~1"=="" (
+    :: Build in fast ReleaseSafe mode if required, useful where you don't need debug logging:
+    if "%~2"=="-OReleaseSafe" (
+        echo Replaying seed %~1 in ReleaseSafe mode...
+        call zig\zig run src\simulator.zig -OReleaseSafe -- %~1
+        if not %ERRORLEVEL%==0 (
+            echo Cannot replay the %~1 seed using the VOPR.
+            exit 1
+        )
+    ) else (
+        echo Replaying seed %~1 in Debug mode with full debug logging enabled...
+        call zig\zig run src\simulator.zig -ODebug -- %~1
+        if not %ERRORLEVEL%==0 (
+            echo Cannot run the VOPR.
+            exit 1
+        )
+    )
+) else (
+    call zig\zig build-exe src\simulator.zig -OReleaseSafe
+        if not %ERRORLEVEL%==0 (
+            echo Cannot run the VOPR.
+            exit 1
+        )
+    for %%i in (1,1,1000) do (
+        call simulator
+        if not %ERRORLEVEL%==0 (
+            echo Cannot run a seed using the VOPR.
+            exit 1
+        )
+    )
+)

package/src/tigerbeetle/scripts/vopr.sh

@@ -0,0 +1,33 @@
+#!/usr/bin/env bash
+set -e
+
+# Install Zig 0.8.0 if it does not already exist:
+if [ ! -d "zig" ]; then
+    scripts/install_zig.sh 0.8.0
+    echo ""
+    echo "Running the TigerBeetle VOPR for the first time..."
+    echo "Visit https://www.tigerbeetle.com"
+    sleep 2
+fi
+
+# If a seed is provided as an argument then replay the seed, otherwise test a 1,000 seeds:
+if [ "$1" ]; then
+
+    # Build in fast ReleaseSafe mode if required, useful where you don't need debug logging:
+    if [ "$2" == "-OReleaseSafe" ]; then
+        echo "Replaying seed $1 in ReleaseSafe mode..."
+        BUILD_MODE="-OReleaseSafe"
+    else
+        echo "Replaying seed $1 in Debug mode with full debug logging enabled..."
+        BUILD_MODE="-ODebug"
+    fi
+    echo ""
+
+    zig/zig run src/simulator.zig $BUILD_MODE -- $1
+else
+    zig/zig build-exe src/simulator.zig -OReleaseSafe
+    for I in {1..1000}
+    do
+        ./simulator
+    done
+fi

package/src/tigerbeetle/src/benchmark.zig

@@ -4,20 +4,25 @@ const config = @import("config.zig");
 
 const cli = @import("cli.zig");
 const IO = @import("io.zig").IO;
-const Client = @import("client.zig").Client;
+
 const MessageBus = @import("message_bus.zig").MessageBusClient;
-const TigerBeetle = @import("tigerbeetle.zig");
-const Transfer = TigerBeetle.Transfer;
-const Commit = TigerBeetle.Commit;
-const Account = TigerBeetle.Account;
-const CreateAccountsResult = TigerBeetle.CreateAccountsResult;
-const CreateTransfersResult = TigerBeetle.CreateTransfersResult;
-const Operation = @import("state_machine.zig").Operation;
-const Header = @import("vr.zig").Header;
+const StateMachine = @import("state_machine.zig").StateMachine;
+const Operation = StateMachine.Operation;
 const RingBuffer = @import("ring_buffer.zig").RingBuffer;
 
+const vsr = @import("vsr.zig");
+const Header = vsr.Header;
+const Client = vsr.Client(StateMachine, MessageBus);
+
+const tb = @import("tigerbeetle.zig");
+const Transfer = tb.Transfer;
+const Commit = tb.Commit;
+const Account = tb.Account;
+const CreateAccountsResult = tb.CreateAccountsResult;
+const CreateTransfersResult = tb.CreateTransfersResult;
+
 const MAX_TRANSFERS: u32 = 1_000_000;
-const BATCH_SIZE: u32 = 10_000;
+const BATCH_SIZE: u32 = 5_000;
 const IS_TWO_PHASE_COMMIT = false;
 const BENCHMARK = if (IS_TWO_PHASE_COMMIT) 500_000 else 1_000_000;
 const RESULT_TOLERANCE = 10; // percent
@@ -25,7 +30,7 @@ const BATCHES: f32 = MAX_TRANSFERS / BATCH_SIZE;
 const TOTAL_BATCHES = @ceil(BATCHES);
 
 const log = std.log;
-pub const log_level: std.log.Level = .info;
+pub const log_level: std.log.Level = .notice;
 
 var accounts = [_]Account{
     Account{
@@ -57,28 +62,32 @@ var max_create_transfers_latency: i64 = 0;
 var max_commit_transfers_latency: i64 = 0;
 
 pub fn main() !void {
-    std.debug.print("builtin {o}\n", .{std.builtin.mode});
+    const stdout = std.io.getStdOut().writer();
+    const stderr = std.io.getStdErr().writer();
+
     if (std.builtin.mode != .ReleaseSafe and std.builtin.mode != .ReleaseFast) {
-        log.warn("The client has not been built in ReleaseSafe or ReleaseFast mode.\n", .{});
+        try stderr.print("Benchmark must be built as ReleaseSafe for minimum performance.\n", .{});
     }
+
     var arena = std.heap.ArenaAllocator.init(std.heap.page_allocator);
     defer arena.deinit();
     const allocator = &arena.allocator;
 
-    const client_id: u128 = 123;
-    const cluster_id: u128 = 746649394563965214; // a5ca1ab1ebee11e
+    const client_id = std.crypto.random.int(u128);
+    const cluster_id: u32 = 0;
     var address = [_]std.net.Address{try std.net.Address.parseIp4("127.0.0.1", config.port)};
     var io = try IO.init(32, 0);
     var message_bus = try MessageBus.init(allocator, cluster_id, address[0..], client_id, &io);
     defer message_bus.deinit();
     var client = try Client.init(
         allocator,
+        client_id,
         cluster_id,
-        @intCast(u16, address.len),
+        @intCast(u8, address.len),
         &message_bus,
     );
     defer client.deinit();
-    message_bus.process = .{ .client = &client };
+    message_bus.set_on_message(*Client, &client, Client.on_message);
 
     // Pre-allocate a million transfers:
     var transfers = try arena.allocator.alloc(Transfer, MAX_TRANSFERS);
@@ -111,7 +120,7 @@ pub fn main() !void {
 
     try wait_for_connect(&client, &io);
 
-    std.debug.print("creating accounts...\n", .{});
+    try stdout.print("creating accounts...\n", .{});
     var queue = TimedQueue.init(&client, &io);
     try queue.push(.{
         .operation = Operation.create_accounts,
@@ -121,7 +130,7 @@ pub fn main() !void {
     assert(queue.end != null);
     assert(queue.batches.empty());
 
-    log.info("batching transfers...", .{});
+    try stdout.print("batching transfers...\n", .{});
     var count: u64 = 0;
     queue.reset();
     while (count < transfers.len) {
@@ -141,29 +150,27 @@ pub fn main() !void {
     }
     assert(count == MAX_TRANSFERS);
 
-    log.info("starting benchmark...", .{});
+    try stdout.print("starting benchmark...\n", .{});
     try queue.execute();
     assert(queue.end != null);
     assert(queue.batches.empty());
 
     var ms = queue.end.? - queue.start.?;
-    const transfer_type = if (IS_TWO_PHASE_COMMIT) "two-phase commit" else "";
+    const transfer_type = if (IS_TWO_PHASE_COMMIT) "two-phase commit " else "";
     const result: i64 = @divFloor(@intCast(i64, transfers.len * 1000), ms);
-    log.info("============================================", .{});
-    log.info("{} {s} transfers per second\n", .{
+    try stdout.print("============================================\n", .{});
+    try stdout.print("{} {s}transfers per second\n\n", .{
         result,
         transfer_type,
     });
-    log.info("create_transfers max p100 latency per 10,000 transfers = {}ms\n", .{
+    try stdout.print("create_transfers max p100 latency per {} transfers = {}ms\n", .{
+        BATCH_SIZE,
         queue.max_transfers_latency,
     });
-    log.info("commit_transfers max p100 latency per 10,000 transfers = {}ms\n", .{
+    try stdout.print("commit_transfers max p100 latency per {} transfers = {}ms\n", .{
+        BATCH_SIZE,
         queue.max_commits_latency,
     });
-
-    if (result < @divFloor(@intCast(i64, BENCHMARK * (100 - RESULT_TOLERANCE)), 100)) {
-        log.warn("There has been a performance regression. previous benchmark={}\n", .{BENCHMARK});
-    }
 }
 
 const Batch = struct {
@@ -214,17 +221,27 @@ const TimedQueue = struct {
         self.reset();
         log.debug("executing batches...", .{});
 
-        var batch: ?Batch = self.batches.peek();
         const now = std.time.milliTimestamp();
         self.start = now;
-        if (batch) |*starting_batch| {
+        if (self.batches.head_ptr()) |starting_batch| {
             log.debug("sending first batch...", .{});
             self.batch_start = now;
+            var message = self.client.get_message() orelse {
+                @panic("Client message pool has been exhausted. Cannot execute batch.");
+            };
+            defer self.client.unref(message);
+
+            std.mem.copy(
+                u8,
+                message.buffer[@sizeOf(Header)..],
+                std.mem.sliceAsBytes(starting_batch.data),
+            );
             self.client.request(
                 @intCast(u128, @ptrToInt(self)),
                 TimedQueue.lap,
                 starting_batch.operation,
-                starting_batch.data,
+                message,
+                starting_batch.data.len,
             );
         }
 
@@ -234,20 +251,24 @@ const TimedQueue = struct {
         }
     }
 
-    pub fn lap(user_data: u128, operation: Operation, results: []const u8) void {
+    pub fn lap(user_data: u128, operation: Operation, results: Client.Error![]const u8) void {
         const now = std.time.milliTimestamp();
-        assert(results.len == 0);
-        if (log_level == .debug) {
-            const response = std.mem.bytesAsSlice(CreateAccountsResult, results);
-            log.debug("{o}", .{response});
-        }
+        const value = results catch |err| {
+            log.emerg("Client returned error={o}", .{@errorName(err)});
+            @panic("Client returned error during benchmarking.");
+        };
+
+        log.debug("response={s}", .{std.mem.bytesAsSlice(CreateAccountsResult, value)});
 
         const self: *TimedQueue = @intToPtr(*TimedQueue, @intCast(usize, user_data));
         const completed_batch: ?Batch = self.batches.pop();
         assert(completed_batch != null);
         assert(completed_batch.?.operation == operation);
 
-        log.debug("completed batch operation={} start={}", .{ completed_batch.?.operation, self.batch_start });
+        log.debug("completed batch operation={} start={}", .{
+            completed_batch.?.operation,
+            self.batch_start,
+        });
         const latency = now - self.batch_start.?;
         switch (operation) {
             .create_accounts => {},
@@ -264,14 +285,25 @@ const TimedQueue = struct {
             else => unreachable,
         }
 
-        var batch: ?Batch = self.batches.peek();
-        if (batch) |*next_batch| {
+        if (self.batches.head_ptr()) |next_batch| {
+            var message = self.client.get_message() orelse {
+                @panic("Client message pool has been exhausted.");
+            };
+            defer self.client.unref(message);
+
+            std.mem.copy(
+                u8,
+                message.buffer[@sizeOf(Header)..],
+                std.mem.sliceAsBytes(next_batch.data),
+            );
+
             self.batch_start = std.time.milliTimestamp();
             self.client.request(
                 @intCast(u128, @ptrToInt(self)),
                 TimedQueue.lap,
                 next_batch.operation,
-                next_batch.data,
+                message,
+                next_batch.data.len,
             );
         } else {
             log.debug("stopping timer...", .{});