-
Notifications
You must be signed in to change notification settings - Fork 288
Build with zig #431
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.
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
base: main
Are you sure you want to change the base?
Build with zig #431
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
name: Zig build | ||
|
||
on: | ||
pull_request: | ||
branches: [ main ] | ||
|
||
env: | ||
ZIG_VERSION: 0.15.1 | ||
|
||
jobs: | ||
lint: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v5 | ||
- uses: mlugg/setup-zig@v2 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. why specifying the version and a mirror ? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good question: a. the version can be set to |
||
with: | ||
version: ${{ env.ZIG_VERSION }} | ||
mirror: 'https://zigmirror.com' | ||
- run: zig fmt --check . | ||
|
||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v5 | ||
- uses: mlugg/setup-zig@v2 | ||
with: | ||
version: ${{ env.ZIG_VERSION }} | ||
mirror: 'https://zigmirror.com' | ||
- run: zig build | ||
|
||
run: | ||
strategy: | ||
matrix: | ||
include: | ||
- os: ubuntu-latest | ||
target: x86_64-linux-musl | ||
- os: ubuntu-latest | ||
target: x86_64-linux-gnu | ||
- os: ubuntu-24.04-arm64 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. runner are labeled : ref: There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks, I am actually going to implement your suggestion here
and use QEMU, if that's ok with you |
||
target: aarch64-linux-musl | ||
- os: ubuntu-24.04-arm64 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
target: aarch64-linux-gnu | ||
runs-on: ${{ matrix.os }} | ||
steps: | ||
- uses: actions/checkout@v5 | ||
- uses: mlugg/setup-zig@v2 | ||
with: | ||
version: ${{ env.ZIG_VERSION }} | ||
mirror: 'https://zigmirror.com' | ||
- name: Run list_cpu_features | ||
run: zig build run -Dtarget=${{ matrix.target }} -- --json |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,3 +18,7 @@ MODULE.bazel.lock | |
|
||
# Per-user bazelrc files | ||
user.bazelrc | ||
|
||
# Zig build artifacts | ||
.zig-cache | ||
zig-out |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,244 @@ | ||
const std = @import("std"); | ||
|
||
pub fn build(b: *std.Build) void { | ||
// Standard target and optimization options | ||
const target = b.standardTargetOptions(.{}); | ||
const optimize = b.standardOptimizeOption(.{}); | ||
|
||
// Build options (mirroring CMake options) | ||
const build_executable = b.option(bool, "BUILD_EXECUTABLE", "Build list_cpu_features executable") orelse true; | ||
const enable_install = b.option(bool, "ENABLE_INSTALL", "Enable install targets") orelse true; | ||
|
||
// Create the cpu_features static library | ||
const cpu_features = b.addLibrary(.{ | ||
.name = "cpu_features", | ||
.linkage = .static, | ||
.root_module = b.createModule(.{ | ||
.target = target, | ||
.optimize = optimize, | ||
.link_libc = true, | ||
}), | ||
}); | ||
|
||
cpu_features.addIncludePath(b.path("include")); | ||
cpu_features.addIncludePath(b.path("include/internal")); | ||
|
||
// Public compile definitions | ||
cpu_features.root_module.addCMacro("STACK_LINE_READER_BUFFER_SIZE", "1024"); | ||
|
||
// Platform-specific defines | ||
const os_tag = target.result.os.tag; | ||
const cpu_arch = target.result.cpu.arch; | ||
|
||
if (os_tag.isDarwin()) { | ||
cpu_features.root_module.addCMacro("HAVE_SYSCTLBYNAME", "1"); | ||
} | ||
|
||
// Utility sources (always included) | ||
const utility_sources = [_][]const u8{ | ||
"src/filesystem.c", | ||
"src/stack_line_reader.c", | ||
"src/string_view.c", | ||
}; | ||
|
||
// Common C flags for all source files | ||
const c_flags = [_][]const u8{ | ||
"-Wall", | ||
"-Wextra", | ||
"-Wmissing-declarations", | ||
"-Wmissing-prototypes", | ||
"-Wno-implicit-fallthrough", | ||
"-Wno-unused-function", | ||
"-Wold-style-definition", | ||
"-Wshadow", | ||
"-Wsign-compare", | ||
"-Wstrict-prototypes", | ||
"-std=c99", | ||
"-fno-sanitize=undefined", // Disable UBSan for C code with intentional unaligned access | ||
}; | ||
|
||
for (utility_sources) |source| { | ||
cpu_features.addCSourceFile(.{ | ||
.file = b.path(source), | ||
.flags = &c_flags, | ||
}); | ||
} | ||
|
||
// Unix-based hardware detection (for non-x86 Unix platforms) | ||
// Note: Android is represented as Linux in Zig's target system | ||
if (os_tag != .windows and !cpu_arch.isX86()) { | ||
const hwcaps_sources = [_][]const u8{ | ||
"src/hwcaps.c", | ||
"src/hwcaps_linux_or_android.c", | ||
"src/hwcaps_freebsd_or_openbsd.c", | ||
}; | ||
|
||
for (hwcaps_sources) |source| { | ||
cpu_features.addCSourceFile(.{ | ||
.file = b.path(source), | ||
.flags = &c_flags, | ||
}); | ||
} | ||
} | ||
|
||
// Architecture-specific implementation files | ||
// Determine which implementation files to include based on target architecture | ||
// Note: Android is represented as Linux in Zig's target system | ||
switch (cpu_arch) { | ||
.x86, .x86_64 => { | ||
// x86/x86_64 architecture | ||
const source: ?[]const u8 = if (os_tag == .linux) | ||
"src/impl_x86_linux_or_android.c" | ||
else if (os_tag.isDarwin()) | ||
"src/impl_x86_macos.c" | ||
else if (os_tag == .windows) | ||
"src/impl_x86_windows.c" | ||
else if (os_tag == .freebsd) | ||
"src/impl_x86_freebsd.c" | ||
else | ||
null; | ||
|
||
if (source) |s| { | ||
cpu_features.addCSourceFile(.{ | ||
.file = b.path(s), | ||
.flags = &c_flags, | ||
}); | ||
} | ||
}, | ||
.aarch64, .aarch64_be => { | ||
// AArch64 architecture - always needs cpuid | ||
cpu_features.addCSourceFile(.{ | ||
.file = b.path("src/impl_aarch64_cpuid.c"), | ||
.flags = &c_flags, | ||
}); | ||
|
||
const source: ?[]const u8 = if (os_tag == .linux) | ||
"src/impl_aarch64_linux_or_android.c" | ||
else if (os_tag.isDarwin()) | ||
"src/impl_aarch64_macos_or_iphone.c" | ||
else if (os_tag == .windows) | ||
"src/impl_aarch64_windows.c" | ||
else if (os_tag == .freebsd or os_tag == .openbsd) | ||
"src/impl_aarch64_freebsd_or_openbsd.c" | ||
else | ||
null; | ||
|
||
if (source) |s| { | ||
cpu_features.addCSourceFile(.{ | ||
.file = b.path(s), | ||
.flags = &c_flags, | ||
}); | ||
} | ||
}, | ||
.arm, .armeb, .thumb, .thumbeb => { | ||
// ARM (32-bit) architecture | ||
if (os_tag == .linux) { | ||
cpu_features.addCSourceFile(.{ | ||
.file = b.path("src/impl_arm_linux_or_android.c"), | ||
.flags = &c_flags, | ||
}); | ||
} | ||
}, | ||
.mips, .mipsel, .mips64, .mips64el => { | ||
// MIPS architecture | ||
if (os_tag == .linux) { | ||
cpu_features.addCSourceFile(.{ | ||
.file = b.path("src/impl_mips_linux_or_android.c"), | ||
.flags = &c_flags, | ||
}); | ||
} | ||
}, | ||
.powerpc, .powerpcle, .powerpc64, .powerpc64le => { | ||
// PowerPC architecture | ||
if (os_tag == .linux) { | ||
cpu_features.addCSourceFile(.{ | ||
.file = b.path("src/impl_ppc_linux.c"), | ||
.flags = &c_flags, | ||
}); | ||
} | ||
}, | ||
.riscv32, .riscv64 => { | ||
// RISC-V architecture | ||
if (os_tag == .linux) { | ||
cpu_features.addCSourceFile(.{ | ||
.file = b.path("src/impl_riscv_linux.c"), | ||
.flags = &c_flags, | ||
}); | ||
} | ||
}, | ||
.s390x => { | ||
// s390x architecture | ||
if (os_tag == .linux) { | ||
cpu_features.addCSourceFile(.{ | ||
.file = b.path("src/impl_s390x_linux.c"), | ||
.flags = &c_flags, | ||
}); | ||
} | ||
}, | ||
.loongarch64 => { | ||
// LoongArch architecture | ||
if (os_tag == .linux) { | ||
cpu_features.addCSourceFile(.{ | ||
.file = b.path("src/impl_loongarch_linux.c"), | ||
.flags = &c_flags, | ||
}); | ||
} | ||
}, | ||
else => { | ||
std.debug.print("Warning: Unsupported architecture {s}\n", .{@tagName(cpu_arch)}); | ||
}, | ||
} | ||
|
||
// Link against dl library on Unix-like systems | ||
if (os_tag != .windows and os_tag != .wasi) { | ||
cpu_features.linkSystemLibrary("dl"); | ||
} | ||
|
||
// Install the library if enabled | ||
if (enable_install) { | ||
b.installArtifact(cpu_features); | ||
|
||
// Install headers | ||
const install_headers = b.addInstallDirectory(.{ | ||
.source_dir = b.path("include"), | ||
.install_dir = .header, | ||
.install_subdir = "cpu_features", | ||
.exclude_extensions = &.{}, | ||
}); | ||
b.getInstallStep().dependOn(&install_headers.step); | ||
} | ||
|
||
// Build list_cpu_features executable if requested | ||
if (build_executable) { | ||
const list_cpu_features = b.addExecutable(.{ | ||
.name = "list_cpu_features", | ||
.root_module = b.createModule(.{ | ||
.target = target, | ||
.optimize = optimize, | ||
.link_libc = true, | ||
}), | ||
}); | ||
|
||
list_cpu_features.linkLibrary(cpu_features); | ||
list_cpu_features.addIncludePath(b.path("include")); | ||
|
||
list_cpu_features.addCSourceFile(.{ | ||
.file = b.path("src/utils/list_cpu_features.c"), | ||
.flags = &c_flags, | ||
}); | ||
|
||
if (enable_install) { | ||
b.installArtifact(list_cpu_features); | ||
} | ||
|
||
// Add a run step for convenience | ||
const run_cmd = b.addRunArtifact(list_cpu_features); | ||
run_cmd.step.dependOn(b.getInstallStep()); | ||
if (b.args) |args| { | ||
run_cmd.addArgs(args); | ||
} | ||
|
||
const run_step = b.step("run", "Run list_cpu_features"); | ||
run_step.dependOn(&run_cmd.step); | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
.{ | ||
.name = .cpu_features, | ||
.version = "0.0.1", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. why not using the cpu version instead ? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Do you mean using the same version as released for the other artifacts in the repo? |
||
.minimum_zig_version = "0.15.1", | ||
.paths = .{ | ||
"build.zig", | ||
"build.zig.zon", | ||
"src", | ||
"include", | ||
}, | ||
.fingerprint = 0xbd52e965d3c20004, | ||
} |
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would split this in 3 files;
zig.yml
following the clang_format.yml Check but for Zig CheckCurrently seems we have two CI workflows:
amd64_linux_zig.yml
aarch64_linux_zig.yml
note:
ubuntu-20.04-arm64
are thid party runner maybe using a regular ubuntu-latest+QEMU to cross compile et run should be more robust against the gh runner infraMaybe to extend to Macos (brew?) and windows too later ?
thus, adding
Zig
to BuildSystem and a svg logo (e.g. https://github.com/ziglang/logo/blob/master/zig-mark.svg) and we should be able to generate badges too to update the README.md CI table...ref: https://github.com/google/cpu_features/blob/main/scripts/generate_badges.d
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, and love the idea!
I'll get to it