如何使用 gnat 更改 Ada 库的符号可见性?

How to change symbol visibility of Ada libraries using gnat?

我在将程序移植到 Linux 时遇到问题,因为 Linux 默认具有 public 符号可见性。目前,我有一个可执行文件和一个 .so 共享对象库,它们都是用 Ada 编写的。他们共享一些文件,例如这些文件:

Common/my_program_generic.广告

generic package My_Program_Generic is
    Initialized : Boolean := False;

    procedure Initialize;
end My_Program_Generic;

Common/my_program_generic.adb

with Ada.Text_IO;

package body My_Program_Generic is
    procedure Initialize is
    begin
        Ada.Text_IO.Put_Line("Initialized: " & Initialized'Img);
        if not Initialized then
            Initialized := True;
            -- Do stuff
            Ada.Text_IO.Put_Line("Did stuff!");
        end if;
    end Initialize;
end My_Program_Generic;

Common/my_program.广告

with My_Program_Generic;
My_Program is new My_Program_Generic;

然后可执行文件和库都从单独的代码中调用 My_Program.Initialize。 输出(第一行和第二行是可执行文件,第三行是库):

Initialized: FALSE
Did stuff!
Initialized: TRUE

这里的问题是符号可见性是 public,所以看起来可执行文件运行这个函数并初始化所有东西,但是共享对象库使用可执行文件的 My_Program.Initialized(这是真的) 而不是它自己的(它是 False),无法初始化,然后使用未初始化的变量稍后崩溃。

我尝试使用 -fvisiblity=hidden 编译所有内容(从 makefile 和 gnat 项目文件 (.gpr)),这似乎正确地将它传递给了编译器(例如,它显示在命令中行 gcc -c -fPIC -g -m32 -fvisibility=hidden -gnatA my_file.adb),但它似乎没有什么不同,而且我找不到任何使用 gnat 控制可见性的文档。

我的 OS 是美分 OS 5.6。我无法升级到 Linux 的较新版本,但我可以将我的 GCC 或 gnat 版本升级到适用于 CentOS 5.6 的任何版本。我的 GCC/gnat 版本如下:

$ gcc --version
gcc (GCC) 4.1.2 20080704 (Red Hat 4.1.2-50)
...
$ gnatls -v
GNATLS 4.1.2 20080704 (Red Hat 4.1.2-50)
...

是的,我知道它说的是 Red Hat,但我使用的是 CentOS。 AFAIK 无论如何,它们彼此完全兼容。


可能解决我的问题所需的所有信息都在上面进行了全面解释,但这里是您可以用来在您的机器上重新创建我的二进制文件的其余代码、makefile 和 gpr 文件(为了更完整但更简单)插图)。

Library/my_library.广告

package My_Library is
    procedure Initialize_Library;
    pragma Export (DLL, Initialize_Library, "Initialize_Library");
end My_Library;

Library/my_library.adb

with Ada.Text_IO;
with My_Program;

package body My_Library is
    procedure Initialize_Library is
    begin
        Ada.Text_IO.Put_Line("Initializing Library...");
        My_Program.Initialize;
    end Initialize_Library;
end My_Library;

Library/dummy.广告

package Dummy is
end Dummy;

Library/my_library.gpr

project My_Library is
    for source_dirs use (".","../Common");
    for Library_Src_Dir use "include";
    for object_dir use "obj";
    for library_dir use "lib";
    for library_name use "my_library";
    for library_kind use "dynamic";
    for library_interface use ("dummy");
    for library_auto_init use "true;
    -- Compile 32-bit
    for library_options use ("-m32");
    package compiler is
        for default_switches ("Ada")
            use ("-g", "-m32", "-fvisibility=hidden");
    end compiler;

    for Source_Files use (
        "my_program_generic.ads",
        "my_program_generic.adb",
        "my_program.ads",
        "dummy.ads",
        "my_library.ads",
        "my_library.adb");
end My_Library;

Library/Makefile

