编程接口指南

Solaris ABI 工具

Solaris 操作系统提供了两个工具,用于验证应用程序使用的 Solaris 接口是否符合 Solaris ABI。appcert 实用程序可针对专用接口用法实例,静态检查 ELF 二进制对象使用的 Solaris 库接口,并可针对其发现的任何潜在的二进制稳定性问题生成摘要和详细报告。apptrace 工具使用运行时链接程序的链接审计功能,在应用程序运行时可动态跟踪 Solaris 库例程调用。利用此功能,开发者可以检查应用程序使用 Solaris 系统接口的情况。

使用 ABI 工具,可以轻松快速地识别可能与给定的 Solaris 发行版存在二进制兼容性问题的二进制对象。要检查二进制稳定性,请执行以下步骤:

appcert 实用程序

appcert 实用程序是一个 Perl 脚本,用于静态检查 ELF 二进制对象,并将所使用的库符号与给定的 Solaris 发行版中的公共接口和专用接口模型进行比较。此实用程序在 SPARC 或 x86 平台上运行。它可以检查 SPARC 和 x86 的 32 位接口以及 SPARC 平台上 64 位接口的使用情况。请注意,appcert 仅检查 C 语言接口。

随着新 Solaris 发行版的问世,某些库接口的行为可能会发生变化,或者完全消失。这些变化会影响依赖这些接口的应用程序的性能。Solaris ABI 定义了可供应用程序使用的安全稳定的运行时库接口。appcert 实用程序旨在帮助开发者验证应用程序与 Solaris ABI 的兼容性。

appcert 的检查内容

appcert 实用程序将针对以下内容对应用程序进行检查:

专用符号的使用情况

专用符号是 Solaris 库用来进行互相调用的函数或数据。专用符号的语义行为可能会发生变化,有时候还可能会删除符号。此类符号称为降级符号。专用符号可变的性质可能会导致依赖于专用符号的应用程序变得不稳定。

静态链接

Solaris 库之间的专用符号调用的语义在不同的发行版之间可能会发生更改。因此,创建指向归档文件的静态链接会降低应用程序的二进制稳定性。使用指向归档文件对应的共享目标文件的动态链接可以避免此问题。

非绑定符号

appcert 实用程序使用动态链接程序解析所检查的应用程序使用的库符号。动态链接程序无法解析的符号称为非绑定符号。非绑定符号可能是由于环境问题造成的,如 LD_LIBRARY_PATH 变量设置不正确。非绑定符号也可能是由于生成问题造成的,如在编译时省略了 -llib-z 转换参数的定义。尽管这些示例中的问题都不很重要,但是 appcert 报告的非绑定符号可能指示更严重的问题,如与不再存在的专用符号存在相关性。

appcert 不检查的内容

如果 appcert 检查的目标文件依赖于库,则必须在目标文件中记录这些依赖项。为此,编译代码时请确保使用编译器的 -l 转换参数。如果目标文件依赖于其他共享库,则运行 appcert 时必须能够通过 LD_LIBRARY_PATHRPATH 访问这些库。

appcert 应用程序不能检查 64 位应用程序,除非计算机运行的是 64 位 Solaris 内核。由于 Solaris 未提供任何 64 位静态库,因此 appcert 不会对 64 位应用程序执行静态链接检查。

appcert 实用程序不能检查以下内容:

使用 appcert

要使用 appcert 检查应用程序,请键入以下内容:


appcert object|directory

object|directory 替换为以下任一项:


注 –

运行 appcert 的环境可能不同于运行应用程序的环境。如果这两个环境不同,则 appcert 可能无法正确解析对 Solaris 库接口的引用。


appcert 实用程序使用 Solaris 运行时链接程序为每个可执行文件或共享目标文件构造一个接口依赖项的配置文件。此配置文件用于确定应用程序依赖的 Solaris 系统接口。此配置文件中概述的依赖项将与 Solaris ABI 进行比较,以验证是否与其兼容。不存在任何专用接口。

