From 29fd727b79682a0f3e8ad7340cf86db989b9109e Mon Sep 17 00:00:00 2001 From: emekoi Date: Thu, 30 May 2019 20:03:56 -0500 Subject: [PATCH 1/5] fixed windows dynamic library loading and added loading for darwin --- lib/std/c/darwin.zig | 4 ++ lib/std/dynamic_library.zig | 90 ++++++++++++++++++++++++++++++++----- lib/std/os/bits/darwin.zig | 14 ++++++ test/standalone.zig | 9 ++-- 4 files changed, 103 insertions(+), 14 deletions(-) diff --git a/lib/std/c/darwin.zig b/lib/std/c/darwin.zig index 4d40e8aee5..eea8024969 100644 --- a/lib/std/c/darwin.zig +++ b/lib/std/c/darwin.zig @@ -128,3 +128,7 @@ pub const pthread_attr_t = extern struct { __sig: c_long, __opaque: [56]u8, }; + +pub extern "c" fn dlopen(path: [*]const u8, mode: c_int) ?*c_void; +pub extern "c" fn dlclose(handle: *c_void) c_int; +pub extern "c" fn dlsym(handle: ?*c_void, symbol: [*]const u8) ?*c_void; diff --git a/lib/std/dynamic_library.zig b/lib/std/dynamic_library.zig index dbebb20b27..c587d35a1f 100644 --- a/lib/std/dynamic_library.zig +++ b/lib/std/dynamic_library.zig @@ -7,11 +7,13 @@ const assert = std.debug.assert; const testing = std.testing; const elf = std.elf; const windows = std.os.windows; +const system = std.os.system; const maxInt = std.math.maxInt; pub const DynLib = switch (builtin.os) { - .linux => LinuxDynLib, + .linux => if (builtin.link_libc) DlDynlib else LinuxDynLib, .windows => WindowsDynLib, + .macosx, .tvos, .watchos, .ios => DlDynlib, else => void, }; @@ -99,12 +101,14 @@ pub fn linkmap_iterator(phdrs: []elf.Phdr) !LinkMap.Iterator { } pub const LinuxDynLib = struct { + pub const Error = ElfLib.Error; + elf_lib: ElfLib, fd: i32, memory: []align(mem.page_size) u8, /// Trusts the file - pub fn open(path: []const u8) !DynLib { + pub fn open(path: []const u8) !LinuxDynLib { const fd = try os.open(path, 0, os.O_RDONLY | os.O_CLOEXEC); errdefer os.close(fd); @@ -121,26 +125,42 @@ pub const LinuxDynLib = struct { ); errdefer os.munmap(bytes); - return DynLib{ + return LinuxDynLib{ .elf_lib = try ElfLib.init(bytes), .fd = fd, .memory = bytes, }; } - pub fn close(self: *DynLib) void { + pub fn close(self: *LinuxDynLib) void { os.munmap(self.memory); os.close(self.fd); self.* = undefined; } - pub fn lookup(self: *DynLib, name: []const u8) ?usize { - return self.elf_lib.lookup("", name); + pub fn lookup(self: *LinuxDynLib, comptime T: type, name: []const u8) ?T { + if (self.elf_lib.lookup("", name)) |symbol| { + return @ptrCast(T, symbol); + } else { + return null; + } } }; pub const ElfLib = struct { strings: [*:0]u8, + + pub const Error = error{ + NotElfFile, + NotDynamicLibrary, + MissingDynamicLinkingInformation, + BaseNotFound, + ElfStringSectionNotFound, + ElfSymSectionNotFound, + ElfHashTableNotFound, + }; + + strings: [*]u8, syms: [*]elf.Sym, hashtab: [*]os.Elf_Symndx, versym: ?[*]u16, @@ -245,11 +265,12 @@ fn checkver(def_arg: *elf.Verdef, vsym_arg: i32, vername: []const u8, strings: [ } pub const WindowsDynLib = struct { + pub const Error = error{FileNotFound}; + dll: windows.HMODULE, pub fn open(path: []const u8) !WindowsDynLib { const wpath = try windows.sliceToPrefixedFileW(path); - return WindowsDynLib{ .dll = try windows.LoadLibraryW(&wpath), }; @@ -260,8 +281,57 @@ pub const WindowsDynLib = struct { self.* = undefined; } - pub fn lookup(self: *WindowsDynLib, name: []const u8) ?usize { - return @ptrToInt(windows.kernel32.GetProcAddress(self.dll, name.ptr)); + pub fn lookupC(self: *WindowsDynLib, comptime T: type, name: [*:0]const u8) ?T { + if (windows.kernel32.GetProcAddress(self.dll, name)) |addr| { + return @ptrCast(T, addr); + } else { + return null; + } + } + + pub fn lookup(self: *DlDynlib, comptime T: type, comptime max_name_len: usize, name: []const u8) ?T { + const c_name: [max_name_len]u8 = undefined; + mem.copy(&c_name, name); + c_name[name.len] = 0; + return self.lookupC(T, &c_name); + } +}; + +pub const DlDynlib = struct { + pub const Error = error{FileNotFound}; + + handle: *c_void, + + pub fn open(path: []const u8) !DlDynlib { + if (!builtin.link_libc and !os.darwin.is_the_target) { + @compileError("DlDynlib requires libc"); + } + + return DlDynlib{ + .handle = system.dlopen(path.ptr, system.RTLD_LAZY) orelse { + return error.FileNotFound; + }, + }; + } + + pub fn close(self: *DlDynlib) void { + _ = system.dlclose(self.handle); + self.* = undefined; + } + + pub fn lookupC(self: *DlDynlib, comptime T: type, name: [*:0]const u8) ?T { + if (system.dlsym(self.handle, name)) |symbol| { + return @ptrCast(T, symbol); + } else { + return null; + } + } + + pub fn lookup(self: *DlDynlib, comptime T: type, comptime max_name_len: usize, name: []const u8) ?T { + const c_name: [max_name_len]u8 = undefined; + mem.copy(&c_name, name); + c_name[name.len] = 0; + return self.lookupC(T, &c_name); } }; @@ -269,6 +339,7 @@ test "dynamic_library" { const libname = switch (builtin.os) { .linux => "invalid_so.so", .windows => "invalid_dll.dll", + .macosx, .tvos, .watchos, .ios => "invalid_dylib.dylib", else => return, }; @@ -276,5 +347,4 @@ test "dynamic_library" { testing.expect(err == error.FileNotFound); return; }; - @panic("Expected error from function"); } diff --git a/lib/std/os/bits/darwin.zig b/lib/std/os/bits/darwin.zig index 26c9e7ec9b..d4340443e5 100644 --- a/lib/std/os/bits/darwin.zig +++ b/lib/std/os/bits/darwin.zig @@ -1183,6 +1183,7 @@ pub fn S_ISSOCK(m: u32) bool { pub fn S_IWHT(m: u32) bool { return m & S_IFMT == S_IFWHT; } + pub const HOST_NAME_MAX = 72; pub const AT_FDCWD = -2; @@ -1209,3 +1210,16 @@ pub const addrinfo = extern struct { addr: ?*sockaddr, next: ?*addrinfo, }; + +pub const RTLD_LAZY = 0x1; +pub const RTLD_NOW = 0x2; +pub const RTLD_LOCAL = 0x4; +pub const RTLD_GLOBAL = 0x8; +pub const RTLD_NOLOAD = 0x10; +pub const RTLD_NODELETE = 0x80; +pub const RTLD_FIRST = 0x100; + +pub const RTLD_NEXT = @intToPtr(*c_void, ~maxInt(usize)); +pub const RTLD_DEFAULT = @intToPtr(*c_void, ~maxInt(usize) - 1); +pub const RTLD_SELF = @intToPtr(*c_void, ~maxInt(usize) - 2); +pub const RTLD_MAIN_ONLY = @intToPtr(*c_void, ~maxInt(usize) - 4); diff --git a/test/standalone.zig b/test/standalone.zig index f3a1f735da..7abe8fa229 100644 --- a/test/standalone.zig +++ b/test/standalone.zig @@ -19,10 +19,11 @@ pub fn addCases(cases: *tests.StandaloneContext) void { cases.addBuildFile("test/standalone/use_alias/build.zig"); cases.addBuildFile("test/standalone/brace_expansion/build.zig"); cases.addBuildFile("test/standalone/empty_env/build.zig"); - if (builtin.os == builtin.Os.linux) { - // TODO hook up the DynLib API for windows using LoadLibraryA - // TODO figure out how to make this work on darwin - probably libSystem has dlopen/dlsym in it - cases.addBuildFile("test/standalone/load_dynamic_library/build.zig"); + switch (builtin.os) { + .linux, .windows, .macosx, .tvos, .watchos, .ios => { + cases.addBuildFile("test/standalone/load_dynamic_library/build.zig"); + }, + else => {}, } if (builtin.arch == builtin.Arch.x86_64) { // TODO add C ABI support for other architectures From fd6b7b160d1fddf967177cf26704908aa7bf5f12 Mon Sep 17 00:00:00 2001 From: Andrew Kelley Date: Tue, 10 Dec 2019 12:28:28 -0500 Subject: [PATCH 2/5] improve dynamic library API --- lib/std/c.zig | 4 +++ lib/std/c/darwin.zig | 4 --- lib/std/c/linux.zig | 7 +++++ lib/std/dynamic_library.zig | 56 ++++++++++++++++++------------------- src/ir.cpp | 1 + test/standalone.zig | 13 +++------ 6 files changed, 44 insertions(+), 41 deletions(-) diff --git a/lib/std/c.zig b/lib/std/c.zig index 9e70ff988d..c42519836e 100644 --- a/lib/std/c.zig +++ b/lib/std/c.zig @@ -226,3 +226,7 @@ pub extern "c" fn pthread_cond_destroy(cond: *pthread_cond_t) c_int; pub const pthread_t = *@OpaqueType(); pub const FILE = @OpaqueType(); + +pub extern "c" fn dlopen(path: [*:0]const u8, mode: c_int) ?*c_void; +pub extern "c" fn dlclose(handle: *c_void) c_int; +pub extern "c" fn dlsym(handle: ?*c_void, symbol: [*:0]const u8) ?*c_void; diff --git a/lib/std/c/darwin.zig b/lib/std/c/darwin.zig index eea8024969..4d40e8aee5 100644 --- a/lib/std/c/darwin.zig +++ b/lib/std/c/darwin.zig @@ -128,7 +128,3 @@ pub const pthread_attr_t = extern struct { __sig: c_long, __opaque: [56]u8, }; - -pub extern "c" fn dlopen(path: [*]const u8, mode: c_int) ?*c_void; -pub extern "c" fn dlclose(handle: *c_void) c_int; -pub extern "c" fn dlsym(handle: ?*c_void, symbol: [*]const u8) ?*c_void; diff --git a/lib/std/c/linux.zig b/lib/std/c/linux.zig index 07fdceec9a..5b45b49332 100644 --- a/lib/std/c/linux.zig +++ b/lib/std/c/linux.zig @@ -98,3 +98,10 @@ const __SIZEOF_PTHREAD_MUTEX_T = if (builtin.os == .fuchsia) 40 else switch (bui }, else => unreachable, }; + +pub const RTLD_LAZY = 1; +pub const RTLD_NOW = 2; +pub const RTLD_NOLOAD = 4; +pub const RTLD_NODELETE = 4096; +pub const RTLD_GLOBAL = 256; +pub const RTLD_LOCAL = 0; diff --git a/lib/std/dynamic_library.zig b/lib/std/dynamic_library.zig index c587d35a1f..ebde25649f 100644 --- a/lib/std/dynamic_library.zig +++ b/lib/std/dynamic_library.zig @@ -132,6 +132,10 @@ pub const LinuxDynLib = struct { }; } + pub fn openC(path_c: [*:0]const u8) !LinuxDynLib { + return open(mem.toSlice(u8, path_c)); + } + pub fn close(self: *LinuxDynLib) void { os.munmap(self.memory); os.close(self.fd); @@ -148,8 +152,6 @@ pub const LinuxDynLib = struct { }; pub const ElfLib = struct { - strings: [*:0]u8, - pub const Error = error{ NotElfFile, NotDynamicLibrary, @@ -160,7 +162,7 @@ pub const ElfLib = struct { ElfHashTableNotFound, }; - strings: [*]u8, + strings: [*:0]u8, syms: [*]elf.Sym, hashtab: [*]os.Elf_Symndx, versym: ?[*]u16, @@ -270,9 +272,18 @@ pub const WindowsDynLib = struct { dll: windows.HMODULE, pub fn open(path: []const u8) !WindowsDynLib { - const wpath = try windows.sliceToPrefixedFileW(path); + const path_w = try windows.sliceToPrefixedFileW(path); + return openW(&path_w); + } + + pub fn openC(path_c: [*:0]const u8) !WindowsDynLib { + const path_w = try windows.cStrToPrefixedFileW(path); + return openW(&path_w); + } + + pub fn openW(path_w: [*:0]const u16) !WindowsDynLib { return WindowsDynLib{ - .dll = try windows.LoadLibraryW(&wpath), + .dll = try windows.LoadLibraryW(path_w), }; } @@ -281,20 +292,13 @@ pub const WindowsDynLib = struct { self.* = undefined; } - pub fn lookupC(self: *WindowsDynLib, comptime T: type, name: [*:0]const u8) ?T { - if (windows.kernel32.GetProcAddress(self.dll, name)) |addr| { + pub fn lookup(self: *DlDynlib, comptime T: type, name: [:0]const u8) ?T { + if (windows.kernel32.GetProcAddress(self.dll, name.ptr)) |addr| { return @ptrCast(T, addr); } else { return null; } } - - pub fn lookup(self: *DlDynlib, comptime T: type, comptime max_name_len: usize, name: []const u8) ?T { - const c_name: [max_name_len]u8 = undefined; - mem.copy(&c_name, name); - c_name[name.len] = 0; - return self.lookupC(T, &c_name); - } }; pub const DlDynlib = struct { @@ -303,12 +307,13 @@ pub const DlDynlib = struct { handle: *c_void, pub fn open(path: []const u8) !DlDynlib { - if (!builtin.link_libc and !os.darwin.is_the_target) { - @compileError("DlDynlib requires libc"); - } + const path_c = try os.toPosixPath(path); + return openC(&path_c); + } + pub fn openC(path_c: [*:0]const u8) !DlDynlib { return DlDynlib{ - .handle = system.dlopen(path.ptr, system.RTLD_LAZY) orelse { + .handle = system.dlopen(path_c, system.RTLD_LAZY) orelse { return error.FileNotFound; }, }; @@ -319,20 +324,15 @@ pub const DlDynlib = struct { self.* = undefined; } - pub fn lookupC(self: *DlDynlib, comptime T: type, name: [*:0]const u8) ?T { - if (system.dlsym(self.handle, name)) |symbol| { + pub fn lookup(self: *DlDynlib, comptime T: type, name: [*:0]const u8) ?T { + // dlsym (and other dl-functions) secretly take shadow parameter - return address on stack + // https://gcc.gnu.org/bugzilla/show_bug.cgi?id=66826 + if (@call(.{ .modifier = .never_tail }, system.dlsym, .{ self.handle, name.ptr })) |symbol| { return @ptrCast(T, symbol); } else { return null; } } - - pub fn lookup(self: *DlDynlib, comptime T: type, comptime max_name_len: usize, name: []const u8) ?T { - const c_name: [max_name_len]u8 = undefined; - mem.copy(&c_name, name); - c_name[name.len] = 0; - return self.lookupC(T, &c_name); - } }; test "dynamic_library" { @@ -340,7 +340,7 @@ test "dynamic_library" { .linux => "invalid_so.so", .windows => "invalid_dll.dll", .macosx, .tvos, .watchos, .ios => "invalid_dylib.dylib", - else => return, + else => return error.SkipZigTest, }; const dynlib = DynLib.open(libname) catch |err| { diff --git a/src/ir.cpp b/src/ir.cpp index 5a15b64549..8b588b5dee 100644 --- a/src/ir.cpp +++ b/src/ir.cpp @@ -6561,6 +6561,7 @@ static IrInstruction *ir_gen_prefix_op_id(IrBuilder *irb, Scope *scope, AstNode } static IrInstruction *ir_expr_wrap(IrBuilder *irb, Scope *scope, IrInstruction *inst, ResultLoc *result_loc) { + if (inst == irb->codegen->invalid_instruction) return inst; ir_build_end_expr(irb, scope, inst->source_node, inst, result_loc); return inst; } diff --git a/test/standalone.zig b/test/standalone.zig index 7abe8fa229..2c5b9c790e 100644 --- a/test/standalone.zig +++ b/test/standalone.zig @@ -1,6 +1,5 @@ +const std = @import("std"); const tests = @import("tests.zig"); -const builtin = @import("builtin"); -const is_windows = builtin.os == builtin.Os.windows; pub fn addCases(cases: *tests.StandaloneContext) void { cases.add("test/standalone/hello_world/hello.zig"); @@ -19,14 +18,10 @@ pub fn addCases(cases: *tests.StandaloneContext) void { cases.addBuildFile("test/standalone/use_alias/build.zig"); cases.addBuildFile("test/standalone/brace_expansion/build.zig"); cases.addBuildFile("test/standalone/empty_env/build.zig"); - switch (builtin.os) { - .linux, .windows, .macosx, .tvos, .watchos, .ios => { - cases.addBuildFile("test/standalone/load_dynamic_library/build.zig"); - }, - else => {}, + if (std.Target.current.getOs() != .wasi) { + cases.addBuildFile("test/standalone/load_dynamic_library/build.zig"); } - - if (builtin.arch == builtin.Arch.x86_64) { // TODO add C ABI support for other architectures + if (std.Target.current.getArch() == .x86_64) { // TODO add C ABI support for other architectures cases.addBuildFile("test/stage1/c_abi/build.zig"); } } From 80882bda59427077c141791178b5680fc346eea0 Mon Sep 17 00:00:00 2001 From: Andrew Kelley Date: Tue, 10 Dec 2019 12:48:10 -0500 Subject: [PATCH 3/5] load dynamic library test: update API usage code --- lib/std/dynamic_library.zig | 2 +- test/standalone/load_dynamic_library/main.zig | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/lib/std/dynamic_library.zig b/lib/std/dynamic_library.zig index ebde25649f..154858586c 100644 --- a/lib/std/dynamic_library.zig +++ b/lib/std/dynamic_library.zig @@ -144,7 +144,7 @@ pub const LinuxDynLib = struct { pub fn lookup(self: *LinuxDynLib, comptime T: type, name: []const u8) ?T { if (self.elf_lib.lookup("", name)) |symbol| { - return @ptrCast(T, symbol); + return @intToPtr(T, symbol); } else { return null; } diff --git a/test/standalone/load_dynamic_library/main.zig b/test/standalone/load_dynamic_library/main.zig index a222f5b315..d1cba72db5 100644 --- a/test/standalone/load_dynamic_library/main.zig +++ b/test/standalone/load_dynamic_library/main.zig @@ -9,8 +9,7 @@ pub fn main() !void { var lib = try std.DynLib.open(dynlib_name); defer lib.close(); - const addr = lib.lookup("add") orelse return error.SymbolNotFound; - const addFn = @intToPtr(extern fn (i32, i32) i32, addr); + const addFn = lib.lookup(extern fn (i32, i32) i32, "add") orelse return error.SymbolNotFound; const result = addFn(12, 34); std.debug.assert(result == 46); From 3ef8460d0646dbf0e762cbd7e0728fc2026d2001 Mon Sep 17 00:00:00 2001 From: Andrew Kelley Date: Tue, 10 Dec 2019 12:56:05 -0500 Subject: [PATCH 4/5] fix load dynamic library API when linking libc --- lib/std/dynamic_library.zig | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/std/dynamic_library.zig b/lib/std/dynamic_library.zig index 154858586c..347491a44c 100644 --- a/lib/std/dynamic_library.zig +++ b/lib/std/dynamic_library.zig @@ -142,7 +142,7 @@ pub const LinuxDynLib = struct { self.* = undefined; } - pub fn lookup(self: *LinuxDynLib, comptime T: type, name: []const u8) ?T { + pub fn lookup(self: *LinuxDynLib, comptime T: type, name: [:0]const u8) ?T { if (self.elf_lib.lookup("", name)) |symbol| { return @intToPtr(T, symbol); } else { @@ -292,7 +292,7 @@ pub const WindowsDynLib = struct { self.* = undefined; } - pub fn lookup(self: *DlDynlib, comptime T: type, name: [:0]const u8) ?T { + pub fn lookup(self: *WindowsDynLib, comptime T: type, name: [:0]const u8) ?T { if (windows.kernel32.GetProcAddress(self.dll, name.ptr)) |addr| { return @ptrCast(T, addr); } else { @@ -324,7 +324,7 @@ pub const DlDynlib = struct { self.* = undefined; } - pub fn lookup(self: *DlDynlib, comptime T: type, name: [*:0]const u8) ?T { + pub fn lookup(self: *DlDynlib, comptime T: type, name: [:0]const u8) ?T { // dlsym (and other dl-functions) secretly take shadow parameter - return address on stack // https://gcc.gnu.org/bugzilla/show_bug.cgi?id=66826 if (@call(.{ .modifier = .never_tail }, system.dlsym, .{ self.handle, name.ptr })) |symbol| { From fdc31321268214fbb2b0832b0d269cea56639e98 Mon Sep 17 00:00:00 2001 From: Andrew Kelley Date: Tue, 10 Dec 2019 13:21:37 -0500 Subject: [PATCH 5/5] fix windows dynamic lib loading test --- lib/std/dynamic_library.zig | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/std/dynamic_library.zig b/lib/std/dynamic_library.zig index 347491a44c..2132f03bd0 100644 --- a/lib/std/dynamic_library.zig +++ b/lib/std/dynamic_library.zig @@ -283,7 +283,8 @@ pub const WindowsDynLib = struct { pub fn openW(path_w: [*:0]const u16) !WindowsDynLib { return WindowsDynLib{ - .dll = try windows.LoadLibraryW(path_w), + // + 4 to skip over the \??\ + .dll = try windows.LoadLibraryW(path_w + 4), }; }