GNATMAKE=gnatmake
LDFLAGS=-shared
TARGETBASE=libMy_Library.so
GNATMAKEFLAGS=--RTS=/usr/lib/gcc/i386-redhat-linux/4.1.2
TARGET=Debug/$(TARGETBASE)

# Phony target so make all will work
.PHONY: all
all: $(TARGET)

SRCS = \
    ../Common/my_program_generic.ads \
    ../Common/my_program_generic.adb \
    ../Common/my_program.adb \
    dummy.ads \
    my_library.ads \
    my_library.adb

CHOPPATH = chop
OBJPATH = obj
LIBPATH = lib

$(TARGET) : $(SRCS)
    $(GNATMAKE) -Pmy_library $(GNATMAKEFLAGS)
    mv $(LIBPATH)/$(TARGETBASE) $(TARGET)

# Phony target so make clean will work
.PHONY: clean
clean:
    rm -rf $(TARGET) $(CHOPPATH)/*.ads $(CHOPPATH)/*.adb $(OBJPATH)/*.s $(OBJPATH)/*.o $(OBJPATH)/*.ads $(OBJPATH)/*.adb *.s $(LIBPATH)/*.so $(LIBPATH)/*.ali

Exe/my_exe.adb

with Ada.Text_IO;
with My_Program;
with My_Library_Import;

procedure My_Exe is
begin
    Ada.Text_IO.Put_Line("Begin main program.");
    My_Program.Initialize;
    My_Library_Import.Initialize_Library;
end My_Exe;

Exe/my_library_import.广告

package My_Library_Import is
    procedure Initialize_Library;
private
    type External_Initialize_Library_Type is access procedure;
    pragma Convention (DLL_Stdcall, External_Initialize_Library_Type);
    External_Initialize_Library : External_Initialize_Library_Type := null;
end My_Library_Import;

Exe/my_library_import.adb

with Ada.Text_IO;
with Ada.Unchecked_Conversion;
with System;
with Interfaces.C;
with Interfaces.C.Strings;
use type System.Address;

package body My_Library_Import is
    Library_Handle : System.Address := System.Null_Address;
    Library_Name : String := "../Library/Debug/libMy_Library.so";

    -- Interface to libdl to load dynamically linked libraries

    function dlopen(
        File_Name : in Interfaces.C.Strings.Chars_Ptr;
        Flag      : in Integer) return System.Address;
    pragma Import (C, dlopen);

    function dlsym(
        Handle : in System.Address;
        Symbol : in Interfaces.C.Char_Array) return System.Address;
    pragma Import (C, dlsym);

    function dlerror return Interfaces.C.Strings.Chars_Ptr;
    pragma Import (C, dlerror);

    function External_Initialize_Library_Type_Import is new Ada.Unchecked_Conversion(
        System.Address, External_Initialize_Library_Type);

    procedure Initialize_Library is
        Temp_Name : Interfaces.C.Strings.Chars_Ptr;
    begin
        -- Load Library
        Temp_Name := Interfaces.C.Strings.New_Char_Array(Interfaces.C.To_C(Library_Name));
        Library_Handle := dlopen(Temp_Name, 16#101#);  -- RTLD_NOW (0x0001), RTLD_GLOBAL (0x0100)
        Interfaces.C.Strings.Free(Temp_Name);

        -- Check for Load Library failure (did we execute from the right place?)
        if (Library_Handle = System.Null_Address) then
            Ada.Text_IO.Put_Line("dlerror: " &
                Interfaces.C.Strings.Value(dlerror));
            return;
        end if;

        -- Get function access
        External_Initialize_Library := External_Initialize_Library_Type_Import(
            dlsym(Library_Handle, Interfaces.C.To_C("Initialize_Library")));

        -- Initialize library itself
        External_Initialize_Library.all;
    end Initialize_Library;
end My_Library_Import;

Exe/Makefile

CC=gcc
LD=g++
GNATCHOP=gnatchop
GNATMAKE=gnatmake
RC=windres

INCLUDE_PATH = -I.

LDFLAGS=-largs -ldl -lpthread -rdynamic -lstdc++
TARGET_FILE=my_exe
GNATMAKEFLAGS=--RTS=/usr/lib/gcc/i386-redhat-linux/4.1.2
TARGET_PATH=Debug
TARGET=$(TARGET_PATH)/$(TARGET_FILE)

# Phony target so make all will work
.PHONY: all
all : $(TARGET)

SRCS = \
    ../Common/my_program_generic.ads \
    ../Common/my_program_generic.adb \
    ../Common/my_program.adb \
    my_exe.adb \
    my_library_import.ads \
    my_library_import.adb

CHOPPATH = chop
OBJPATH = obj

$(TARGET) : $(SRCS)
    $(GNATCHOP) $^ $(CHOPPATH) -w -r
    rm -rf *.s
    $(GNATMAKE) -m32 -j3 -g -gnatwA -fvisibility=hidden -D $(OBJPATH) -k $(CHOPPATH)/*.adb $(LDFLAGS) $(GNATMAKEFLAGS)
    rm -rf b~$(TARGET_FILE).*
    mv $(TARGET_FILE) $(TARGET)

# Phony target so make clean will work
.PHONY: clean
clean:
    rm -rf $(TARGET) $(CHOPPATH)/*.ads $(CHOPPATH)/*.adb $(OBJPATH)/*.s $(OBJPATH)/*.o $(OBJPATH)/*.ads $(OBJPATH)/*.adb *.s

我没有为可执行文件 (Exe) 使用 gpr 文件。

使用./Debug/my_exe从"Exe"文件夹中执行程序,带有附加文件的完整输出如下:

$ ./Debug/my_exe
Begin main program.
Initialized: FALSE
Did Stuff!
Initializing Library...
Initialized: TRUE

"my_program_generic.ads" 中的任何内容都不会出现在目标文件中,因为它是通用包,所以我认为您无需担心。

我不知道你在做什么与我不同,因为你没有告诉我们你的构建过程是什么或者你使用的是什么版本的 OS/compiler。另外,我无法重现你的确切结果,因为你没有提供完整的演示程序。

我相信答案在于最近发布的 gprbuild 的一个未记录(但可取)的功能(我在 macOS Sierra 和 Debian 上使用了 GNAT GPL 2016 提供的功能杰西)。

我写了一个包含实例化器的库,

with My_Program_Generic;
package Actual is new My_Program_Generic;

一个不同的副本,当然也在主程序的关闭中,另一个包只包含在库中,

package In_Library with Elaborate_Body is
end In_Library;

with Actual;
with Ada.Text_IO;
package body In_Library is
begin
   Ada.Text_IO.Put_Line ("In_Library's elaboration");
   Actual.Initialize;
end In_Library;

这样做的目的是为了避免在库中泄露 Actual 的存在,否则在主程序的关闭中肯定会有两个版本。

我用这个 standalone GPR

构建了库
library project Build is
   for Library_Name use "keith";
   for Library_Kind use "dynamic";
   for Library_Dir use "lib";
   for Library_Src_Dir use "include";
   for Library_Interface use ("In_Library");
   for Object_Dir use ".build";
   for Source_Files use ("my_program_generic.ads",
                         "my_program_generic.adb",
                         "actual.ads",
                         "in_library.ads",
                         "in_library.adb");
end Build;

和(足够新的)gprbuild 识别出 Actual 不在 Library_Interface 中并转换它的符号,这是全球的,本地的!!!

"recent enough" 我的意思是不早于 GNAT GPL 2016 发布的版本。

您可以通过检查包含 Object_Lister 的部分的 $prefix/share/gprconfig/linker.xml 来获得用于实现此目的的方法的提示。例如,

<configuration>
  <targets>
    <target name="^i686.*-linux.*$" />
  </targets>
  <hosts>
    <host name="^i686.*-linux.*$" />
  </hosts>
  <config>
 for Object_Lister use ("nm", "-g");
 for Object_Lister_Matcher use " [TDRB] (.*)";

 package Linker is
    for Export_File_Format use "GNU";
    for Export_File_Switch use "-Wl,--version-script=";
 end Linker;
  </config>
</configuration>

将用于某些 Linux;看起来好像你在编译的接口单元上使用 nm -g 并将一些全局类型的符号复制到 GNU 格式的临时文件中,该文件通过 --version-script= 传递给 linker开关。

macOS 变体使用 -exported_symbols_list 开关以平面格式传递符号。


通常情况下,人们会使用带有 Externally_Built attribute

的 GPR 导入库
library project Keith is
   for Library_Name use "keith";
   for Library_Kind use "dynamic";
   for Library_Dir use "lib";
   for Library_Src_Dir use "include";
   for Externally_Built use "true";
end Keith;

但是 gprbuild 仍然知道相同的源单元在库项目和使用项目中并拒绝构建,让我 link 和

$ gnatmake -f \
  -aIlibrary/include -aOlibrary/lib \
  main.adb \
  -bargs -shared \
  -largs -Llibrary/lib -lkeith

一种解决方案是使用 renames 来更改哪些符号是 public。拿这个文件

Common/my_program.ads

with My_Program_Generic;
My_Program is new My_Program_Generic;

并且只为图书馆创建一个新副本,编辑如下:

Library/my_program_library_private.广告

 with My_Program_Generic;
 My_Program_Library_Private is new My_Program_Generic;

但是现在您引用 My_Program 的代码无法编译,因此创建一个新文件:

Library/my_program.广告

with My_Program_Library_Private;
package My_Program renames My_Program_Library_Private;

这使您可以在可执行文件中隐藏符号,同时避免更改代码的内容。现在 My_Program_Library_Private.Initialize 是一个 public 符号,但 My_Program.Initialize 不是。

之前:

$ nm -g Debug/libMy_Library.so
000010fc T Initialize_Library
...
00001438 T my_program__initialize

之后:

$ nm -g Debug/libMy_Library.so
0000112c T Initialize_Library
...
000011b0 T my_program_library_private__initialize

my_program__*甚至没有在符号中列出。

现在的输出是:

$ ./Debug/my_exe
Begin main program.
Initialized: FALSE
Did Stuff!
Initializing Library...
Initialized: FALSE
Did Stuff!

我的雇主终于能够升级到新的(呃)Linux 计算机,将我们的 GCC 版本从 4.1.2 20080704 (Red Hat 4.1.2-50) 升级到 4.4.7 20120313 (Red Hat 4.4.7-18)

至少从这个新版本 (4.4.7) 开始,这个问题在 gnat/gcc 的新版本中并不像@BrianDrummond 在问题评论中预测的那样严重。只有封装规范中的符号才会被制作 public/global,即使声明为 private。仅出现在包体中的符号被制成 private/local.

但是,仍然没有办法显式地制作符号private/local。

这个新问题在当前最新版本 GCC 8.2 中仍然存在。

我们找到了另一个解决方法,即将 dlopen 调用标志从 RTLD_GLOBAL 更改为 RTLD_LOCAL:

Library_Handle := dlopen(Temp_Name, 16#101#);  -- RTLD_NOW (0x0001), RTLD_GLOBAL (0x0100)

Library_Handle := dlopen(Temp_Name, 16#1#);  -- RTLD_NOW (0x0001), RTLD_LOCAL (0x0000)

但是,以这种方式,每次加载库时都需要完整的文件路径和名称(或将路径放在您的 LD_LIBRARY_PATH 环境变量中),以及导出的 NONE符号将立即可见,因此您需要调用 dlsym 来获取您需要使用的任何符号,例如问题所在的行:

-- Get function access
External_Initialize_Library := External_Initialize_Library_Type_Import(
    dlsym(Library_Handle, Interfaces.C.To_C("Initialize_Library")));

这样,您至少可以管理哪些符号是 "visible" -- 通过让其中的 none 实际上可见,并明确获取您需要的符号。