2404d,d符号表示dip1045

原文

符号表示

概述

符号是本地语言功能的最终表示.在编译器或语言级别,不准确表示它们可能会导致链接失败.这些问题可能是令人沮丧的重要来源,甚至可能导致人们认为无法实现方法.

此DIP的目的是解决和纠正各种跨平台和目标的常见共享库链接错误.

理由

对不熟悉链接器的人来说,理解和解决这些错误可能令人生畏,一般会导致寻求帮助.

仅限于静态库和独立可执行文件使用语言时,D中的很大一部分符号的表示问题仍模糊不清.但是,此配置并不能满足所有用户的不同需求和偏好.

需要更灵活的如涉及共享库的二进制配置.

把插件整合到D中,为其他语言创建D插件或开发可替换二进制文件等用例,都说明了涉及D的共享库有益的场景.为了确保D的一致性和易用性,增强语言的符号表示方法至关重要.

主要焦点应放在模块级别.默认,了解模块是在当前二进制文件的内部还是外部,是解决许多链接器问题的关键.这些基本知识为进一步改进和修改奠定了基础.

前期工作

2016年,BenjaminThaut在DConf上发表了题为"D的导入出业务"的演讲,提出了改进D语言特别是导出和共享库功能的提案.

虽然该DIP并非直接源自Thaut的提议,且具体实现细节不同,但它在导出的作用上得出了类似结论.

即,它认识到,为了在D中有效利用注解,导出不应仅按可见性限定器使用.

与Thaut方法的一个显著区别是,他建议设置dllimport开关为"all",来指示符号是在DllImport模式.

然而,根据D社区在随后几年中在共享库方面的丰富经验,很明显,该方法经常导致链接器错误.因此,需要一个更细致,更细粒度方法来有效解决这些问题.

描述

变更基石

本节概述了未来更新的关键更改,以确保无误编译.

1,外部导入路径开关:

引入了新的extI编译器标志.它的功能类似I开关,按当前正在编译的二进制文件的外部,指定模块.

最好,构建管理器可自动执行此过程,对共享库关联的模块,用依赖关系的知识用-extI替换-I.

2,二进制外模块:

(通过-extI开关)按外部标识的模块,对所有非模板化域,有个隐式的extern属性.

3,导入符号:

要按DllImport模式导入符号,需要同时有export和extern注解.此时,是否存在函数体不重要.

以下各节,考虑模板在与共享库,D接口生成器,不同的导出注解和内联链接时的可靠性.

模板的可靠性

因为实例化模板的假设,模板可能会导致链接失败.因此,确保从模板继承的符号不会自动符合导出条件或为DllImport模式.

相反,按二进制文件的外部标识这些符号时,应重新实例化,并在设置了适当的重复标志后,放入目标二进制文件中.

这要求在每个模块的基础上,应用外部导入路径开关.

为了优化生成代码,编译器可用"固定"策略.如果在其声明的同一模块中,非模板化符号引用了模板的实例化(a),则按"固定"对待a.

此固定扩展到在模板中未封装的变量声明(包括全局变量)及函数参数和返回类型.

固定模板及其关联的符号后,在这些符号是二进制文件的外部时,编译器可自行决定,是否省略这些符号的生成代码.此时,编译器应遵循指定的导出和DllImport符号模式,以确保高效且无错误的链接.

D接口生成器

D接口生成器是D编译器提供的导出工具,通过省略D文件中的符号体来方便创建.di文件.
当与C解析器(ImportC)一起使用,以生成C库的绑定时,此工具特别有用.

但是,当前实现的一个显著局限性是在导出过程中,它无法准确遵循符号模式.

为此,提出了以下修改建议:
1,生成器,不应自动添加extern属性到符号中.
2,仅当按导出特定模块设置可见性覆盖开关时,生成器才可把导出(export)属性添加到所有非模板化域.

这些调整旨在与前面概述的变更基石相结合.用来确保:
1,对按export标记的代码基,.di生成器限制引入其他extern属性.
2,对静态库或目标文件,生成的.di文件可同-I标准导入路径开关一起使用.
3,或,在处理共享库依赖项时,可把外部导入路径开关-extI应用至.di文件.

导出符号模式方法

每个符号可有三个不同模式之一:Internal,DllExport和DllImport.

1,内部模式:这是符号的默认模式.不管在哪个模块中定义,同一个二进制文件中的其他符号都可访问内部符号.
2,DllExport模式:设置后,此模式指示,不仅自己的二进制文件,且外部二进制文件都可访问符号.这对编译打算跨不同二进制文件使用的符号至关重要.
3,DllImport模式:此模式告诉编译器符号在当前二进制文件的外部.因此,编译器生成允许在运行时访问此符号代码.

确定符号适当模式的策略如下:
1,使用export的正注解:此方法表示D编译器的默认行为,即对导出,用export关键字来显式标记符号.
2,用可见性覆盖开关负注解:默认,不会导出未用导出(export)注解的符号.可用可见性覆盖开关来反转此默认,来强制导出所有符号.对未显式标记导出,但需要导出其符号的库特别有用.

3,多步构建的边角注解:这是个特定注解,适合需要(具体根据构建步骤)确定符号是Internal还是DllImport的方案.
在复杂或冲突的符号模式的多步构建过程中非常有用.

导出注解

可按参数取标识,来增强导出属性.按版本解释标识,需要以下语法更改:

