1 interface_check(1ONBLD) illumos Build Tools interface_check(1ONBLD)
2
3
4
5 NAME
6 interface_check - check shared object interfaces
7
8 SYNOPSIS
9 interface_check [-hIo] [-c vertype_module] [-E errfile] [-e exfile] [-f
10 listfile] [-i intffile] [-w outdir] file | dir, ...
11
12 DESCRIPTION
13 The interface_check command attempts to check a number of ELF
14 versioning attributes for consistency with common build rules and
15 practices. In addition, a complete breakdown of the file's version
16 definitions can be captured using the -i option, and the interface
17 description file created can be used with interface_cmp to audit the
18 versioning evolution of a software product. These interface
19 description files reflect the association of the shared object's global
20 symbols with recorded version definitions.
21
122 Produce an output file containing a complete interface definition
123 for the objects analyzed. This file can be used with interface_cmp
124 to audit versioning between gates, or prior to integration within a
125 single gate. See INTERFACE DESCRIPTION FILE FORMAT.
126
127 -o Produce one-liner output, with each line of diagnostic output
128 prefixed with the object pathname.
129
130 -w outdir
131 Interpret the paths of all input and output files relative to
132 outdir.
133
134 EXCEPTION FILE FORMAT
135 Exceptions to the rules enforced by interface_check are be specified
136 using an exception file. The -e option is used to specify an explicit
137 exception file. Otherwise, if used in an activated workspace, the
138 default exception file is $CODEMGR_WS/exception_list/interface_check if
139 that file exists. If not used in an activated workspace, or if
140 $CODEMGR_WS/exception_list/interface_check does not exist,
141 interface_check will use /opt/onbld/etc/exception_list/interface_check
142 as a fallback default exception file. To run interface_check without
143 applying exceptions, specify -e with a value of /dev/null.
144
145 A '#' character at the beginning of a line, or at any point in a line
146 when preceded by whitespace, introduces a comment. Empty lines, and
147 lines containing only comments, are ignored by interface_check.
148 Exceptions are specified as space separated keyword, and perl(1)
149 regular expression:
150
151 keyword perl-regex
152
153 Since whitespace is used as a separator, the regular expression cannot
154 itself contain whitespace. Use of the \s character class to represent
155 whitespace within the regular expression is recommended. Before the
156 perl regular expression is used, constructs of the form MACH(dir) are
157 expanded into a regular expression that matches the directory given, as
158 well as any 64-bit architecture subdirectory that might be present
159 (i.e. amd64, sparcv9). For instance, MACH(lib) will match any of the
160 following:
161
162 lib
163 lib/amd64
164 lib/sparcv9
266 The following example uses interface_check to generate an interface
267 database for a workspace:
268
269 % mkdir $SRC/ELF-data.$MACH
270 % interface_check -w $SRC/ELF-data.$MACH -E interface.err
271 -i interface $ROOT
272 % ls -1R $SRC/ELF
273 interface
274 interface.err
275
276 FILES
277 $CODEMGR_WS/exception_list/interface_check
278 /opt/onbld/etc/exception_list/interface_check
279
280 SEE ALSO
281 find_elf(1ONBLD), interface_cmp(1ONBLD), ld(1), ldd(1), elfdump(1),
282 pvs(1).
283
284
285
286 25 March 2010 interface_check(1ONBLD)
|
1 INTERFACE_CHECK(1ONBLD) illumos Build Tools INTERFACE_CHECK(1ONBLD)
2
3
4
5 NAME
6 interface_check - check shared object interfaces
7
8 SYNOPSIS
9 interface_check [-hIo] [-c vertype_module] [-E errfile] [-e exfile] [-f
10 listfile] [-i intffile] [-w outdir] file | dir, ...
11
12 DESCRIPTION
13 The interface_check command attempts to check a number of ELF
14 versioning attributes for consistency with common build rules and
15 practices. In addition, a complete breakdown of the file's version
16 definitions can be captured using the -i option, and the interface
17 description file created can be used with interface_cmp to audit the
18 versioning evolution of a software product. These interface
19 description files reflect the association of the shared object's global
20 symbols with recorded version definitions.
21
122 Produce an output file containing a complete interface definition
123 for the objects analyzed. This file can be used with interface_cmp
124 to audit versioning between gates, or prior to integration within a
125 single gate. See INTERFACE DESCRIPTION FILE FORMAT.
126
127 -o Produce one-liner output, with each line of diagnostic output
128 prefixed with the object pathname.
129
130 -w outdir
131 Interpret the paths of all input and output files relative to
132 outdir.
133
134 EXCEPTION FILE FORMAT
135 Exceptions to the rules enforced by interface_check are be specified
136 using an exception file. The -e option is used to specify an explicit
137 exception file. Otherwise, if used in an activated workspace, the
138 default exception file is $CODEMGR_WS/exception_list/interface_check if
139 that file exists. If not used in an activated workspace, or if
140 $CODEMGR_WS/exception_list/interface_check does not exist,
141 interface_check will use /opt/onbld/etc/exception_list/interface_check
142 as a fallback default exception file.
143
144 To run interface_check without applying exceptions, specify -e with a
145 value of /dev/null.
146
147 A '#' character at the beginning of a line, or at any point in a line
148 when preceded by whitespace, introduces a comment. Empty lines, and
149 lines containing only comments, are ignored by interface_check.
150 Exceptions are specified as space separated keyword, and perl(1)
151 regular expression:
152
153 keyword perl-regex
154
155 Since whitespace is used as a separator, the regular expression cannot
156 itself contain whitespace. Use of the \s character class to represent
157 whitespace within the regular expression is recommended. Before the
158 perl regular expression is used, constructs of the form MACH(dir) are
159 expanded into a regular expression that matches the directory given, as
160 well as any 64-bit architecture subdirectory that might be present
161 (i.e. amd64, sparcv9). For instance, MACH(lib) will match any of the
162 following:
163
164 lib
165 lib/amd64
166 lib/sparcv9
268 The following example uses interface_check to generate an interface
269 database for a workspace:
270
271 % mkdir $SRC/ELF-data.$MACH
272 % interface_check -w $SRC/ELF-data.$MACH -E interface.err
273 -i interface $ROOT
274 % ls -1R $SRC/ELF
275 interface
276 interface.err
277
278 FILES
279 $CODEMGR_WS/exception_list/interface_check
280 /opt/onbld/etc/exception_list/interface_check
281
282 SEE ALSO
283 find_elf(1ONBLD), interface_cmp(1ONBLD), ld(1), ldd(1), elfdump(1),
284 pvs(1).
285
286
287
288
289
290 March 25, 2010 INTERFACE_CHECK(1ONBLD)
|