appcert 实用程序以递归方式搜索目录中的目标文件,从而忽略非 ELF 目标文件。appcert 检查完应用程序之后,会在标准输出(通常是屏幕)中列显汇总报告。此报告的副本将写入工作目录(通常是 /tmp/appcert.pid)中名为 Report 的文件中。在子目录名称中,pid 表示此特定 appcert 实例的 1 至 6 位数字的进程 ID。有关 appcert 写入输出文件的目录结构的更多信息,请参见appcert 结果

appcert 选项

以下选项用于修改 appcert 实用程序的行为。可以在命令行中 appcert 命令之后,object|directory 操作数之前键入其中任一选项。

-B

以批处理模式运行 appcert。

在批处理模式下,appcert 生成的报告中包含的每一行都针对一个所检查的二进制对象。

以 PASS 开头的行表示该行中列出的二进制对象未触发任何 appcert 警告。

以 FAIL 开头的行表示在该库中发现问题。

以 INC 开头的行表示无法完全检查该行中指定的二进制对象。

-f infile

文件 infile 应包含要检查的文件列表,每行包含一个文件名。这些文件将添加到命令行中已经指定的任何文件中。如果使用此转换参数,则无需在命令行中指定对象或目录。

-h

列显 appcert 的使用情况信息。

-L

缺省情况下,appcert 会对应用程序中的所有共享对象进行注释,并将共享对象所驻留的目录附加到 LD_LIBRARY_PATH。使用 -L 转换参数可以禁用这一行为。

-n

缺省情况下,appcert 在搜索目录以查找要检查的二进制代码时会打开符号链接。使用 -n 转换参数可以禁用这一行为。

-S

将 Solaris 库目录 /usr/openwin/lib/usr/dt/lib 附加到 LD_LIBRARY_PATH

-w working_dir

指定要运行库组件的目录。另外,还将在此转换参数指定的目录中创建临时文件。如果未指定此转换参数,则 appcert 使用 /tmp 目录。

使用 appcert 进行应用程序分级

使用 appcert 实用程序,可以快速轻松地识别给定集合中存在潜在稳定性问题的应用程序。如果 appcert 未报告任何稳定性问题,则应用程序在后续 Solaris 发行版中可能不会遇到二进制稳定性问题。下表列出了一些常见的二进制稳定性问题。

表 11–1 常见的二进制稳定性问题

问题 

采取的措施 

使用确定要更改的专用符号 

立即停止使用此类符号。 

使用尚未更改的专用符号 

应用程序目前仍然可以运行,但是应根据实际情况尽快停止使用此类符号。 

静态链接包含共享对象对应项的库 

改用共享对象对应项。 

静态链接不包含共享对象对应项的库 

如果可能,使用命令 ld -z allextract.a 文件转换为 .so 文件。否则,继续使用静态库,直到共享对象可用为止。

使用没有可用公共对应项的专用符号 

与 Sun 联系,请求获取一个公共接口。 

使用已过时的符号,或者使用计划要删除的符号 

应用程序目前仍然可以运行,但是应根据实际情况尽快停止使用此类符号。 

使用已更改的公共符号 

重新编译。 

给定的发行版中可能不会出现由于使用专用接口而导致的潜在稳定性问题。专用接口的行为在不同的发行版之间并不一定会发生变化。要验证专用接口的行为在目标发行版中是否已发生变化,请使用 apptrace 工具。apptrace 的用法在使用 apptrace 进行应用程序验证中介绍。

appcert 结果

appcert 实用程序对应用程序目标文件的分析结果会写入多个文件,这些文件位于 appcert 实用程序的工作目录中,通常为 /tmp。工作目录下的主要子目录是 appcert.pid,其中,pid 是此 appcert 实例的进程 ID。appcert 实用程序的结果会写入以下文件:

Index

