aboutsummaryrefslogtreecommitdiff
path: root/lib/std
diff options
context:
space:
mode:
Diffstat (limited to 'lib/std')
-rw-r--r--lib/std/build.zig338
-rw-r--r--lib/std/build/check_file.zig52
-rw-r--r--lib/std/build/run.zig302
-rw-r--r--lib/std/build/translate_c.zig73
-rw-r--r--lib/std/build/write_file.zig94
-rw-r--r--lib/std/fs.zig13
6 files changed, 675 insertions, 197 deletions
diff --git a/lib/std/build.zig b/lib/std/build.zig
index 05f33eafdd..5e4f83d278 100644
--- a/lib/std/build.zig
+++ b/lib/std/build.zig
@@ -17,6 +17,10 @@ const fmt_lib = std.fmt;
const File = std.fs.File;
pub const FmtStep = @import("build/fmt.zig").FmtStep;
+pub const TranslateCStep = @import("build/translate_c.zig").TranslateCStep;
+pub const WriteFileStep = @import("build/write_file.zig").WriteFileStep;
+pub const RunStep = @import("build/run.zig").RunStep;
+pub const CheckFileStep = @import("build/check_file.zig").CheckFileStep;
pub const Builder = struct {
install_tls: TopLevelStep,
@@ -203,23 +207,67 @@ pub const Builder = struct {
}
pub fn addExecutable(self: *Builder, name: []const u8, root_src: ?[]const u8) *LibExeObjStep {
+ return LibExeObjStep.createExecutable(
+ self,
+ name,
+ if (root_src) |p| FileSource{ .path = p } else null,
+ false,
+ );
+ }
+
+ pub fn addExecutableFromWriteFileStep(
+ self: *Builder,
+ name: []const u8,
+ wfs: *WriteFileStep,
+ basename: []const u8,
+ ) *LibExeObjStep {
+ return LibExeObjStep.createExecutable(self, name, @as(FileSource, .{
+ .write_file = .{
+ .step = wfs,
+ .basename = basename,
+ },
+ }), false);
+ }
+
+ pub fn addExecutableSource(
+ self: *Builder,
+ name: []const u8,
+ root_src: ?FileSource,
+ ) *LibExeObjStep {
return LibExeObjStep.createExecutable(self, name, root_src, false);
}
pub fn addObject(self: *Builder, name: []const u8, root_src: ?[]const u8) *LibExeObjStep {
- return LibExeObjStep.createObject(self, name, root_src);
+ const root_src_param = if (root_src) |p| @as(FileSource, .{ .path = p }) else null;
+ return LibExeObjStep.createObject(self, name, root_src_param);
+ }
+
+ pub fn addObjectFromWriteFileStep(
+ self: *Builder,
+ name: []const u8,
+ wfs: *WriteFileStep,
+ basename: []const u8,
+ ) *LibExeObjStep {
+ return LibExeObjStep.createObject(self, name, @as(FileSource, .{
+ .write_file = .{
+ .step = wfs,
+ .basename = basename,
+ },
+ }));
}
pub fn addSharedLibrary(self: *Builder, name: []const u8, root_src: ?[]const u8, ver: Version) *LibExeObjStep {
- return LibExeObjStep.createSharedLibrary(self, name, root_src, ver);
+ const root_src_param = if (root_src) |p| @as(FileSource, .{ .path = p }) else null;
+ return LibExeObjStep.createSharedLibrary(self, name, root_src_param, ver);
}
pub fn addStaticLibrary(self: *Builder, name: []const u8, root_src: ?[]const u8) *LibExeObjStep {
- return LibExeObjStep.createStaticLibrary(self, name, root_src);
+ const root_src_param = if (root_src) |p| @as(FileSource, .{ .path = p }) else null;
+ return LibExeObjStep.createStaticLibrary(self, name, root_src_param);
}
pub fn addTest(self: *Builder, root_src: []const u8) *LibExeObjStep {
- return LibExeObjStep.createTest(self, "test", root_src);
+ return LibExeObjStep.createTest(self, "test", .{ .path = root_src });
}
pub fn addAssemble(self: *Builder, name: []const u8, src: []const u8) *LibExeObjStep {
@@ -256,8 +304,14 @@ pub const Builder = struct {
}
pub fn addWriteFile(self: *Builder, file_path: []const u8, data: []const u8) *WriteFileStep {
+ const write_file_step = self.addWriteFiles();
+ write_file_step.add(file_path, data);
+ return write_file_step;
+ }
+
+ pub fn addWriteFiles(self: *Builder) *WriteFileStep {
const write_file_step = self.allocator.create(WriteFileStep) catch unreachable;
- write_file_step.* = WriteFileStep.init(self, file_path, data);
+ write_file_step.* = WriteFileStep.init(self);
return write_file_step;
}
@@ -278,6 +332,10 @@ pub const Builder = struct {
return FmtStep.create(self, paths);
}
+ pub fn addTranslateC(self: *Builder, source: FileSource) *TranslateCStep {
+ return TranslateCStep.create(self, source);
+ }
+
pub fn version(self: *const Builder, major: u32, minor: u32, patch: u32) Version {
return Version{
.major = major,
@@ -1002,7 +1060,7 @@ const Pkg = struct {
};
const CSourceFile = struct {
- source_path: []const u8,
+ source: FileSource,
args: []const []const u8,
};
@@ -1015,6 +1073,33 @@ fn isLibCLibrary(name: []const u8) bool {
return false;
}
+pub const FileSource = union(enum) {
+ /// Relative to build root
+ path: []const u8,
+ write_file: struct {
+ step: *WriteFileStep,
+ basename: []const u8,
+ },
+ translate_c: *TranslateCStep,
+
+ pub fn addStepDependencies(self: FileSource, step: *Step) void {
+ switch (self) {
+ .path => {},
+ .write_file => |wf| step.dependOn(&wf.step.step),
+ .translate_c => |tc| step.dependOn(&tc.step),
+ }
+ }
+
+ /// Should only be called during make()
+ pub fn getPath(self: FileSource, builder: *Builder) []const u8 {
+ return switch (self) {
+ .path => |p| builder.pathFromRoot(p),
+ .write_file => |wf| wf.step.getOutputPath(wf.basename),
+ .translate_c => |tc| tc.getOutputPath(),
+ };
+ }
+};
+
pub const LibExeObjStep = struct {
step: Step,
builder: *Builder,
@@ -1047,7 +1132,7 @@ pub const LibExeObjStep = struct {
filter: ?[]const u8,
single_threaded: bool,
- root_src: ?[]const u8,
+ root_src: ?FileSource,
out_h_filename: []const u8,
out_lib_filename: []const u8,
out_pdb_filename: []const u8,
@@ -1099,7 +1184,7 @@ pub const LibExeObjStep = struct {
StaticPath: []const u8,
OtherStep: *LibExeObjStep,
SystemLib: []const u8,
- AssemblyFile: []const u8,
+ AssemblyFile: FileSource,
CSourceFile: *CSourceFile,
};
@@ -1116,37 +1201,44 @@ pub const LibExeObjStep = struct {
Test,
};
- pub fn createSharedLibrary(builder: *Builder, name: []const u8, root_src: ?[]const u8, ver: Version) *LibExeObjStep {
+ pub fn createSharedLibrary(builder: *Builder, name: []const u8, root_src: ?FileSource, ver: Version) *LibExeObjStep {
const self = builder.allocator.create(LibExeObjStep) catch unreachable;
self.* = initExtraArgs(builder, name, root_src, Kind.Lib, true, ver);
return self;
}
- pub fn createStaticLibrary(builder: *Builder, name: []const u8, root_src: ?[]const u8) *LibExeObjStep {
+ pub fn createStaticLibrary(builder: *Builder, name: []const u8, root_src: ?FileSource) *LibExeObjStep {
const self = builder.allocator.create(LibExeObjStep) catch unreachable;
self.* = initExtraArgs(builder, name, root_src, Kind.Lib, false, builder.version(0, 0, 0));
return self;
}
- pub fn createObject(builder: *Builder, name: []const u8, root_src: ?[]const u8) *LibExeObjStep {
+ pub fn createObject(builder: *Builder, name: []const u8, root_src: ?FileSource) *LibExeObjStep {
const self = builder.allocator.create(LibExeObjStep) catch unreachable;
self.* = initExtraArgs(builder, name, root_src, Kind.Obj, false, builder.version(0, 0, 0));
return self;
}
- pub fn createExecutable(builder: *Builder, name: []const u8, root_src: ?[]const u8, is_dynamic: bool) *LibExeObjStep {
+ pub fn createExecutable(builder: *Builder, name: []const u8, root_src: ?FileSource, is_dynamic: bool) *LibExeObjStep {
const self = builder.allocator.create(LibExeObjStep) catch unreachable;
self.* = initExtraArgs(builder, name, root_src, Kind.Exe, is_dynamic, builder.version(0, 0, 0));
return self;
}
- pub fn createTest(builder: *Builder, name: []const u8, root_src: []const u8) *LibExeObjStep {
+ pub fn createTest(builder: *Builder, name: []const u8, root_src: FileSource) *LibExeObjStep {
const self = builder.allocator.create(LibExeObjStep) catch unreachable;
self.* = initExtraArgs(builder, name, root_src, Kind.Test, false, builder.version(0, 0, 0));
return self;
}
- fn initExtraArgs(builder: *Builder, name: []const u8, root_src: ?[]const u8, kind: Kind, is_dynamic: bool, ver: Version) LibExeObjStep {
+ fn initExtraArgs(
+ builder: *Builder,
+ name: []const u8,
+ root_src: ?FileSource,
+ kind: Kind,
+ is_dynamic: bool,
+ ver: Version,
+ ) LibExeObjStep {
if (mem.indexOf(u8, name, "/") != null or mem.indexOf(u8, name, "\\") != null) {
panic("invalid name: '{}'. It looks like a file path, but it is supposed to be the library or application name.", .{name});
}
@@ -1196,6 +1288,7 @@ pub const LibExeObjStep = struct {
.install_step = null,
};
self.computeOutFileNames();
+ if (root_src) |rs| rs.addStepDependencies(&self.step);
return self;
}
@@ -1486,15 +1579,22 @@ pub const LibExeObjStep = struct {
}
pub fn addCSourceFile(self: *LibExeObjStep, file: []const u8, args: []const []const u8) void {
+ self.addCSourceFileSource(.{
+ .args = args,
+ .source = .{ .path = file },
+ });
+ }
+
+ pub fn addCSourceFileSource(self: *LibExeObjStep, source: CSourceFile) void {
const c_source_file = self.builder.allocator.create(CSourceFile) catch unreachable;
- const args_copy = self.builder.allocator.alloc([]u8, args.len) catch unreachable;
- for (args) |arg, i| {
+
+ const args_copy = self.builder.allocator.alloc([]u8, source.args.len) catch unreachable;
+ for (source.args) |arg, i| {
args_copy[i] = self.builder.dupe(arg);
}
- c_source_file.* = CSourceFile{
- .source_path = self.builder.dupe(file),
- .args = args_copy,
- };
+
+ c_source_file.* = source;
+ c_source_file.args = args_copy;
self.link_objects.append(LinkObject{ .CSourceFile = c_source_file }) catch unreachable;
}
@@ -1571,6 +1671,20 @@ pub const LibExeObjStep = struct {
self.link_objects.append(LinkObject{ .AssemblyFile = self.builder.dupe(path) }) catch unreachable;
}
+ pub fn addAssemblyFileFromWriteFileStep(self: *LibExeObjStep, wfs: *WriteFileStep, basename: []const u8) void {
+ self.addAssemblyFileSource(.{
+ .write_file = .{
+ .step = wfs,
+ .basename = self.builder.dupe(basename),
+ },
+ });
+ }
+
+ pub fn addAssemblyFileSource(self: *LibExeObjStep, source: FileSource) void {
+ self.link_objects.append(LinkObject{ .AssemblyFile = source }) catch unreachable;
+ source.addStepDependencies(&self.step);
+ }
+
pub fn addObjectFile(self: *LibExeObjStep, path: []const u8) void {
self.link_objects.append(LinkObject{ .StaticPath = self.builder.dupe(path) }) catch unreachable;
}
@@ -1698,25 +1812,23 @@ pub const LibExeObjStep = struct {
};
zig_args.append(cmd) catch unreachable;
- if (self.root_src) |root_src| {
- zig_args.append(builder.pathFromRoot(root_src)) catch unreachable;
- }
+ if (self.root_src) |root_src| try zig_args.append(root_src.getPath(builder));
for (self.link_objects.toSlice()) |link_object| {
switch (link_object) {
- LinkObject.StaticPath => |static_path| {
+ .StaticPath => |static_path| {
try zig_args.append("--object");
try zig_args.append(builder.pathFromRoot(static_path));
},
- LinkObject.OtherStep => |other| switch (other.kind) {
- LibExeObjStep.Kind.Exe => unreachable,
- LibExeObjStep.Kind.Test => unreachable,
- LibExeObjStep.Kind.Obj => {
+ .OtherStep => |other| switch (other.kind) {
+ .Exe => unreachable,
+ .Test => unreachable,
+ .Obj => {
try zig_args.append("--object");
try zig_args.append(other.getOutputPath());
},
- LibExeObjStep.Kind.Lib => {
+ .Lib => {
if (!other.is_dynamic or self.target.isWindows()) {
try zig_args.append("--object");
try zig_args.append(other.getOutputLibPath());
@@ -1732,20 +1844,20 @@ pub const LibExeObjStep = struct {
}
},
},
- LinkObject.SystemLib => |name| {
+ .SystemLib => |name| {
try zig_args.append("--library");
try zig_args.append(name);
},
- LinkObject.AssemblyFile => |asm_file| {
+ .AssemblyFile => |asm_file| {
try zig_args.append("--c-source");
- try zig_args.append(builder.pathFromRoot(asm_file));
+ try zig_args.append(asm_file.getPath(builder));
},
- LinkObject.CSourceFile => |c_source_file| {
+ .CSourceFile => |c_source_file| {
try zig_args.append("--c-source");
for (c_source_file.args) |arg| {
try zig_args.append(arg);
}
- try zig_args.append(self.builder.pathFromRoot(c_source_file.source_path));
+ try zig_args.append(c_source_file.source.getPath(builder));
},
}
}
@@ -2041,134 +2153,6 @@ pub const LibExeObjStep = struct {
}
};
-pub const RunStep = struct {
- step: Step,
- builder: *Builder,
-
- /// See also addArg and addArgs to modifying this directly
- argv: ArrayList(Arg),
-
- /// Set this to modify the current working directory
- cwd: ?[]const u8,
-
- /// Override this field to modify the environment, or use setEnvironmentVariable
- env_map: ?*BufMap,
-
- pub const Arg = union(enum) {
- Artifact: *LibExeObjStep,
- Bytes: []u8,
- };
-
- pub fn create(builder: *Builder, name: []const u8) *RunStep {
- const self = builder.allocator.create(RunStep) catch unreachable;
- self.* = RunStep{
- .builder = builder,
- .step = Step.init(name, builder.allocator, make),
- .argv = ArrayList(Arg).init(builder.allocator),
- .cwd = null,
- .env_map = null,
- };
- return self;
- }
-
- pub fn addArtifactArg(self: *RunStep, artifact: *LibExeObjStep) void {
- self.argv.append(Arg{ .Artifact = artifact }) catch unreachable;
- self.step.dependOn(&artifact.step);
- }
-
- pub fn addArg(self: *RunStep, arg: []const u8) void {
- self.argv.append(Arg{ .Bytes = self.builder.dupe(arg) }) catch unreachable;
- }
-
- pub fn addArgs(self: *RunStep, args: []const []const u8) void {
- for (args) |arg| {
- self.addArg(arg);
- }
- }
-
- pub fn clearEnvironment(self: *RunStep) void {
- const new_env_map = self.builder.allocator.create(BufMap) catch unreachable;
- new_env_map.* = BufMap.init(self.builder.allocator);
- self.env_map = new_env_map;
- }
-
- pub fn addPathDir(self: *RunStep, search_path: []const u8) void {
- const env_map = self.getEnvMap();
-
- var key: []const u8 = undefined;
- var prev_path: ?[]const u8 = undefined;
- if (builtin.os == .windows) {
- key = "Path";
- prev_path = env_map.get(key);
- if (prev_path == null) {
- key = "PATH";
- prev_path = env_map.get(key);
- }
- } else {
- key = "PATH";
- prev_path = env_map.get(key);
- }
-
- if (prev_path) |pp| {
- const new_path = self.builder.fmt("{}" ++ [1]u8{fs.path.delimiter} ++ "{}", .{ pp, search_path });
- env_map.set(key, new_path) catch unreachable;
- } else {
- env_map.set(key, search_path) catch unreachable;
- }
- }
-
- pub fn getEnvMap(self: *RunStep) *BufMap {
- return self.env_map orelse {
- const env_map = self.builder.allocator.create(BufMap) catch unreachable;
- env_map.* = process.getEnvMap(self.builder.allocator) catch unreachable;
- self.env_map = env_map;
- return env_map;
- };
- }
-
- pub fn setEnvironmentVariable(self: *RunStep, key: []const u8, value: []const u8) void {
- const env_map = self.getEnvMap();
- env_map.set(key, value) catch unreachable;
- }
-
- fn make(step: *Step) !void {
- const self = @fieldParentPtr(RunStep, "step", step);
-
- const cwd = if (self.cwd) |cwd| self.builder.pathFromRoot(cwd) else self.builder.build_root;
-
- var argv = ArrayList([]const u8).init(self.builder.allocator);
- for (self.argv.toSlice()) |arg| {
- switch (arg) {
- Arg.Bytes => |bytes| try argv.append(bytes),
- Arg.Artifact => |artifact| {
- if (artifact.target.isWindows()) {
- // On Windows we don't have rpaths so we have to add .dll search paths to PATH
- self.addPathForDynLibs(artifact);
- }
- const executable_path = artifact.installed_path orelse artifact.getOutputPath();
- try argv.append(executable_path);
- },
- }
- }
-
- return self.builder.spawnChildEnvMap(cwd, self.env_map orelse self.builder.env_map, argv.toSliceConst());
- }
-
- fn addPathForDynLibs(self: *RunStep, artifact: *LibExeObjStep) void {
- for (artifact.link_objects.toSliceConst()) |link_object| {
- switch (link_object) {
- LibExeObjStep.LinkObject.OtherStep => |other| {
- if (other.target.isWindows() and other.isDynamicLibrary()) {
- self.addPathDir(fs.path.dirname(other.getOutputPath()).?);
- self.addPathForDynLibs(other);
- }
- },
- else => {},
- }
- }
- }
-};
-
const InstallArtifactStep = struct {
step: Step,
builder: *Builder,
@@ -2321,36 +2305,6 @@ pub const InstallDirStep = struct {
}
};
-pub const WriteFileStep = struct {
- step: Step,
- builder: *Builder,
- file_path: []const u8,
- data: []const u8,
-
- pub fn init(builder: *Builder, file_path: []const u8, data: []const u8) WriteFileStep {
- return WriteFileStep{
- .builder = builder,
- .step = Step.init(builder.fmt("writefile {}", .{file_path}), builder.allocator, make),
- .file_path = file_path,
- .data = data,
- };
- }
-
- fn make(step: *Step) !void {
- const self = @fieldParentPtr(WriteFileStep, "step", step);
- const full_path = self.builder.pathFromRoot(self.file_path);
- const full_path_dir = fs.path.dirname(full_path) orelse ".";
- fs.makePath(self.builder.allocator, full_path_dir) catch |err| {
- warn("unable to make path {}: {}\n", .{ full_path_dir, @errorName(err) });
- return err;
- };
- io.writeFile(full_path, self.data) catch |err| {
- warn("unable to write {}: {}\n", .{ full_path, @errorName(err) });
- return err;
- };
- }
-};
-
pub const LogStep = struct {
step: Step,
builder: *Builder,
diff --git a/lib/std/build/check_file.zig b/lib/std/build/check_file.zig
new file mode 100644
index 0000000000..782cdb5600
--- /dev/null
+++ b/lib/std/build/check_file.zig
@@ -0,0 +1,52 @@
+const std = @import("../std.zig");
+const build = std.build;
+const Step = build.Step;
+const Builder = build.Builder;
+const fs = std.fs;
+const mem = std.mem;
+const warn = std.debug.warn;
+
+pub const CheckFileStep = struct {
+ step: Step,
+ builder: *Builder,
+ expected_matches: []const []const u8,
+ source: build.FileSource,
+ max_bytes: usize = 20 * 1024 * 1024,
+
+ pub fn create(
+ builder: *Builder,
+ source: build.FileSource,
+ expected_matches: []const []const u8,
+ ) *CheckFileStep {
+ const self = builder.allocator.create(CheckFileStep) catch unreachable;
+ self.* = CheckFileStep{
+ .builder = builder,
+ .step = Step.init("CheckFile", builder.allocator, make),
+ .source = source,
+ .expected_matches = expected_matches,
+ };
+ self.source.addStepDependencies(&self.step);
+ return self;
+ }
+
+ fn make(step: *Step) !void {
+ const self = @fieldParentPtr(CheckFileStep, "step", step);
+
+ const src_path = self.source.getPath(self.builder);
+ const contents = try fs.cwd().readFileAlloc(self.builder.allocator, src_path, self.max_bytes);
+
+ for (self.expected_matches) |expected_match| {
+ if (mem.indexOf(u8, contents, expected_match) == null) {
+ warn(
+ \\
+ \\========= Expected to find: ===================
+ \\{}
+ \\========= But file does not contain it: =======
+ \\{}
+ \\
+ , .{ expected_match, contents });
+ return error.TestFailed;
+ }
+ }
+ }
+};
diff --git a/lib/std/build/run.zig b/lib/std/build/run.zig
new file mode 100644
index 0000000000..75809bde03
--- /dev/null
+++ b/lib/std/build/run.zig
@@ -0,0 +1,302 @@
+const std = @import("../std.zig");
+const builtin = std.builtin;
+const build = std.build;
+const Step = build.Step;
+const Builder = build.Builder;
+const LibExeObjStep = build.LibExeObjStep;
+const fs = std.fs;
+const mem = std.mem;
+const process = std.process;
+const ArrayList = std.ArrayList;
+const BufMap = std.BufMap;
+const Buffer = std.Buffer;
+const warn = std.debug.warn;
+
+const max_stdout_size = 1 * 1024 * 1024; // 1 MiB
+
+pub const RunStep = struct {
+ step: Step,
+ builder: *Builder,
+
+ /// See also addArg and addArgs to modifying this directly
+ argv: ArrayList(Arg),
+
+ /// Set this to modify the current working directory
+ cwd: ?[]const u8,
+
+ /// Override this field to modify the environment, or use setEnvironmentVariable
+ env_map: ?*BufMap,
+
+ stdout_action: StdIoAction = .inherit,
+ stderr_action: StdIoAction = .inherit,
+
+ expected_exit_code: u8 = 0,
+
+ pub const StdIoAction = union(enum) {
+ inherit,
+ ignore,
+ expect_exact: []const u8,
+ expect_matches: []const []const u8,
+ };
+
+ pub const Arg = union(enum) {
+ Artifact: *LibExeObjStep,
+ Bytes: []u8,
+ };
+
+ pub fn create(builder: *Builder, name: []const u8) *RunStep {
+ const self = builder.allocator.create(RunStep) catch unreachable;
+ self.* = RunStep{
+ .builder = builder,
+ .step = Step.init(name, builder.allocator, make),
+ .argv = ArrayList(Arg).init(builder.allocator),
+ .cwd = null,
+ .env_map = null,
+ };
+ return self;
+ }
+
+ pub fn addArtifactArg(self: *RunStep, artifact: *LibExeObjStep) void {
+ self.argv.append(Arg{ .Artifact = artifact }) catch unreachable;
+ self.step.dependOn(&artifact.step);
+ }
+
+ pub fn addArg(self: *RunStep, arg: []const u8) void {
+ self.argv.append(Arg{ .Bytes = self.builder.dupe(arg) }) catch unreachable;
+ }
+
+ pub fn addArgs(self: *RunStep, args: []const []const u8) void {
+ for (args) |arg| {
+ self.addArg(arg);
+ }
+ }
+
+ pub fn clearEnvironment(self: *RunStep) void {
+ const new_env_map = self.builder.allocator.create(BufMap) catch unreachable;
+ new_env_map.* = BufMap.init(self.builder.allocator);
+ self.env_map = new_env_map;
+ }
+
+ pub fn addPathDir(self: *RunStep, search_path: []const u8) void {
+ const env_map = self.getEnvMap();
+
+ var key: []const u8 = undefined;
+ var prev_path: ?[]const u8 = undefined;
+ if (builtin.os == .windows) {
+ key = "Path";
+ prev_path = env_map.get(key);
+ if (prev_path == null) {
+ key = "PATH";
+ prev_path = env_map.get(key);
+ }
+ } else {
+ key = "PATH";
+ prev_path = env_map.get(key);
+ }
+
+ if (prev_path) |pp| {
+ const new_path = self.builder.fmt("{}" ++ [1]u8{fs.path.delimiter} ++ "{}", .{ pp, search_path });
+ env_map.set(key, new_path) catch unreachable;
+ } else {
+ env_map.set(key, search_path) catch unreachable;
+ }
+ }
+
+ pub fn getEnvMap(self: *RunStep) *BufMap {
+ return self.env_map orelse {
+ const env_map = self.builder.allocator.create(BufMap) catch unreachable;
+ env_map.* = process.getEnvMap(self.builder.allocator) catch unreachable;
+ self.env_map = env_map;
+ return env_map;
+ };
+ }
+
+ pub fn setEnvironmentVariable(self: *RunStep, key: []const u8, value: []const u8) void {
+ const env_map = self.getEnvMap();
+ env_map.set(key, value) catch unreachable;
+ }
+
+ pub fn expectStdErrEqual(self: *RunStep, bytes: []const u8) void {
+ self.stderr_action = .{ .expect_exact = bytes };
+ }
+
+ pub fn expectStdOutEqual(self: *RunStep, bytes: []const u8) void {
+ self.stdout_action = .{ .expect_exact = bytes };
+ }
+
+ fn stdIoActionToBehavior(action: StdIoAction) std.ChildProcess.StdIo {
+ return switch (action) {
+ .ignore => .Ignore,
+ .inherit => .Inherit,
+ .expect_exact, .expect_matches => .Pipe,
+ };
+ }
+
+ fn make(step: *Step) !void {
+ const self = @fieldParentPtr(RunStep, "step", step);
+
+ const cwd = if (self.cwd) |cwd| self.builder.pathFromRoot(cwd) else self.builder.build_root;
+
+ var argv_list = ArrayList([]const u8).init(self.builder.allocator);
+ for (self.argv.toSlice()) |arg| {
+ switch (arg) {
+ Arg.Bytes => |bytes| try argv_list.append(bytes),
+ Arg.Artifact => |artifact| {
+ if (artifact.target.isWindows()) {
+ // On Windows we don't have rpaths so we have to add .dll search paths to PATH
+ self.addPathForDynLibs(artifact);
+ }
+ const executable_path = artifact.installed_path orelse artifact.getOutputPath();
+ try argv_list.append(executable_path);
+ },
+ }
+ }
+
+ const argv = argv_list.toSliceConst();
+
+ const child = std.ChildProcess.init(argv, self.builder.allocator) catch unreachable;
+ defer child.deinit();
+
+ child.cwd = cwd;
+ child.env_map = self.env_map orelse self.builder.env_map;
+
+ child.stdin_behavior = .Ignore;
+ child.stdout_behavior = stdIoActionToBehavior(self.stdout_action);
+ child.stderr_behavior = stdIoActionToBehavior(self.stderr_action);
+
+ child.spawn() catch |err| {
+ warn("Unable to spawn {}: {}\n", .{ argv[0], @errorName(err) });
+ return err;
+ };
+
+ var stdout = Buffer.initNull(self.builder.allocator);
+ var stderr = Buffer.initNull(self.builder.allocator);
+
+ // TODO need to poll to read these streams to prevent a deadlock (or rely on evented I/O).
+
+ switch (self.stdout_action) {
+ .expect_exact, .expect_matches => {
+ var stdout_file_in_stream = child.stdout.?.inStream();
+ stdout_file_in_stream.stream.readAllBuffer(&stdout, max_stdout_size) catch unreachable;
+ },
+ .inherit, .ignore => {},
+ }
+
+ switch (self.stdout_action) {
+ .expect_exact, .expect_matches => {
+ var stderr_file_in_stream = child.stderr.?.inStream();
+ stderr_file_in_stream.stream.readAllBuffer(&stderr, max_stdout_size) catch unreachable;
+ },
+ .inherit, .ignore => {},
+ }
+
+ const term = child.wait() catch |err| {
+ warn("Unable to spawn {}: {}\n", .{ argv[0], @errorName(err) });
+ return err;
+ };
+
+ switch (term) {
+ .Exited => |code| {
+ if (code != self.expected_exit_code) {
+ warn("The following command exited with error code {} (expected {}):\n", .{
+ code,
+ self.expected_exit_code,
+ });
+ printCmd(cwd, argv);
+ return error.UncleanExit;
+ }
+ },
+ else => {
+ warn("The following command terminated unexpectedly:\n", .{});
+ printCmd(cwd, argv);
+ return error.UncleanExit;
+ },
+ }
+
+ switch (self.stderr_action) {
+ .inherit, .ignore => {},
+ .expect_exact => |expected_bytes| {
+ if (!mem.eql(u8, expected_bytes, stderr.toSliceConst())) {
+ warn(
+ \\
+ \\========= Expected this stderr: =========
+ \\{}
+ \\========= But found: ====================
+ \\{}
+ \\
+ , .{ expected_bytes, stderr.toSliceConst() });
+ printCmd(cwd, argv);
+ return error.TestFailed;
+ }
+ },
+ .expect_matches => |matches| for (matches) |match| {
+ if (mem.indexOf(u8, stderr.toSliceConst(), match) == null) {
+ warn(
+ \\
+ \\========= Expected to find in stderr: =========
+ \\{}
+ \\========= But stderr does not contain it: =====
+ \\{}
+ \\
+ , .{ match, stderr.toSliceConst() });
+ printCmd(cwd, argv);
+ return error.TestFailed;
+ }
+ },
+ }
+
+ switch (self.stdout_action) {
+ .inherit, .ignore => {},
+ .expect_exact => |expected_bytes| {
+ if (!mem.eql(u8, expected_bytes, stdout.toSliceConst())) {
+ warn(
+ \\
+ \\========= Expected this stdout: =========
+ \\{}
+ \\========= But found: ====================
+ \\{}
+ \\
+ , .{ expected_bytes, stdout.toSliceConst() });
+ printCmd(cwd, argv);
+ return error.TestFailed;
+ }
+ },
+ .expect_matches => |matches| for (matches) |match| {
+ if (mem.indexOf(u8, stdout.toSliceConst(), match) == null) {
+ warn(
+ \\
+ \\========= Expected to find in stdout: =========
+ \\{}
+ \\========= But stdout does not contain it: =====
+ \\{}
+ \\
+ , .{ match, stdout.toSliceConst() });
+ printCmd(cwd, argv);
+ return error.TestFailed;
+ }
+ },
+ }
+ }
+
+ fn printCmd(cwd: ?[]const u8, argv: []const []const u8) void {
+ if (cwd) |yes_cwd| warn("cd {} && ", .{yes_cwd});
+ for (argv) |arg| {
+ warn("{} ", .{arg});
+ }
+ warn("\n", .{});
+ }
+
+ fn addPathForDynLibs(self: *RunStep, artifact: *LibExeObjStep) void {
+ for (artifact.link_objects.toSliceConst()) |link_object| {
+ switch (link_object) {
+ .OtherStep => |other| {
+ if (other.target.isWindows() and other.isDynamicLibrary()) {
+ self.addPathDir(fs.path.dirname(other.getOutputPath()).?);
+ self.addPathForDynLibs(other);
+ }
+ },
+ else => {},
+ }
+ }
+ }
+};
diff --git a/lib/std/build/translate_c.zig b/lib/std/build/translate_c.zig
new file mode 100644
index 0000000000..7574dbe331
--- /dev/null
+++ b/lib/std/build/translate_c.zig
@@ -0,0 +1,73 @@
+const std = @import("../std.zig");
+const build = std.build;
+const Step = build.Step;
+const Builder = build.Builder;
+const WriteFileStep = build.WriteFileStep;
+const LibExeObjStep = build.LibExeObjStep;
+const CheckFileStep = build.CheckFileStep;
+const fs = std.fs;
+const mem = std.mem;
+
+pub const TranslateCStep = struct {
+ step: Step,
+ builder: *Builder,
+ source: build.FileSource,
+ output_dir: ?[]const u8,
+ out_basename: []const u8,
+
+ pub fn create(builder: *Builder, source: build.FileSource) *TranslateCStep {
+ const self = builder.allocator.create(TranslateCStep) catch unreachable;
+ self.* = TranslateCStep{
+ .step = Step.init("zig translate-c", builder.allocator, make),
+ .builder = builder,
+ .source = source,
+ .output_dir = null,
+ .out_basename = undefined,
+ };
+ source.addStepDependencies(&self.step);
+ return self;
+ }
+
+ /// Unless setOutputDir was called, this function must be called only in
+ /// the make step, from a step that has declared a dependency on this one.
+ /// To run an executable built with zig build, use `run`, or create an install step and invoke it.
+ pub fn getOutputPath(self: *TranslateCStep) []const u8 {
+ return fs.path.join(
+ self.builder.allocator,
+ &[_][]const u8{ self.output_dir.?, self.out_basename },
+ ) catch unreachable;
+ }
+
+ /// Creates a step to build an executable from the translated source.
+ pub fn addExecutable(self: *TranslateCStep) *LibExeObjStep {
+ return self.builder.addExecutableSource("translated_c", @as(build.FileSource, .{ .translate_c = self }));
+ }
+
+ pub fn addCheckFile(self: *TranslateCStep, expected_matches: []const []const u8) *CheckFileStep {
+ return CheckFileStep.create(self.builder, .{ .translate_c = self }, expected_matches);
+ }
+
+ fn make(step: *Step) !void {
+ const self = @fieldParentPtr(TranslateCStep, "step", step);
+
+ const argv = [_][]const u8{
+ self.builder.zig_exe,
+ "translate-c",
+ "-lc",
+ "--cache",
+ "on",
+ self.source.getPath(self.builder),
+ };
+
+ const output_path_nl = try self.builder.exec(&argv);
+ const output_path = mem.trimRight(u8, output_path_nl, "\r\n");
+
+ self.out_basename = fs.path.basename(output_path);
+ if (self.output_dir) |output_dir| {
+ const full_dest = try fs.path.join(self.builder.allocator, &[_][]const u8{ output_dir, self.out_basename });
+ try self.builder.updateFile(output_path, full_dest);
+ } else {
+ self.output_dir = fs.path.dirname(output_path).?;
+ }
+ }
+};
diff --git a/lib/std/build/write_file.zig b/lib/std/build/write_file.zig
new file mode 100644
index 0000000000..13d131ac61
--- /dev/null
+++ b/lib/std/build/write_file.zig
@@ -0,0 +1,94 @@
+const std = @import("../std.zig");
+const build = @import("../build.zig");
+const Step = build.Step;
+const Builder = build.Builder;
+const fs = std.fs;
+const warn = std.debug.warn;
+const ArrayList = std.ArrayList;
+
+pub const WriteFileStep = struct {
+ step: Step,
+ builder: *Builder,
+ output_dir: []const u8,
+ files: ArrayList(File),
+
+ pub const File = struct {
+ basename: []const u8,
+ bytes: []const u8,
+ };
+
+ pub fn init(builder: *Builder) WriteFileStep {
+ return WriteFileStep{
+ .builder = builder,
+ .step = Step.init("writefile", builder.allocator, make),
+ .files = ArrayList(File).init(builder.allocator),
+ .output_dir = undefined,
+ };
+ }
+
+ pub fn add(self: *WriteFileStep, basename: []const u8, bytes: []const u8) void {
+ self.files.append(.{ .basename = basename, .bytes = bytes }) catch unreachable;
+ }
+
+ /// Unless setOutputDir was called, this function must be called only in
+ /// the make step, from a step that has declared a dependency on this one.
+ /// To run an executable built with zig build, use `run`, or create an install step and invoke it.
+ pub fn getOutputPath(self: *WriteFileStep, basename: []const u8) []const u8 {
+ return fs.path.join(
+ self.builder.allocator,
+ &[_][]const u8{ self.output_dir, basename },
+ ) catch unreachable;
+ }
+
+ fn make(step: *Step) !void {
+ const self = @fieldParentPtr(WriteFileStep, "step", step);
+
+ // The cache is used here not really as a way to speed things up - because writing
+ // the data to a file would probably be very fast - but as a way to find a canonical
+ // location to put build artifacts.
+
+ // If, for example, a hard-coded path was used as the location to put WriteFileStep
+ // files, then two WriteFileSteps executing in parallel might clobber each other.
+
+ // TODO port the cache system from stage1 to zig std lib. Until then we use blake2b
+ // directly and construct the path, and no "cache hit" detection happens; the files
+ // are always written.
+ var hash = std.crypto.Blake2b384.init();
+
+ // Random bytes to make WriteFileStep unique. Refresh this with
+ // new random bytes when WriteFileStep implementation is modified
+ // in a non-backwards-compatible way.
+ hash.update("eagVR1dYXoE7ARDP");
+ for (self.files.toSliceConst()) |file| {
+ hash.update(file.basename);
+ hash.update(file.bytes);
+ hash.update("|");
+ }
+ var digest: [48]u8 = undefined;
+ hash.final(&digest);
+ var hash_basename: [64]u8 = undefined;
+ fs.base64_encoder.encode(&hash_basename, &digest);
+ self.output_dir = try fs.path.join(self.builder.allocator, &[_][]const u8{
+ self.builder.cache_root,
+ "o",
+ &hash_basename,
+ });
+ // TODO replace with something like fs.makePathAndOpenDir
+ fs.makePath(self.builder.allocator, self.output_dir) catch |err| {
+ warn("unable to make path {}: {}\n", .{ self.output_dir, @errorName(err) });
+ return err;
+ };
+ var dir = try fs.cwd().openDirTraverse(self.output_dir);
+ defer dir.close();
+ for (self.files.toSliceConst()) |file| {
+ dir.writeFile(file.basename, file.bytes) catch |err| {
+ warn("unable to write {} into {}: {}\n", .{
+ file.basename,
+ self.output_dir,
+ @errorName(err),
+ });
+ return err;
+ };
+ }
+ }
+};
diff --git a/lib/std/fs.zig b/lib/std/fs.zig
index ea62086f59..540d5f1a1a 100644
--- a/lib/std/fs.zig
+++ b/lib/std/fs.zig
@@ -37,8 +37,11 @@ pub const MAX_PATH_BYTES = switch (builtin.os) {
else => @compileError("Unsupported OS"),
};
-// here we replace the standard +/ with -_ so that it can be used in a file name
-const b64_fs_encoder = base64.Base64Encoder.init("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_", base64.standard_pad_char);
+/// Base64, replacing the standard `+/` with `-_` so that it can be used in a file name on any filesystem.
+pub const base64_encoder = base64.Base64Encoder.init(
+ "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_",
+ base64.standard_pad_char,
+);
/// TODO remove the allocator requirement from this API
pub fn atomicSymLink(allocator: *Allocator, existing_path: []const u8, new_path: []const u8) !void {
@@ -58,7 +61,7 @@ pub fn atomicSymLink(allocator: *Allocator, existing_path: []const u8, new_path:
tmp_path[dirname.len] = path.sep;
while (true) {
try crypto.randomBytes(rand_buf[0..]);
- b64_fs_encoder.encode(tmp_path[dirname.len + 1 ..], &rand_buf);
+ base64_encoder.encode(tmp_path[dirname.len + 1 ..], &rand_buf);
if (symLink(existing_path, tmp_path)) {
return rename(tmp_path, new_path);
@@ -227,10 +230,10 @@ pub const AtomicFile = struct {
while (true) {
try crypto.randomBytes(rand_buf[0..]);
- b64_fs_encoder.encode(tmp_path_slice[dirname_component_len..tmp_path_len], &rand_buf);
+ base64_encoder.encode(tmp_path_slice[dirname_component_len..tmp_path_len], &rand_buf);
const file = my_cwd.createFileC(
- tmp_path_slice,
+ tmp_path_slice,
.{ .mode = mode, .exclusive = true },
) catch |err| switch (err) {
error.PathAlreadyExists => continue,
generated by cgit v1.2.3 (git 2.39.1) at 2025-12-28 03:51:38 +0000