Skip to content

fix: add compatibility for Zig 0.16 ArrayList and timer changes #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jinzhongjia wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix: add compatibility for Zig 0.16 ArrayList and timer changes #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
05bcfac
fix: add compatibility for Zig 0.16 ArrayList and timer changes
jinzhongjia May 3, 2026
b1ba240
chore(ci): 统一使用 mlugg/setup-zig@v2 替代已废弃 action
jinzhongjia May 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/benchmark.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ jobs:
uses: actions/checkout@v4

- name: Setup Zig
uses: goto-bus-stop/setup-zig@v2
uses: mlugg/setup-zig@v2
with:
version: 0.15.1
version: 0.16.0

- name: Display platform information
shell: bash
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy_docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ jobs:
uses: actions/checkout@v3
with:
fetch-depth: 0 # Not needed if lastUpdated is not enabled
- uses: goto-bus-stop/setup-zig@v2
- uses: mlugg/setup-zig@v2
with:
cache: false
- name: Generate Docs
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/format-check.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ jobs:
uses: actions/checkout@v4

- name: Setup Zig
uses: goto-bus-stop/setup-zig@v2
uses: mlugg/setup-zig@v2
with:
version: 0.15.1
version: 0.16.0

- name: Check code formatting
run: zig fmt --check .
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
# 架构配置标识符
arch_config: [linux-x86_64, linux-aarch64, macos-arm64, windows-x86_64]
# 定时任务只测试 master 版本，其他情况测试所有版本
version: ${{ github.event_name == 'schedule' && fromJSON('["master"]') || fromJSON('["0.14.1", "0.15.1", "master"]') }}
version: ${{ github.event_name == 'schedule' && fromJSON('["master"]') || fromJSON('["0.14.1", "0.15.1", "0.16.0", "master"]') }}
include:
# Linux x86_64
- arch_config: linux-x86_64
Expand Down Expand Up @@ -56,7 +56,7 @@ jobs:
fetch-depth: 0

- name: Setup Zig
uses: goto-bus-stop/setup-zig@v2
uses: mlugg/setup-zig@v2
with:
version: ${{ matrix.version }}