包含所检查的二进制对象与特定于此二进制对象的 appcert 输出所在子目录之间的映射。

Report

包含运行 appcert 时使用 stdout 所显示的汇总报告的副本。

Skipped

包含要求 appcert 检查但强制跳过的二进制对象的列表以及跳过每个二进制对象的原因。以下列表中列出了这些原因:

  • 文件不是二进制对象

  • 用户无法读取文件

  • 文件名包含元字符

  • 文件未设置执行位

objects/object_name

appcert 检查的每个对象的 objects 子目录下都有一个单独的子目录。其中每个子目录均包含以下文件:

check.demoted.symbols

包含 appcert 怀疑为降级的 Solaris 符号的列表。

check.dynamic.private

包含与对象直接绑定的专用 Solaris 符号的列表。

check.dynamic.public

包含与对象直接绑定的公共 Solaris 符号的列表。

check.dynamic.unbound

包含运行 ldd -r 时不是由动态链接程序绑定的符号的列表。另外,还包括 ldd 返回的包含 “file not found” 的行。

summary.dynamic

包含 appcert 检查的对象中的打印机格式的动态绑定摘要,其中包括每个 Solaris 库中使用的公共符号和专用符号表。

返回以下四个退出值之一。

0

appcert 未找到二进制不稳定性的潜在原因。

1

appcert 实用程序未成功运行。

2

appcert 检查的某些对象存在潜在的二进制稳定性问题。

3

appcert 实用程序未找到任何要检查的二进制对象。

更正 appcert 报告的问题

使用 apptrace 进行应用程序验证

apptrace 实用程序是一个 C 程序,用于在应用程序运行时动态跟踪对 Solaris 库例程的调用。apptrace 可以在 SPARC 或 x86 平台上运行。apptrace 既可以跟踪 SPARC 和 x86 的 32 位接口调用,也可以跟踪 SPARC 平台上的 64 位接口调用。与 appcert 一样,apptrace 仅检查 C 语言接口。

应用程序验证

使用 appcert 确定应用程序面临二进制不稳定性风险之后,可以借助 apptrace 评估每种情况下的风险程度。要确定应用程序与给定发行版的二进制兼容性,请通过 apptrace 验证是否可以成功使用应用程序所用的每个接口。

apptrace 实用程序可以验证应用程序是否正确使用公共接口。例如,使用 open() 直接打开管理文件 /etc/passwd 的应用程序应改用相应的编程接口。这种检查 Solaris ABI 使用情况的能力使您能够轻松快速地识别潜在的接口问题。

运行 apptrace

apptrace 实用程序不要求对所跟踪的应用程序进行任何修改。要使用 apptrace,请键入 apptrace,后跟所需的任何选项以及用于运行有用的应用程序的命令行。apptrace 实用程序运行时可使用运行时链接程序的链接审计功能来拦截应用程序对 Solaris 库接口的调用。然后,apptrace 实用程序会通过列显调用参数的名称和值来跟踪调用并返回值。跟踪输出可以显示为一行,也可以分为多行以便于阅读。公共接口按人工可读的形式进行列显。专用接口以十六进制进行列显。

apptrace 实用程序允许有选择性跟踪调用,既可以跟踪各接口级调用,也可以跟踪库级调用。例如,apptrace 可以跟踪来自 libnslprintf() 调用,也可以跟踪特定库内某个范围的调用。apptrace 实用程序还可以详细跟踪用户指定的调用。指示 apptrace 行为的规范会通过语法进行制约,此语法与 truss(1) 的用法一致。-f 选项用于指示 apptrace 遵循派生的子进程。-o 选项用于指定存储 apptrace 结果的输出文件。

apptrace 实用程序仅跟踪库级调用,并可装入运行的应用程序进程中,从而可以提高性能(比使用 truss 时的性能要高)。但使用 printf 则除外,在这种情况下 apptrace 无法跟踪对接受变量列表的函数的调用,也无法检查栈或其他调用方信息,例如 setcontextgetcontextsetjmplongjmpvfork

