tigerbeetle-node 0.8.1 → 0.9.143

package/src/tigerbeetle/src/test/time.zig

@@ -1,84 +0,0 @@
-const std = @import("std");
-const assert = std.debug.assert;
-
-pub const OffsetType = enum {
-    linear,
-    periodic,
-    step,
-    non_ideal,
-};
-
-pub const Time = struct {
-    const Self = @This();
-
-    /// The duration of a single tick in nanoseconds.
-    resolution: u64,
-
-    offset_type: OffsetType,
-
-    /// Co-efficients to scale the offset according to the `offset_type`.
-    /// Linear offset is described as A * x + B: A is the drift per tick and B the initial offset.
-    /// Periodic is described as A * sin(x * pi / B): A controls the amplitude and B the period in
-    /// terms of ticks.
-    /// Step function represents a discontinuous jump in the wall-clock time. B is the period in
-    /// which the jumps occur. A is the amplitude of the step.
-    /// Non-ideal is similar to periodic except the phase is adjusted using a random number taken
-    /// from a normal distribution with mean=0, stddev=10. Finally, a random offset (up to
-    /// offset_coefficientC) is added to the result.
-    offset_coefficient_A: i64,
-    offset_coefficient_B: i64,
-    offset_coefficient_C: u32 = 0,
-
-    prng: std.rand.DefaultPrng = std.rand.DefaultPrng.init(0),
-
-    /// The number of ticks elapsed since initialization.
-    ticks: u64 = 0,
-
-    /// The instant in time chosen as the origin of this time source.
-    epoch: i64 = 0,
-
-    pub fn monotonic(self: *Self) u64 {
-        return self.ticks * self.resolution;
-    }
-
-    pub fn realtime(self: *Self) i64 {
-        return self.epoch + @intCast(i64, self.monotonic()) - self.offset(self.ticks);
-    }
-
-    pub fn offset(self: *Self, ticks: u64) i64 {
-        switch (self.offset_type) {
-            .linear => {
-                const drift_per_tick = self.offset_coefficient_A;
-                return @intCast(i64, ticks) * drift_per_tick + @intCast(
-                    i64,
-                    self.offset_coefficient_B,
-                );
-            },
-            .periodic => {
-                const unscaled = std.math.sin(@intToFloat(f64, ticks) * 2 * std.math.pi /
-                    @intToFloat(f64, self.offset_coefficient_B));
-                const scaled = @intToFloat(f64, self.offset_coefficient_A) * unscaled;
-                return @floatToInt(i64, std.math.floor(scaled));
-            },
-            .step => {
-                return if (ticks > self.offset_coefficient_B) self.offset_coefficient_A else 0;
-            },
-            .non_ideal => {
-                const phase: f64 = @intToFloat(f64, ticks) * 2 * std.math.pi /
-                    (@intToFloat(f64, self.offset_coefficient_B) + self.prng.random().floatNorm(f64) * 10);
-                const unscaled = std.math.sin(phase);
-                const scaled = @intToFloat(f64, self.offset_coefficient_A) * unscaled;
-                return @floatToInt(i64, std.math.floor(scaled)) +
-                    self.prng.random().intRangeAtMost(
-                    i64,
-                    -@intCast(i64, self.offset_coefficient_C),
-                    self.offset_coefficient_C,
-                );
-            },
-        }
-    }
-
-    pub fn tick(self: *Self) void {
-        self.ticks += 1;
-    }
-};

package/src/tigerbeetle/src/tigerbeetle.zig