Expand Down
7 changes: 5 additions & 2 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,16 @@ zig build docs
```

### Zig Version Compatibility
- **Currently supports**: Zig 0.14.0 and 0.15.x
- **Partial support**: Zig 0.16 (nightly) - may have compatibility issues
- **Currently supports**: Zig 0.14.0, 0.15.x, and 0.16.0
- **Legacy support**: Zig 0.11-0.13 (use library version 0.0.6 for Zig 0.13 and older)
- Code uses version detection (`builtin.zig_version.minor`) to handle API differences:
- Endianness enum changes (`.Big`/`.Little` vs `.big`/`.little`)
- ArrayList API changes in Zig 0.15+ (allocator parameter required for methods)
- ArrayList initialization changes in Zig 0.16 (`std.ArrayList(T){}` removed, use `initCapacity`)
- Build system API differences between versions
- `std.time.Timer` removed in 0.16 (replaced with platform-specific timing in benchmarks)
- `std.heap.GeneralPurposeAllocator` removed in 0.16 (replaced with `page_allocator`)
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot May 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The claim that std.heap.GeneralPurposeAllocator is removed in Zig 0.16 is incorrect. It remains a core part of the standard library, although its internal implementation details or its location within std.heap may have evolved. Switching to page_allocator in benchmarks is a regression in measurement quality as it is significantly slower due to per-allocation system calls.

- `std.io.fixedBufferStream` removed in 0.16 (compat layer provides `BufferStream`)

## Architecture

Expand Down
48 changes: 42 additions & 6 deletions src/bench.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,28 +16,51 @@ const pack = msgpack.Pack(
bufferType.read,
);

const is_zig_16 = builtin.zig_version.minor >= 16;

/// Get monotonic time in nanoseconds (cross-platform)
fn getTimeNs() u64 {
if (builtin.os.tag == .windows) {
const w = std.os.windows;
var counter: w.LARGE_INTEGER = undefined;
_ = w.ntdll.RtlQueryPerformanceCounter(&counter);
var freq: w.LARGE_INTEGER = undefined;
_ = w.ntdll.RtlQueryPerformanceFrequency(&freq);
const ns = std.time.ns_per_s;
const c: u64 = @bitCast(counter);
const f: u64 = @bitCast(freq);
return @intCast(@divTrunc(@as(u128, c) * ns, @as(u128, f)));
} else if (builtin.os.tag != .windows) {
var ts: std.c.timespec = undefined;
_ = std.c.clock_gettime(std.c.CLOCK.MONOTONIC, &ts);
return @as(u64, @intCast(ts.tv_sec)) * std.time.ns_per_s + @as(u64, @intCast(ts.tv_nsec));
} else @compileError("unsupported OS for benchmark");
Comment on lines +33 to +37
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot May 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The else if (builtin.os.tag != .windows) condition is redundant following the initial if (builtin.os.tag == .windows). This makes the final else block containing the @compileError unreachable. It should be simplified to a standard else block.

    } else {
        var ts: std.c.timespec = undefined;
        _ = std.c.clock_gettime(std.c.CLOCK.MONOTONIC, &ts);
        return @as(u64, @intCast(ts.tv_sec)) * std.time.ns_per_s + @as(u64, @intCast(ts.tv_nsec));
    }

}
Comment on lines +22 to +38
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot May 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The manual implementation of getTimeNs introduces significant boilerplate and potential portability issues (e.g., dependency on libc for clock_gettime on non-Windows platforms). For Zig 0.16, the recommended replacement for std.time.Timer is std.time.Instant, which provides a cross-platform monotonic clock API. Additionally, the Windows implementation lacks a check for a zero frequency from RtlQueryPerformanceFrequency, which would cause a division by zero.


/// Benchmark timer helper
/// Run a benchmark and print results
fn benchmark(
comptime name: []const u8,
comptime iterations: usize,
comptime func: fn (allocator: std.mem.Allocator) anyerror!void,
) !void {
var gpa = std.heap.GeneralPurposeAllocator(.{}){};
defer _ = gpa.deinit();
const allocator = gpa.allocator();
const allocator = std.heap.page_allocator;
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot May 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Using std.heap.page_allocator for benchmarks is generally discouraged because it performs a system call for every allocation and deallocation, which can dominate the benchmark results and hide the actual performance characteristics of the code being tested. Since GeneralPurposeAllocator is still available in Zig 0.16, it should be used instead.


// Warmup
for (0..10) |_| {
try func(allocator);
}

// Actual benchmark
var timer = try std.time.Timer.start();
var legacy_timer: if (is_zig_16) void else std.time.Timer = if (is_zig_16) {} else undefined;
if (!is_zig_16) legacy_timer = try std.time.Timer.start();
const start_ns = if (is_zig_16) getTimeNs() else 0;
Comment on lines +55 to +57
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot May 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The conditional logic for handling the timer across Zig versions is quite clunky. Instead of manually implementing getTimeNs and using a void type for legacy_timer, it is recommended to use std.time.Instant for Zig 0.16. This would allow for a cleaner abstraction or a simple wrapper that works across all supported versions.


for (0..iterations) |_| {
try func(allocator);
}
const elapsed_ns = timer.read();

const elapsed_ns = if (is_zig_16) getTimeNs() - start_ns else legacy_timer.read();

const avg_ns = elapsed_ns / iterations;
const ops_per_sec = if (avg_ns > 0) (1_000_000_000 / avg_ns) else 0;
Expand Down Expand Up @@ -850,7 +873,7 @@ fn benchMixedTypesRead(allocator: std.mem.Allocator) !void {
// Main Benchmark Runner
// ============================================================================

pub fn main() !void {
fn runBenchmarks() !void {
std.debug.print("\n", .{});
std.debug.print("=" ** 80 ++ "\n", .{});
std.debug.print("MessagePack Benchmark Suite\n", .{});
Expand Down Expand Up @@ -936,3 +959,16 @@ pub fn main() !void {
std.debug.print("Benchmark Complete\n", .{});
std.debug.print("=" ** 80 ++ "\n", .{});
}

const BenchEntry = if (is_zig_16) struct {
pub fn main(init: std.process.Init) !void {
_ = &init;
try runBenchmarks();
}
} else struct {
pub fn main() !void {
try runBenchmarks();
}
};

pub const main = BenchEntry.main;
4 changes: 2 additions & 2 deletions src/msgpack.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1316,7 +1316,7 @@ pub const Payload = union(enum) {
var new_heap = if (current_zig.minor == 14)
std.ArrayList(Payload).init(alloc)
else
std.ArrayList(Payload){};
std.ArrayList(Payload).initCapacity(alloc, 0) catch unreachable;
Comment on lines 1316 to +1319
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot May 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Using initCapacity(alloc, 0) catch unreachable is suboptimal and introduces a potential crash point during memory cleanup. In Zig 0.16, std.ArrayList(T).init(allocator) is the preferred way to initialize a managed ArrayList as it does not perform an initial allocation and thus cannot fail. The logic can be simplified to use init for both 0.14 and 0.16, only using the struct literal for 0.15 where the ArrayList was unmanaged.

                    var new_heap = if (current_zig.minor == 15)
                        std.ArrayList(Payload){}
                    else
                        std.ArrayList(Payload).init(alloc);


// Copy existing items from stack buffer to heap
for (buffer[0..len.*]) |item| {
Expand Down Expand Up @@ -2857,7 +2857,7 @@ pub fn PackWithLimits(
var parse_stack = if (current_zig.minor == 14)
std.ArrayList(ParseState).init(allocator)
else
std.ArrayList(ParseState){};
try std.ArrayList(ParseState).initCapacity(allocator, 0);
Comment on lines 2857 to +2860
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot May 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Similar to the previous comment, std.ArrayList(T).init(allocator) should be used for Zig 0.14 and 0.16 to avoid the unnecessary try or catch unreachable on an operation that doesn't need to allocate memory initially.

            var parse_stack = if (current_zig.minor == 15)
                std.ArrayList(ParseState){}
            else
                std.ArrayList(ParseState).init(allocator);

defer if (current_zig.minor == 14) parse_stack.deinit() else parse_stack.deinit(allocator);
errdefer cleanupParseStack(&parse_stack, allocator);

Expand Down
42 changes: 21 additions & 21 deletions src/test.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ const allocator = std.testing.allocator;
const expect = std.testing.expect;
const Payload = msgpack.Payload;

const has_new_io = builtin.zig_version.minor >= 15;

fn u8eql(a: []const u8, b: []const u8) bool {
return std.mem.eql(u8, a, b);
}
Expand Down Expand Up @@ -76,7 +78,7 @@ test "PackerIO: corrupted length field" {
var input = if (builtin.zig_version.minor == 14)
std.ArrayList(u8).init(allocator)
else
std.ArrayList(u8){};
std.ArrayList(u8).initCapacity(allocator, 0) catch unreachable;
Comment on lines 78 to +81
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot May 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The use of initCapacity(allocator, 0) catch unreachable throughout the test suite is repetitive and less idiomatic than using init(allocator) for versions where the ArrayList is managed (0.14 and 0.16).

    var input = if (builtin.zig_version.minor == 15)
        std.ArrayList(u8){}
    else
        std.ArrayList(u8).init(allocator);

defer if (builtin.zig_version.minor == 14) input.deinit() else input.deinit(allocator);

// str32 claiming 1MB but only providing a few bytes
Expand Down Expand Up @@ -134,7 +136,7 @@ test "PackerIO: truncated array cleanup" {
var input = if (builtin.zig_version.minor == 14)
std.ArrayList(u8).init(allocator)
else
std.ArrayList(u8){};
std.ArrayList(u8).initCapacity(allocator, 0) catch unreachable;
defer if (builtin.zig_version.minor == 14) input.deinit() else input.deinit(allocator);

// Create array header for 3 elements (0x93)
Expand Down Expand Up @@ -1424,7 +1426,7 @@ test "large maps" {
var keys = if (builtin.zig_version.minor == 14)
std.ArrayList([]u8).init(allocator)
else
std.ArrayList([]u8){};
std.ArrayList([]u8).initCapacity(allocator, 0) catch unreachable;
defer {
for (keys.items) |key| {
allocator.free(key);
Expand Down Expand Up @@ -1852,7 +1854,7 @@ test "actual map32 format" {
var keys = if (builtin.zig_version.minor == 14)
std.ArrayList([]u8).init(allocator)
else
std.ArrayList([]u8){};
std.ArrayList([]u8).initCapacity(allocator, 0) catch unreachable;
defer {
for (keys.items) |key| {
allocator.free(key);
Expand Down Expand Up @@ -2058,7 +2060,7 @@ test "format markers verification" {
var test_keys = if (builtin.zig_version.minor == 14)
std.ArrayList([]u8).init(allocator)
else
std.ArrayList([]u8){};
std.ArrayList([]u8).initCapacity(allocator, 0) catch unreachable;
defer {
for (test_keys.items) |key| {
allocator.free(key);
Expand Down Expand Up @@ -3413,7 +3415,7 @@ test "fuzz: mixed payload sequence" {
var payloads = if (builtin.zig_version.minor == 14)
std.ArrayList(Payload).init(allocator)
else
std.ArrayList(Payload){};
std.ArrayList(Payload).initCapacity(allocator, 0) catch unreachable;
defer {
for (payloads.items) |payload| {
payload.free(allocator);
Expand Down Expand Up @@ -3453,7 +3455,7 @@ test "iterative parser: normal nested depth (100 layers)" {
var input = if (builtin.zig_version.minor == 14)
std.ArrayList(u8).init(allocator)
else
std.ArrayList(u8){};
std.ArrayList(u8).initCapacity(allocator, 0) catch unreachable;
defer if (builtin.zig_version.minor == 14) input.deinit() else input.deinit(allocator);

const depth = 100;
Expand Down Expand Up @@ -3502,7 +3504,7 @@ test "iterative parser: max depth exceeded" {
var input = if (builtin.zig_version.minor == 14)
std.ArrayList(u8).init(allocator)
else
std.ArrayList(u8){};
std.ArrayList(u8).initCapacity(allocator, 0) catch unreachable;
defer if (builtin.zig_version.minor == 14) input.deinit() else input.deinit(allocator);

const depth = 100;
Expand Down Expand Up @@ -3548,7 +3550,7 @@ test "iterative parser: array too large" {
var input = if (builtin.zig_version.minor == 14)
std.ArrayList(u8).init(allocator)
else
std.ArrayList(u8){};
std.ArrayList(u8).initCapacity(allocator, 0) catch unreachable;
defer if (builtin.zig_version.minor == 14) input.deinit() else input.deinit(allocator);

// array16 marker + length
Expand Down Expand Up @@ -3580,7 +3582,7 @@ test "iterative parser: deep nested maps" {
var input = if (builtin.zig_version.minor == 14)
std.ArrayList(u8).init(allocator)
else
std.ArrayList(u8){};
std.ArrayList(u8).initCapacity(allocator, 0) catch unreachable;
defer if (builtin.zig_version.minor == 14) input.deinit() else input.deinit(allocator);

const depth = 50;
Expand Down Expand Up @@ -3775,7 +3777,7 @@ test "fuzz: deep mixed nesting" {
var input = if (builtin.zig_version.minor == 14)
std.ArrayList(u8).init(allocator)
else
std.ArrayList(u8){};
std.ArrayList(u8).initCapacity(allocator, 0) catch unreachable;
defer if (builtin.zig_version.minor == 14) input.deinit() else input.deinit(allocator);

for (0..depth) |_| {
Expand Down Expand Up @@ -3823,7 +3825,7 @@ test "malicious: array32 claims 4 billion elements" {
var input = if (builtin.zig_version.minor == 14)
std.ArrayList(u8).init(allocator)
else
std.ArrayList(u8){};
std.ArrayList(u8).initCapacity(allocator, 0) catch unreachable;
defer if (builtin.zig_version.minor == 14) input.deinit() else input.deinit(allocator);

// array32 claiming 0xFFFFFFFF (4 billion) elements
Expand Down Expand Up @@ -3858,7 +3860,7 @@ test "malicious: map32 claims 4 billion pairs" {
var input = if (builtin.zig_version.minor == 14)
std.ArrayList(u8).init(allocator)
else
std.ArrayList(u8){};
std.ArrayList(u8).initCapacity(allocator, 0) catch unreachable;
defer if (builtin.zig_version.minor == 14) input.deinit() else input.deinit(allocator);

// map32 claiming 0xFFFFFFFF pairs
Expand Down Expand Up @@ -3903,7 +3905,7 @@ test "malicious: extremely deep nesting (2000 layers)" {
var input = if (builtin.zig_version.minor == 14)
std.ArrayList(u8).init(allocator)
else
std.ArrayList(u8){};
std.ArrayList(u8).initCapacity(allocator, 0) catch unreachable;
defer if (builtin.zig_version.minor == 14) input.deinit() else input.deinit(allocator);

// 2000 layers of nesting (far exceeds limit of 100)
Expand Down Expand Up @@ -3939,7 +3941,7 @@ test "corrupted: truncated array data" {
var input = if (builtin.zig_version.minor == 14)
std.ArrayList(u8).init(allocator)
else
std.ArrayList(u8){};
std.ArrayList(u8).initCapacity(allocator, 0) catch unreachable;
defer if (builtin.zig_version.minor == 14) input.deinit() else input.deinit(allocator);

// array claiming 10 elements but data is incomplete
Expand Down Expand Up @@ -3971,7 +3973,7 @@ test "map with non-string key (integer key)" {
var input = if (builtin.zig_version.minor == 14)
std.ArrayList(u8).init(allocator)
else
std.ArrayList(u8){};
std.ArrayList(u8).initCapacity(allocator, 0) catch unreachable;
defer if (builtin.zig_version.minor == 14) input.deinit() else input.deinit(allocator);

// map with integer key (now valid - keys can be any Payload type)
Expand Down Expand Up @@ -4023,7 +4025,7 @@ test "malicious: mixed depth and breadth attack" {
var input = if (builtin.zig_version.minor == 14)
std.ArrayList(u8).init(allocator)
else
std.ArrayList(u8){};
std.ArrayList(u8).initCapacity(allocator, 0) catch unreachable;
defer if (builtin.zig_version.minor == 14) input.deinit() else input.deinit(allocator);

// Build: [ [100 items], [100 items], ... ] nested 60 levels deep
Expand Down Expand Up @@ -4059,7 +4061,7 @@ test "edge case: empty containers at various depths" {
var input = if (builtin.zig_version.minor == 14)
std.ArrayList(u8).init(allocator)
else
std.ArrayList(u8){};
std.ArrayList(u8).initCapacity(allocator, 0) catch unreachable;
defer if (builtin.zig_version.minor == 14) input.deinit() else input.deinit(allocator);

const depths = [_]usize{ 0, 1, 5, 10, 20 };
Expand Down Expand Up @@ -4133,7 +4135,7 @@ test "corrupted: nested arrays with mismatched counts" {
var input = if (builtin.zig_version.minor == 14)
std.ArrayList(u8).init(allocator)
else
std.ArrayList(u8){};
std.ArrayList(u8).initCapacity(allocator, 0) catch unreachable;
defer if (builtin.zig_version.minor == 14) input.deinit() else input.deinit(allocator);

// Outer array claims 3 elements, but we provide different structure
Expand Down Expand Up @@ -5004,8 +5006,6 @@ test "memory alignment: large integer array serialization" {
// std.io.Reader and std.io.Writer Tests (Zig 0.15+)
// ============================================================================

const has_new_io = builtin.zig_version.minor >= 15;

test "PackerIO: basic write and read with fixed Reader/Writer" {
if (!has_new_io) return error.SkipZigTest;

Expand Down
Loading