VisibilityAttribute:
-   export
Attribute:
+   export
+   export ( Identifier )

此参数的功能根据标识是否活动(由version=ident激活).活动时,除非正在编译,符号按内部模式.相反,当标识非活动时,类似有外部(extern)注解,符号按DllImport模式.

为了标准化标识使用,在D规范中引入了三个新的版本前缀,编译器自动提供了libc,DRuntime和Phobos的实例:
前缀为Have_,InBinary_和Compiling_.这三个的后缀将是个逻辑包.

1,Have_前缀:指示在链接过程中,指定逻辑包可用作依赖项.
2,InBinary_前缀:表示当前正在编译的二进制文件中有指定逻辑包的符号.
3,Compiling_前缀:表示正在编译指定逻辑包.

这些前缀结合逻辑包后缀,可处理按内部而不是外部的符号的极端场景.

此外,会更新D接口生成器,以支持插入InBinary_version参数.需要此更新才能通过D模块准确表示C文件.此处未介绍确定后缀的具体机制,它可能依赖于C预处理器功能.

正表示法

D中的export属性用于按DllExport来注解符号.要表示已导出符号,应直接应用此属性至D符号.

导出注解不能按可见性限定器使用.这样处理它,可能会无意中暴露内部实现细节,可能会在语言级别,导致外部实体对代码基不安全的操作.

在(如构,类,联或模块)封装单元中,如果按export标记任一成员,则也还必须导出所有关联生成的符号(如TypeInfo,__initZ,opCmp等,但不包括ModuleInfo).

导出关联符号,却无法导出这些生成符号时,则可能导致链接器错误,则如果不借助链接器脚本,可能无法解决这些错误.

默认,所有符号都是隐藏的.要按隐藏显式标记符号,请用core.attributes中提供的用户定义属性(UDA).该方法比在要导出的每个符号上注解导出更有效.

相反,它允许你在域级注解,并简单禁止那些不打算导出的符号.

否定符号

设置可见性覆盖开关后,默认会导出所有符号.
要覆盖此默认设置,并按隐藏显式指定符号,应使用core.attributes中提供的UDA.

在适当对DRuntime和Phobos库,用导出全面注解并测试前,它们依赖此符号可见性管理方法.

内联

考虑一个二进制外模块:

pragma(inline, true)
export extern void inlineable() {noInline;
}
@hidden void noInline();

在此例中,按隐藏标记noInline函数,因此无法访问内联.如果可跨二进制边界内联inlineable,因为noInline不可用,这会导致链接器错误.

为了避免此类错误,当这些函数引用未导出的符号时,必须指示编译器不要内联二进制外模块的函数.

用例

本节介绍场景说明了本DIP中提议的修改的实际影响和应用.
第一个情况与需要细致控制导出符号的用户有关.
第二个重点是,无需调整符号的DllImport状态,方便整合DRuntime到二进制文件.

正注解

此用例概述了用导出正注解和可选使用.di生成器的过程.它使用窗口文件命名约定展示.
目录布局:

dependency/source/library.d
dependency/imports/library.di
dependency/library.dll
dependency/library.lib
dependency/library.exp
executable/source/app.d
executable/app.exe
executable/library.dll

dependency/source/library.d的源:

module library;
export void myLibraryFunction() {import std.stdio;writeln("Hello from my libraries function!");
}

生成的dependency/source/library.di:

module library;
export void myLibraryFunction();

executable/source/app.d的源:

module app;
void main() {import library;myLibraryFunction();
}

使用共享库:

dmd of=dependency/library.dll shared Hd=dependency/imports dependency/source/library.d
cp dependency/library.dll executable/library.dll
dmd of=executable/app.exe extI=dependency/imports executable/source/app.d dependency/library.lib

使用静态库:

dmd of=dependency/library.lib Hd=dependency/imports dependency/source/library.d
dmd of=executable/app.exe I=dependency/imports executable/source/app.d dependency/library.lib

使用共享库和静态库的主要区别在于,编译前者时包含-shared,而在链接后者时用-I替换-extI.

二进制中的`DRuntime`

此用例侧重于整合DRuntime到二进制文件中的过程.不考虑Phobos等其他库,只是个说明性示例,因为,在静态或共享DRuntime间选择的开关是编译器相关的.

对此用例,考虑把DRuntime放入生成的二进制文件中会怎样.不考虑其他库(如Phobos),且选择Druntime是静态的还是共享的开关是编译器相关的,因此它只是演示了它的流程.

目录布局:

dependency/source/dependency.d
dependency/dependency.lib
mydll/source/api.d
mydll/mydll.dll
mydll/mydll.lib
mydll/mydll.exp

dependency/source/dependency.d的源:

module dependency;
void myLibraryFunction() {foreach(m; ModuleInfo) {//非模板化的符号都适合此例!}
}

mydll/source/api.d的源:

module api;
export void api() {import dependency;myLibraryFunction();
}

编译命令:

dmd of=dependency/dependency.lib lib libdruntime=static dependency/source/dependency.d
dmd of=mydll/mydll.dll shared I=dependency/source libdruntime=static mydll/source/api.d dependency/dependency.lib

特别令人感兴趣的是-lib-druntime=static的行为.
在典型的D编译中,会自动添加导入路径和静态/导入库.使用此DIP,要指定共享DRuntime版本,则用-extI替换-I,用导入库替换静态DRuntime库,并按externalOnly设置覆盖dllimport.