Skip to content

Commit

Permalink
Extend CompileSteps collection (#15)
Browse files Browse the repository at this point in the history 
Push local, ie nearest to the current build.zig, and those with most modules towards the top.
  • Loading branch information
@llogick
llogick authored Dec 2, 2024
1 parent 967716e commit 2576adb
Show file tree
Hide file tree
Showing 4 changed files with 111 additions and 71 deletions.
10 changes: 5 additions & 5 deletions src/DocumentStore.zig
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1086,9 +1086,9 @@ fn loadBuildConfiguration(self: *DocumentStore, build_file_uri: Uri) !std.json.P
}

for (build_config.value.roots) |root| {
for (root) |*root_entry| root_entry.path = try std.fs.path.resolve(
for (root.mods) |*mod_entry| mod_entry.path = try std.fs.path.resolve(
build_config.arena.allocator(),
&[_][]const u8{ build_file_path, "..", root_entry.path },
&[_][]const u8{ build_file_path, "..", mod_entry.path },
);
}

Expand Down Expand Up @@ -1677,7 +1677,7 @@ pub fn uriFromImportStr(self: *DocumentStore, allocator: std.mem.Allocator, hand
build_file.root_id = 0;
}

for (build_config.roots[build_file.root_id]) |mod| {
for (build_config.roots[build_file.root_id].mods) |mod| {
if (std.mem.eql(u8, import_str, mod.name)) {
return try URI.fromPath(allocator, mod.path);
}
Expand All @@ -1696,7 +1696,7 @@ pub fn uriFromImportStr(self: *DocumentStore, allocator: std.mem.Allocator, hand
build_file.root_id = 0;
}

for (build_config.roots[build_file.root_id]) |mod| {
for (build_config.roots[build_file.root_id].mods) |mod| {
if (std.mem.eql(u8, import_str, mod.name)) {
return try URI.fromPath(allocator, mod.path);
}
Expand All @@ -1714,7 +1714,7 @@ pub fn uriFromImportStr(self: *DocumentStore, allocator: std.mem.Allocator, hand
build_file.root_id = 0;
}

for (build_config.roots[build_file.root_id]) |mod| {
for (build_config.roots[build_file.root_id].mods) |mod| {
if (std.mem.eql(u8, import_str, mod.name)) {
return try URI.fromPath(allocator, mod.path);
}
Expand Down
162 changes: 101 additions & 61 deletions src/build_runner/0.12.0.zig
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ else
std.Progress.Node;

var self_path: [:0]const u8 = undefined;
var build_root: [:0]const u8 = undefined;

///! This is a modified build runner to extract information out of build.zig
///! Modified version of lib/build_runner.zig
Expand Down Expand Up @@ -82,7 +83,7 @@ pub fn main() !void {

break :blk zig_lib_directory;
} else {};
const build_root = nextArg(args, &arg_idx) orelse fatal("missing build root directory path", .{});
build_root = nextArg(args, &arg_idx) orelse fatal("missing build root directory path", .{});
const cache_root = nextArg(args, &arg_idx) orelse fatal("missing cache root directory path", .{});
const global_cache_root = nextArg(args, &arg_idx) orelse fatal("missing global cache root directory path", .{});

Expand Down Expand Up @@ -890,6 +891,82 @@ const Packages = struct {
};

const roots_info = struct {
pub const RootEntry = struct {
step: *Step.Compile,
mods: []BuildConfig.NamePathPair,
};

pub fn collect(
gpa: std.mem.Allocator,
step: *Step,
visited_steps: *std.AutoArrayHashMapUnmanaged(*Step, void),
unsorted_roots: *std.ArrayListUnmanaged(RootEntry),
) !void {
const gop_result = try visited_steps.getOrPut(gpa, step);
if (gop_result.found_existing) return;
if (step.cast(Step.Compile)) |compile| {
var root_imports: std.ArrayListUnmanaged(BuildConfig.NamePathPair) = .{};
// std.debug.print("cstep: {s}\n", .{compile.name});

var cli_named_modules = try copied_from_zig.CliNamedModules.init(gpa, &compile.root_module);
var dep_it = compile.root_module.iterateDependencies(compile, false);
while (dep_it.next()) |dep| {
if (!(dep.compile.? == compile)) continue; // !my_responsibility
if (cli_named_modules.modules.getIndex(dep.module)) |module_cli_index| {
const module_cli_name = cli_named_modules.names.keys()[module_cli_index];
if (dep.module.root_source_file) |lp| {
const src = lp.getPath2(dep.module.owner, step);
// std.log.debug("-M{s}={s}\n", .{ module_cli_name, src });
try root_imports.append(gpa, .{ .name = module_cli_name, .path = src });
}
}
}
try unsorted_roots.append(
gpa,
.{
.step = compile,
.mods = try root_imports.toOwnedSlice(gpa),
},
);
root_imports.items.len = 0; // clearRetainingCapacity();
}
for (step.dependencies.items) |dep_step| try collect(
gpa,
dep_step,
visited_steps,
unsorted_roots,
);
}

pub fn hasPrecedence(dir_path: []const u8, lhs: RootEntry, rhs: RootEntry) bool {
if (lhs.mods.len == 0) return false; // C compile steps should be last
if (rhs.mods.len == 0) return true; // ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
const lhs_dir_name = std.fs.path.dirname(lhs.mods[0].path).?; // [0] should be 'root'
const rhs_dir_name = std.fs.path.dirname(rhs.mods[0].path).?; // [0] should be 'root'
if (std.mem.startsWith(u8, lhs_dir_name, dir_path)) {
return if (!std.mem.startsWith(u8, rhs_dir_name, dir_path)) true else (lhs.mods.len > rhs.mods.len);
}
return false;
}

pub fn print(
roots_info_slc: *std.ArrayList(u8),
idx: *u32,
compile: *Step.Compile,
) !void {
if (compile.root_module.root_source_file) |root_source_file| {
try roots_info_slc.writer().print(
"{}: {s} @ {s}\n",
.{ idx.*, compile.name, root_source_file.getPath(compile.root_module.owner) },
);
}
try printIt(
roots_info_slc,
compile.root_module.import_table,
);
idx.* += 1;
}

pub fn printIt(
roots_info_slc: *std.ArrayList(u8),
it: std.StringArrayHashMapUnmanaged(*std.Build.Module),
Expand Down Expand Up @@ -919,26 +996,6 @@ const roots_info = struct {
}
}
}
pub fn print(
roots_info_slc: *std.ArrayList(u8),
idx: *u32,
s: []*Step,
) !void {
for (s) |step| {
const compile: *Step.Compile = step.cast(Step.Compile) orelse continue;
if (compile.root_module.root_source_file) |root_source_file| {
try roots_info_slc.writer().print(
"{}: {s} @ {s}\n",
.{ idx.*, compile.name, root_source_file.getPath(compile.root_module.owner) },
);
}
try printIt(
roots_info_slc,
compile.root_module.import_table,
);
idx.* += 1;
}
}
};

fn extractBuildInformation(
Expand Down Expand Up @@ -1073,46 +1130,6 @@ fn extractBuildInformation(
run,
);

var root_imports: std.ArrayListUnmanaged(BuildConfig.NamePathPair) = .{};
var roots: std.ArrayListUnmanaged([]BuildConfig.NamePathPair) = .{};

var roots_info_slc = std.ArrayList(u8).init(gpa);
var root_idx: u32 = 0;

for (b.top_level_steps.values(), 0..) |tls, i| {
if (i != 0) try roots_info_slc.writer().writeByte('\n');
try roots_info_slc.writer().print(
"S: {s} - {s}\n",
.{ tls.step.name, tls.description },
);

for (tls.step.dependencies.items) |step| {
try roots_info.print(
&roots_info_slc,
&root_idx,
step.dependencies.items,
);
for (step.dependencies.items) |dep_step| {
const compile: *Step.Compile = dep_step.cast(Step.Compile) orelse continue;
var cli_named_modules = try copied_from_zig.CliNamedModules.init(gpa, &compile.root_module);
var dep_it = compile.root_module.iterateDependencies(compile, false);
while (dep_it.next()) |dep| {
if (!(dep.compile.? == compile)) continue; // !my_responsibility
if (cli_named_modules.modules.getIndex(dep.module)) |module_cli_index| {
const module_cli_name = cli_named_modules.names.keys()[module_cli_index];
if (dep.module.root_source_file) |lp| {
const src = lp.getPath2(dep.module.owner, step);
// std.log.debug("-M{s}={s}", .{ module_cli_name, src });
try root_imports.append(gpa, .{ .name = module_cli_name, .path = src });
}
}
}
try roots.append(gpa, try root_imports.toOwnedSlice(gpa));
root_imports.items.len = 0; // clearRetainingCapacity();
}
}
}

var include_dirs: std.StringArrayHashMapUnmanaged(void) = .{};
var packages: Packages = .{ .allocator = gpa };
defer packages.deinit();
Expand Down Expand Up @@ -1208,6 +1225,29 @@ fn extractBuildInformation(
available_options.map.putAssumeCapacityNoClobber(available_option.key_ptr.*, available_option.value_ptr.*);
}

// roots[]
var visited_steps: std.AutoArrayHashMapUnmanaged(*Step, void) = .{};
var unsorted_roots: std.ArrayListUnmanaged(roots_info.RootEntry) = .{};
var roots_info_slc = std.ArrayList(u8).init(gpa);
var root_idx: u32 = 0;

for (b.top_level_steps.values()) |tls| {
try roots_info.collect(
gpa,
&tls.step,
&visited_steps,
&unsorted_roots,
);
}

std.mem.sort(roots_info.RootEntry, unsorted_roots.items, build_root, roots_info.hasPrecedence);

var roots = try std.ArrayListUnmanaged(BuildConfig.RootEntry).initCapacity(gpa, unsorted_roots.items.len);
for (unsorted_roots.items) |item| {
roots.appendAssumeCapacity(.{ .name = item.step.name, .mods = item.mods });
try roots_info.print(&roots_info_slc, &root_idx, item.step);
}

const dir_path = std.fs.path.dirname(self_path) orelse unreachable;
const file_path = try std.fs.path.join(gpa, &.{ dir_path, "roots.txt" });
const file = try std.fs.cwd().createFile(file_path, .{});
Expand Down
4 changes: 2 additions & 2 deletions src/build_runner/BuildConfig.zig
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ const std = @import("std");

roots_info_file: []const u8,
deps_build_roots: []NamePathPair,
roots: [][]NamePathPair,
roots: []RootEntry,
packages: []NamePathPair,
include_dirs: []const []const u8,
top_level_steps: []const []const u8,
available_options: std.json.ArrayHashMap(AvailableOption),

pub const RootEntry = struct {
path: []const u8,
name: []const u8,
mods: []NamePathPair,
};
pub const NamePathPair = struct {
Expand Down
6 changes: 3 additions & 3 deletions src/features/hover.zig
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,9 +130,9 @@ fn hoverSymbolRecursive(
if (!(build_file.root_id < build_config.roots.len)) {
try def.writer().print("Current root_id > roots.len => defaulting to root_id 0\n\nModules:\n\n", .{});
build_file.root_id = 0;
} else try def.writer().print("Current root_id: {}\n\nModules:\n\n", .{build_file.root_id});
for (build_config.roots[build_file.root_id]) |entry| {
try def.writer().print(" * {s} @ {s}\n", .{ entry.name, entry.path });
} else try def.writer().print("root_id: {}, name: \"{s}\"\n\nModules:\n\n", .{ build_file.root_id, build_config.roots[build_file.root_id].name });
for (build_config.roots[build_file.root_id].mods) |mod| {
try def.writer().print(" * {s} @ {s}\n", .{ mod.name, mod.path });
}
try def.writer().print("\nSee [List of all roots]({s}#L{d})\n", .{ build_config.roots_info_file, 0 });
} else try def.writer().writeAll("build_runner reported NO (0) CompileSteps (roots)\n");
Expand Down

0 comments on commit 2576adb

Please sign in to comment.