@@ -1,222 +0,0 @@
-const std = @import("std");
-const builtin = @import("builtin");
-const assert = std.debug.assert;
-
-pub const config = @import("config.zig");
-
-pub const Account = packed struct {
-    id: u128,
-    /// Opaque third-party identifier to link this account (many-to-one) to an external entity.
-    user_data: u128,
-    /// Reserved for accounting policy primitives.
-    reserved: [48]u8,
-    ledger: u32,
-    /// A chart of accounts code describing the type of account (e.g. clearing, settlement).
-    code: u16,
-    flags: AccountFlags,
-    debits_pending: u64,
-    debits_posted: u64,
-    credits_pending: u64,
-    credits_posted: u64,
-    timestamp: u64 = 0,
-
-    comptime {
-        assert(@sizeOf(Account) == 128);
-    }
-
-    pub fn debits_exceed_credits(self: *const Account, amount: u64) bool {
-        return (self.flags.debits_must_not_exceed_credits and
-            self.debits_pending + self.debits_posted + amount > self.credits_posted);
-    }
-
-    pub fn credits_exceed_debits(self: *const Account, amount: u64) bool {
-        return (self.flags.credits_must_not_exceed_debits and
-            self.credits_pending + self.credits_posted + amount > self.debits_posted);
-    }
-};
-
-pub const AccountFlags = packed struct {
-    /// When the .linked flag is specified, it links an event with the next event in the batch, to
-    /// create a chain of events, of arbitrary length, which all succeed or fail together. The tail
-    /// of a chain is denoted by the first event without this flag. The last event in a batch may
-    /// therefore never have the .linked flag set as this would leave a chain open-ended. Multiple
-    /// chains or individual events may coexist within a batch to succeed or fail independently.
-    /// Events within a chain are executed within order, or are rolled back on error, so that the
-    /// effect of each event in the chain is visible to the next, and so that the chain is either
-    /// visible or invisible as a unit to subsequent events after the chain. The event that was the
-    /// first to break the chain will have a unique error result. Other events in the chain will
-    /// have their error result set to .linked_event_failed.
-    linked: bool = false,
-    debits_must_not_exceed_credits: bool = false,
-    credits_must_not_exceed_debits: bool = false,
-    padding: u13 = 0,
-
-    comptime {
-        assert(@sizeOf(AccountFlags) == @sizeOf(u16));
-    }
-};
-
-pub const Transfer = packed struct {
-    id: u128,
-    debit_account_id: u128,
-    credit_account_id: u128,
-    /// Opaque third-party identifier to link this transfer (many-to-one) to an external entity.
-    user_data: u128,
-    /// Reserved for accounting policy primitives.
-    reserved: u128,
-    /// If this transfer will post or void a pending transfer, the id of that pending transfer.
-    pending_id: u128,
-    timeout: u64,
-    ledger: u32,
-    /// A chart of accounts code describing the reason for the transfer (e.g. deposit, settlement).
-    code: u16,
-    flags: TransferFlags,
-    amount: u64,
-    timestamp: u64 = 0,
-
-    comptime {
-        assert(@sizeOf(Transfer) == 128);
-    }
-};
-
-pub const TransferFlags = packed struct {
-    linked: bool = false,
-    pending: bool = false,
-    post_pending_transfer: bool = false,
-    void_pending_transfer: bool = false,
-    padding: u12 = 0,
-
-    comptime {
-        assert(@sizeOf(TransferFlags) == @sizeOf(u16));
-    }
-};
-
-pub const CreateAccountResult = enum(u32) {
-    ok,
-    linked_event_failed,
-
-    reserved_flag,
-    reserved_field,
-
-    id_must_not_be_zero,
-    ledger_must_not_be_zero,
-    code_must_not_be_zero,
-
-    mutually_exclusive_flags,
-
-    overflows_debits,
-    overflows_credits,
-
-    exceeds_credits,
-    exceeds_debits,
-
-    exists_with_different_flags,
-    exists_with_different_user_data,
-    exists_with_different_ledger,
-    exists_with_different_code,
-    exists_with_different_debits_pending,
-    exists_with_different_debits_posted,
-    exists_with_different_credits_pending,
-    exists_with_different_credits_posted,
-    exists,
-};
-
-pub const CreateTransferResult = enum(u32) {
-    ok,
-    linked_event_failed,
-
-    reserved_flag,
-    reserved_field,
-
-    id_must_not_be_zero,
-    debit_account_id_must_not_be_zero,
-    credit_account_id_must_not_be_zero,
-    accounts_must_be_different,
-
-    pending_id_must_be_zero,
-    pending_transfer_must_timeout,
-
-    ledger_must_not_be_zero,
-    code_must_not_be_zero,
-    amount_must_not_be_zero,
-
-    debit_account_not_found,
-    credit_account_not_found,
-
-    accounts_must_have_the_same_ledger,
-    transfer_must_have_the_same_ledger_as_accounts,
-
-    exists_with_different_flags,
-    exists_with_different_debit_account_id,
-    exists_with_different_credit_account_id,
-    exists_with_different_user_data,
-    exists_with_different_pending_id,
-    exists_with_different_timeout,
-    exists_with_different_code,
-    exists_with_different_amount,
-    exists,
-
-    overflows_debits_pending,
-    overflows_credits_pending,
-    overflows_debits_posted,
-    overflows_credits_posted,
-    overflows_debits,
-    overflows_credits,
-
-    exceeds_credits,
-    exceeds_debits,
-
-    cannot_post_and_void_pending_transfer,
-    pending_transfer_cannot_post_or_void_another,
-    timeout_reserved_for_pending_transfer,
-
-    pending_id_must_not_be_zero,
-    pending_id_must_be_different,
-
-    pending_transfer_not_found,
-    pending_transfer_not_pending,
-
-    pending_transfer_has_different_debit_account_id,
-    pending_transfer_has_different_credit_account_id,
-    pending_transfer_has_different_ledger,
-    pending_transfer_has_different_code,
-
-    exceeds_pending_transfer_amount,
-    pending_transfer_has_different_amount,
-
-    pending_transfer_already_posted,
-    pending_transfer_already_voided,
-
-    pending_transfer_expired,
-};
-
-pub const CreateAccountsResult = packed struct {
-    index: u32,
-    result: CreateAccountResult,
-
-    comptime {
-        assert(@sizeOf(CreateAccountsResult) == 8);
-    }
-};
-
-pub const CreateTransfersResult = packed struct {
-    index: u32,
-    result: CreateTransferResult,
-
-    comptime {
-        assert(@sizeOf(CreateTransfersResult) == 8);
-    }
-};
-
-comptime {
-    const target = builtin.target;
-
-    if (target.os.tag != .linux and !target.isDarwin() and target.os.tag != .windows) {
-        @compileError("linux, windows or macos is required for io");
-    }
-
-    // We require little-endian architectures everywhere for efficient network deserialization:
-    if (target.cpu.arch.endian() != .Little) {
-        @compileError("big-endian systems not supported");
-    }
-}