解释 apptrace 输出

以下示例包含跟踪简单的单二进制应用程序 ls 所产生的 apptrace 输出样例。


示例 11–1 缺省跟踪行为


% apptrace ls /etc/passwd

ls       -> libc.so.1:atexit(func = 0xff3cb8f0) = 0x0

ls       -> libc.so.1:atexit(func = 0x129a4) = 0x0

ls       -> libc.so.1:getuid() = 0x32c3

ls       -> libc.so.1:time(tloc = 0x23918) = 0x3b2fe4ef

ls       -> libc.so.1:isatty(fildes = 0x1) = 0x1

ls       -> libc.so.1:ioctl(0x1, 0x540d, 0xffbff7ac)

ls       -> libc.so.1:ioctl(0x1, 0x5468, 0x23908)

ls       -> libc.so.1:setlocale(category = 0x6, locale = "") = "C"

ls       -> libc.so.1:calloc(nelem = 0x1, elsize = 0x40) = 0x23cd0

ls       -> libc.so.1:lstat64(path = "/etc/passwd", buf = 0xffbff6b0) = 0x0

ls       -> libc.so.1:acl(pathp = "/etc/passwd", cmd = 0x3, nentries = 0x0,

             aclbufp = 0x0) = 0x4

ls       -> libc.so.1:qsort(base = 0x23cd0, nel = 0x1, width = 0x40,

             compar = 0x12038)

ls       -> libc.so.1:sprintf(buf = 0x233d0, format = 0x12af8, ...) = 0

ls       -> libc.so.1:strlen(s = "") = 0x0

ls       -> libc.so.1:strlen(s = "/etc/passwd") = 0xb

ls       -> libc.so.1:sprintf(buf = 0x233d0, format = 0x12af8, ...) = 0

ls       -> libc.so.1:strlen(s = "") = 0x0

ls       -> libc.so.1:printf(format = 0x12ab8, ...) = 11

ls       -> libc.so.1:printf(/etc/passwd

format = 0x12abc, ...) = 1

ls       -> libc.so.1:exit(status = 0)

以上示例显示了缺省跟踪行为,即跟踪 ls /etc/passwd 命令的每个库调用。apptrace 实用程序针对每个系统调用列显一行输出,指明以下信息:

ls 的输出与 apptrace 输出混在一起。


示例 11–2 选择性跟踪


% apptrace -t \*printf ls /etc/passwd

ls       -> libc.so.1:sprintf(buf = 0x233d0, format = 0x12af8, ...) = 0

ls       -> libc.so.1:sprintf(buf = 0x233d0, format = 0x12af8, ...) = 0

ls       -> libc.so.1:printf(format = 0x12ab8, ...) = 11

ls       -> libc.so.1:printf(/etc/passwd

format = 0x12abc, ...) = 1

以上示例说明了 apptrace 如何能够有选择性地跟踪使用正则表达式语法的调用。在此示例中,在 printf(包括 sprintf)中结束的接口调用与以前一样,都是在 ls 命令中进行跟踪。 因此,apptrace 仅跟踪 printfsprintf 调用。


示例 11–3 详细跟踪


% apptrace -v sprintf ls /etc/passwd

ls       -> libc.so.1:sprintf(buf = 0x233d0, format = 0x12af8, ...) = 0

  buf =    (char *) 0x233d0 ""

  format = (char *) 0x12af8 "%s%s%s"

ls       -> libc.so.1:sprintf(buf = 0x233d0, format = 0x12af8, ...) = 0

  buf =    (char *) 0x233d0 ""

  format = (char *) 0x12af8 "%s%s%s"

/etc/passwd

以上示例显示了详细跟踪模式,在这种模式下,sprintf 的参数会列显在多行中以便于阅读。 最后,apptrace 会显示 ls 命令的输出。