Skip to content

Improvements for builtin functions #2304

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

Merged
Techatrix merged 3 commits into from
May 14, 2025
Merged

Improvements for builtin functions #2304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
27ab766
Resolve `@Type` for primitive types
FnControlOption May 11, 2025
a17833e
Resolve argument types for builtin function calls
FnControlOption May 11, 2025
4350e6a
Use WASI preopens to lookup Zig lib directory for analysis tests
FnControlOption May 11, 2025
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 src/Server.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1380,7 +1380,7 @@ fn resolveConfiguration(

if (config.zig_lib_path) |zig_lib_path| blk: {
if (zig_builtin.target.os.tag == .wasi) {
std.log.warn("The 'zig_lib_path' config option is ignored on WASI in favor of preopens.", .{});
log.warn("The 'zig_lib_path' config option is ignored on WASI in favor of preopens.", .{});
break :blk;
}
if (std.fs.openDirAbsolute(zig_lib_path, .{})) |zig_lib_dir| {
Expand Down Expand Up @@ -1409,7 +1409,7 @@ fn resolveConfiguration(

if (config.global_cache_path) |global_cache_path| blk: {
if (zig_builtin.target.os.tag == .wasi) {
std.log.warn("The 'global_cache_path' config option is ignored on WASI in favor of preopens.", .{});
log.warn("The 'global_cache_path' config option is ignored on WASI in favor of preopens.", .{});
break :blk;
}
if (std.fs.cwd().makeOpenPath(global_cache_path, .{})) |global_cache_dir| {
Expand Down
104 changes: 104 additions & 0 deletions src/analysis.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2123,6 +2123,26 @@ fn resolveTypeOfNodeUncached(analyser: *Analyser, node_handle: NodeWithHandle) e
return analyser.instanceStdBuiltinType("Type");
}

const type_map: std.StaticStringMap(InternPool.Index) = .initComptime(.{
.{ "type", .type_type },
.{ "void", .void_type },
.{ "bool", .bool_type },
.{ "noreturn", .noreturn_type },
.{ "comptime_float", .comptime_float_type },
.{ "comptime_int", .comptime_int_type },
.{ "undefined", .undefined_type },
.{ "null", .null_type },
.{ "enum_literal", .enum_literal_type },
});
if (std.mem.eql(u8, call_name, "@Type")) {
if (params.len != 1) return null;
if (tree.nodeTag(params[0]) != .enum_literal) return null;
const name_token = tree.nodeMainToken(params[0]);
const name = offsets.identifierTokenToNameSlice(tree, name_token);
const ip_index = type_map.get(name) orelse return null;
return Type.fromIP(analyser, .type_type, ip_index);
}

if (std.mem.eql(u8, call_name, "@import")) {
if (params.len == 0) return null;
const import_param = params[0];
Expand Down Expand Up @@ -5612,6 +5632,90 @@ pub fn resolveExpressionTypeFromAncestors(
const ty = try analyser.resolveTypeOfNode(.of(params[0], handle)) orelse return null;
return ty.instanceTypeVal(analyser);
}

if (std.mem.eql(u8, call_name, "@branchHint")) {
if (params.len == 0) return null;
if (params[0] != node) return null;
return analyser.instanceStdBuiltinType("BranchHint");
}

if (std.mem.eql(u8, call_name, "@atomicLoad")) {
if (params.len <= 2) return null;
if (params[2] != node) return null;
return analyser.instanceStdBuiltinType("AtomicOrder");
}

if (std.mem.eql(u8, call_name, "@atomicRmw")) {
if (params.len > 2 and params[2] == node)
return analyser.instanceStdBuiltinType("AtomicRmwOp");
if (params.len > 4 and params[4] == node)
return analyser.instanceStdBuiltinType("AtomicOrder");
return null;
}

if (std.mem.eql(u8, call_name, "@atomicStore")) {
if (params.len <= 3) return null;
if (params[3] != node) return null;
return analyser.instanceStdBuiltinType("AtomicOrder");
}

if (std.mem.eql(u8, call_name, "@cmpxchgStrong")) {
if (params.len > 4 and params[4] == node)
return analyser.instanceStdBuiltinType("AtomicOrder");
if (params.len > 5 and params[5] == node)
return analyser.instanceStdBuiltinType("AtomicOrder");
return null;
}

if (std.mem.eql(u8, call_name, "@cmpxchgWeak")) {
if (params.len > 4 and params[4] == node)
return analyser.instanceStdBuiltinType("AtomicOrder");
if (params.len > 5 and params[5] == node)
return analyser.instanceStdBuiltinType("AtomicOrder");
return null;
}

if (std.mem.eql(u8, call_name, "@call")) {
if (params.len == 0) return null;
if (params[0] != node) return null;
return analyser.instanceStdBuiltinType("CallModifier");
}

if (std.mem.eql(u8, call_name, "@export")) {
if (params.len <= 1) return null;
if (params[1] != node) return null;
return analyser.instanceStdBuiltinType("ExportOptions");
}

if (std.mem.eql(u8, call_name, "@extern")) {
if (params.len <= 1) return null;
if (params[1] != node) return null;
return analyser.instanceStdBuiltinType("ExternOptions");
}

if (std.mem.eql(u8, call_name, "@prefetch")) {
if (params.len <= 1) return null;
if (params[1] != node) return null;
return analyser.instanceStdBuiltinType("PrefetchOptions");
}

if (std.mem.eql(u8, call_name, "@reduce")) {
if (params.len == 0) return null;
if (params[0] != node) return null;
return analyser.instanceStdBuiltinType("ReduceOp");
}

if (std.mem.eql(u8, call_name, "@setFloatMode")) {
if (params.len == 0) return null;
if (params[0] != node) return null;
return analyser.instanceStdBuiltinType("FloatMode");
}

if (std.mem.eql(u8, call_name, "@Type")) {
if (params.len == 0) return null;
if (params[0] != node) return null;
return analyser.instanceStdBuiltinType("Type");
}
},

.@"orelse" => {
Expand Down
51 changes: 51 additions & 0 deletions tests/analysis/builtins.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,58 @@ const panic = @panic("foo");
const trap = @trap();
// ^^^^ (noreturn)()

const type_type: @Type(.type) = i32;
// ^^^^^^^^^ (type)()
const type_void: @Type(.void) = {};
// ^^^^^^^^^ (void)()
const type_bool: @Type(.bool) = false;
// ^^^^^^^^^ (bool)()
const type_noreturn: @Type(.noreturn) = @panic("foo");
// ^^^^^^^^^^^^^ (noreturn)()
const type_comptime_float: @Type(.comptime_float) = 3.14;
// ^^^^^^^^^^^^^^^^^^^ (comptime_float)()
const type_comptime_int: @Type(.comptime_int) = 42;
// ^^^^^^^^^^^^^^^^^ (comptime_int)()
const type_undefined: @Type(.undefined) = undefined;
// ^^^^^^^^^^^^^^ (@TypeOf(undefined))()
const type_null: @Type(.null) = null;
// ^^^^^^^^^ (@TypeOf(null))()
const type_enum_literal: @Type(.enum_literal) = .foo;
// ^^^^^^^^^^^^^^^^^ (@Type(.enum_literal))()

comptime {
// Use @compileLog to verify the expected type with the compiler
// @compileLog(vector_builtin_13);
}

fn builtin_calls() void {
@branchHint(.none);
// ^^^^^ (BranchHint)()
@atomicLoad(undefined, undefined, .unordered);
// ^^^^^^^^^^ (AtomicOrder)()
@atomicRmw(undefined, undefined, .Xchg, undefined, .unordered);
// ^^^^^ (AtomicRmwOp)()
// ^^^^^^^^^^ (AtomicOrder)()
@atomicStore(undefined, undefined, undefined, .unordered);
// ^^^^^^^^^^ (AtomicOrder)()
@cmpxchgStrong(undefined, undefined, undefined, undefined, .unordered, .unordered);
// ^^^^^^^^^^ (AtomicOrder)()
// ^^^^^^^^^^ (AtomicOrder)()
@cmpxchgWeak(undefined, undefined, undefined, undefined, .unordered, .unordered);
// ^^^^^^^^^^ (AtomicOrder)()
// ^^^^^^^^^^ (AtomicOrder)()
@call(.always_inline, undefined, undefined);
// ^^^^^^^^^^^^^^ (CallModifier)()
@export(undefined, .{ .name = undefined });
// ^^^^^ ([]const u8)()
@extern(undefined, .{ .name = undefined });
// ^^^^^ ([]const u8)()
@prefetch(undefined, .{ .locality = 3 });
// ^^^^^^^^^ (u2)()
@reduce(.And, undefined);
// ^^^^ (ReduceOp)()
@setFloatMode(.strict);
// ^^^^^^^ (FloatMode)()
@Type(.type);
// ^^^^^ (void)()
}
15 changes: 15 additions & 0 deletions tests/analysis_check.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ pub fn main() Error!void {
};
config.zig_exe_path = try arena.dupe(u8, zig_exe_path);
} else if (std.mem.eql(u8, arg, "--zig-lib-path")) {
std.debug.assert(builtin.target.os.tag != .wasi);
const zig_lib_path = arg_it.next() orelse {
std.log.err("expected argument after '--zig-lib-path'.", .{});
std.process.exit(1);
Expand All @@ -83,6 +84,20 @@ pub fn main() Error!void {
}
}

if (builtin.target.os.tag == .wasi) {
const wasi_preopens = try std.fs.wasi.preopensAlloc(gpa);
defer {
for (wasi_preopens.names[3..]) |name| gpa.free(name);
gpa.free(wasi_preopens.names);
}

const zig_lib_dir_fd = wasi_preopens.find("/lib") orelse {
std.log.err("failed to resolve '/lib' WASI preopen", .{});
std.process.exit(1);
};
config.zig_lib_dir = .{ .handle = .{ .fd = zig_lib_dir_fd }, .path = "/lib" };
}

var thread_pool: if (builtin.single_threaded) void else std.Thread.Pool = undefined;
if (builtin.single_threaded) {
thread_pool = {};
Expand Down