package/src/tigerbeetle/src/time.zig

@@ -1,113 +0,0 @@
-const std = @import("std");
-const builtin = @import("builtin");
-const config = @import("./config.zig");
-
-const os = std.os;
-const assert = std.debug.assert;
-const is_darwin = builtin.target.os.tag.isDarwin();
-const is_windows = builtin.target.os.tag == .windows;
-
-pub const Time = struct {
-    const Self = @This();
-
-    /// Hardware and/or software bugs can mean that the monotonic clock may regress.
-    /// One example (of many): https://bugzilla.redhat.com/show_bug.cgi?id=448449
-    /// We crash the process for safety if this ever happens, to protect against infinite loops.
-    /// It's better to crash and come back with a valid monotonic clock than get stuck forever.
-    monotonic_guard: u64 = 0,
-
-    /// A timestamp to measure elapsed time, meaningful only on the same system, not across reboots.
-    /// Always use a monotonic timestamp if the goal is to measure elapsed time.
-    /// This clock is not affected by discontinuous jumps in the system time, for example if the
-    /// system administrator manually changes the clock.
-    pub fn monotonic(self: *Self) u64 {
-        const m = blk: {
-            // Uses QueryPerformanceCounter() on windows due to it being the highest precision timer
-            // available while also accounting for time spent suspended by default:
-            // https://docs.microsoft.com/en-us/windows/win32/api/realtimeapiset/nf-realtimeapiset-queryunbiasedinterrupttime#remarks
-            if (is_windows) {
-                // QPF need not be globally cached either as it ends up being a load from read-only
-                // memory mapped to all processed by the kernel called KUSER_SHARED_DATA (See "QpcFrequency")
-                // https://docs.microsoft.com/en-us/windows-hardware/drivers/ddi/ntddk/ns-ntddk-kuser_shared_data
-                // https://www.geoffchappell.com/studies/windows/km/ntoskrnl/inc/api/ntexapi_x/kuser_shared_data/index.htm
-                const qpc = os.windows.QueryPerformanceCounter();
-                const qpf = os.windows.QueryPerformanceFrequency();
-
-                // 10Mhz (1 qpc tick every 100ns) is a common QPF on modern systems.
-                // We can optimize towards this by converting to ns via a single multiply.
-                // https://github.com/microsoft/STL/blob/785143a0c73f030238ef618890fd4d6ae2b3a3a0/stl/inc/chrono#L694-L701
-                const common_qpf = 10_000_000;
-                if (qpf == common_qpf) break :blk qpc * (std.time.ns_per_s / common_qpf);
-
-                // Convert qpc to nanos using fixed point to avoid expensive extra divs and overflow.
-                const scale = (std.time.ns_per_s << 32) / qpf;
-                break :blk @truncate(u64, (@as(u96, qpc) * scale) >> 32);
-            }
-
-            // Uses mach_continuous_time() instead of mach_absolute_time() as it counts while suspended.
-            // https://developer.apple.com/documentation/kernel/1646199-mach_continuous_time
-            // https://opensource.apple.com/source/Libc/Libc-1158.1.2/gen/clock_gettime.c.auto.html
-            if (is_darwin) {
-                const darwin = struct {
-                    const mach_timebase_info_t = os.darwin.mach_timebase_info_data;
-                    extern "c" fn mach_timebase_info(info: *mach_timebase_info_t) os.darwin.kern_return_t;
-                    extern "c" fn mach_continuous_time() u64;
-                };
-
-                // mach_timebase_info() called through libc already does global caching for us
-                // https://opensource.apple.com/source/xnu/xnu-7195.81.3/libsyscall/wrappers/mach_timebase_info.c.auto.html
-                var info: darwin.mach_timebase_info_t = undefined;
-                if (darwin.mach_timebase_info(&info) != 0) @panic("mach_timebase_info() failed");
-
-                const now = darwin.mach_continuous_time();
-                return (now * info.numer) / info.denom;
-            }
-
-            // The true monotonic clock on Linux is not in fact CLOCK_MONOTONIC:
-            // CLOCK_MONOTONIC excludes elapsed time while the system is suspended (e.g. VM migration).
-            // CLOCK_BOOTTIME is the same as CLOCK_MONOTONIC but includes elapsed time during a suspend.
-            // For more detail and why CLOCK_MONOTONIC_RAW is even worse than CLOCK_MONOTONIC,
-            // see https://github.com/ziglang/zig/pull/933#discussion_r656021295.
-            var ts: os.timespec = undefined;
-            os.clock_gettime(os.CLOCK.BOOTTIME, &ts) catch @panic("CLOCK_BOOTTIME required");
-            break :blk @intCast(u64, ts.tv_sec) * std.time.ns_per_s + @intCast(u64, ts.tv_nsec);
-        };
-
-        // "Oops!...I Did It Again"
-        if (m < self.monotonic_guard) @panic("a hardware/kernel bug regressed the monotonic clock");
-        self.monotonic_guard = m;
-        return m;
-    }
-
-    /// A timestamp to measure real (i.e. wall clock) time, meaningful across systems, and reboots.
-    /// This clock is affected by discontinuous jumps in the system time.
-    pub fn realtime(_: *Self) i64 {
-        if (is_windows) {
-            const kernel32 = struct {
-                extern "kernel32" fn GetSystemTimePreciseAsFileTime(
-                    lpFileTime: *os.windows.FILETIME,
-                ) callconv(os.windows.WINAPI) void;
-            };
-
-            var ft: os.windows.FILETIME = undefined;
-            kernel32.GetSystemTimePreciseAsFileTime(&ft);
-            const ft64 = (@as(u64, ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
-
-            // FileTime is in units of 100 nanoseconds
-            // and uses the NTFS/Windows epoch of 1601-01-01 instead of Unix Epoch 1970-01-01.
-            const epoch_adjust = std.time.epoch.windows * (std.time.ns_per_s / 100);
-            return (@bitCast(i64, ft64) + epoch_adjust) * 100;
-        }
-
-        if (is_darwin) {
-            // macos has supported clock_gettime() since 10.12:
-            // https://opensource.apple.com/source/Libc/Libc-1158.1.2/gen/clock_gettime.3.auto.html
-        }
-
-        var ts: os.timespec = undefined;
-        os.clock_gettime(os.CLOCK.REALTIME, &ts) catch unreachable;
-        return @as(i64, ts.tv_sec) * std.time.ns_per_s + ts.tv_nsec;
-    }
-
-    pub fn tick(_: *Self) void {}
-};

package/src/tigerbeetle/src/unit_tests.zig

@@ -1,14 +0,0 @@
-test {
-    _ = @import("vsr.zig");
-    _ = @import("vsr/journal.zig");
-    _ = @import("vsr/marzullo.zig");
-    // TODO: clean up logging of clock test and enable it here.
-    //_ = @import("vsr/clock.zig");
-
-    _ = @import("state_machine.zig");
-
-    _ = @import("fifo.zig");
-    _ = @import("ring_buffer.zig");
-
-    _ = @import("io.zig");
-}