6205 Sdiff usr/src/tools/scripts/check

Print this page

6205 onbld manuals should be declared as 1onbld
Reviewed by: Dan McDonald <danmcd@omniti.com>
Reviewed by: Josef Sipek <jeffpc@josefsipek.net>

   2 .\"
   3 .\" CDDL HEADER START
   4 .\"
   5 .\" The contents of this file are subject to the terms of the
   6 .\" Common Development and Distribution License (the "License").
   7 .\" You may not use this file except in compliance with the License.
   8 .\"
   9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  10 .\" or http://www.opensolaris.org/os/licensing.
  11 .\" See the License for the specific language governing permissions
  12 .\" and limitations under the License.
  13 .\"
  14 .\" When distributing Covered Code, include this CDDL HEADER in each
  15 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  16 .\" If applicable, add the following below this CDDL HEADER, with the
  17 .\" fields enclosed by brackets "[]" replaced with your own identifying
  18 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  19 .\"
  20 .\" CDDL HEADER END
  21 .\"
  22 .TH check_rtime 1 "09 March 2010"
  23 .SH NAME
  24 .I check_rtime
  25 \- check ELF runtime attributes
  26 .SH SYNOPSIS
  27 \fBcheck_rtime [-imosv] [-D depfile | -d depdir] [-E errfile] [-e exfile] [-f listfile] [-I infofile] [-w outdir] file | dir, ...\fP
  28 .LP
  29 .SH DESCRIPTION
  30 .IX "OS-Net build tools" "check_rtime" "" "\fBcheck_rtime\fP"
  31 .LP
  32 .I check_rtime
  33 attempts to check a number of ELF runtime attributes
  34 for consistency with common build rules.
  35 These checks involve running \fBldd(1)\fP and
  36 \fBelfdump(1)\fP against a family of dynamic objects.
  37 A dynamic object can be defined explicitly as a \fIfile\fP
  38 or multiple dynamic objects can be located under the directory \fIdir\fP.
  39 .LP
  40 .I check_rtime
  41 is typically called from \fBnightly(1)\fP when the \fB-r\fP
  42 option is in effect. In this case the dynamic objects under
  43 the associated \fIproto\fP area (\fB$ROOT\fP) are checked.
  44 .I check_rtime
  45 can also be run standalone against any set of dynamic objects.
  46 .LP
  47 .I check_rtime
  48 uses \fBldd(1)\fP to verify dependencies. This implies that
  49 by default any object inspected will bind to its dependencies
  50 as they are found in the \fBunderlying\fP system.  Use of the \fB-D\fP, \fB-d\fP
  51 option, or the existence of the environment variables
  52 \fB$CODEMGR_WS/$ROOT\fP instruct
  53 .I check_rtime
  54 to establish an alternative dependency mapping using
  55 runtime configuration files generated with \fBcrle(1)\fP.
  56 .LP
  57 .I check_rtime
  58 uses \fBldd(1)\fP to completely relocate any dynamic
  59 object and thus detect missing dependencies, unsatisfied
  60 symbol relocations, unused and unreferenced dependencies. These checks
  61 are carried out for the following reasons:

 359 uses \fBpvs(1)\fP to display version definitions under the \fB-v\fP option.
 360 Each symbol defined by the object is shown along with the version it belongs to.
 361 Changes to the symbols defined by an object, or the versions they belong to,
 362 do not necessarily indicate an error condition, but
 363 provides information that is often useful for gatekeepers to track
 364 changes in a release.
 365 .RE
 366 .sp
 367 .LP
 368 .SH OPTIONS
 369 .LP
 370 The following options are supported:
 371 .TP 4
 372 .B \-D depfile
 373 Use \fIdepfile\fP to generate an alternative dependency mapping.
 374 \fIdepfile\fP must be created by '\fBfind_elf -r\fP'.
 375 The \fB-D\fP and \fB-d\fP options are mutually exclusive.
 376 .TP
 377 .B \-d depdir
 378 Use \fIdepdir\fP to generate an alternative dependency mapping.
 379 \fBfind_elf(1)\fP is used to locate the ELF sharable objects for
 380 which alternative mappings are required. The \fB-D\fP and \fB-d\fP options
 381 are mutually exclusive.
 382 .TP 4
 383 .B \-E errfile
 384 Direct error messages for the analyzed objects to \fIerrfile\fP instead 
 385 of stdout.
 386 .TP 4
 387 .B \-e exfile
 388 An exception file is used to exclude objects from
 389 the usual rules. See EXCEPTION FILE FORMAT.
 390 .TP
 391 .B \-f listfile
 392 Normally,
 393 .I interface_check
 394 runs
 395 .I find_elf
 396 to locate the ELF objects to analyze. The \fB-f\fP option can be
 397 used to instead provide a file containing the list of objects to
 398 analyze, in the format produced by '\fBfind_elf -r\fP'.
 399 .TP

 711 .LP
 712 Inspection of an object with \fBldd(1)\fP assumes it is compatible
 713 with the machine on which
 714 .I check_rtime
 715 is being run.  Incompatible objects such as a 64-bit object encountered on
 716 a 32-bit system, or an i386 object encountered on a sparc system,
 717 can not be fully inspected.  These objects are displayed as:
 718 .sp
 719 .RS 4
 720 foo: has wrong class or data encoding
 721 .RE
 722 .LP
 723 .SH FILES
 724 .LP
 725 .RS 5
 726 $CODEMGR_WS/exception_list/check_rtime
 727 /opt/onbld/etc/exception_list/check_rtime
 728 .SH SEE ALSO
 729 .B crle(1),
 730 .B elfdump(1),
 731 .B find_elf(1),
 732 .B ldd(1),
 733 .B ld.so.1(1),
 734 .B mcs(1).

   2 .\"
   3 .\" CDDL HEADER START
   4 .\"
   5 .\" The contents of this file are subject to the terms of the
   6 .\" Common Development and Distribution License (the "License").
   7 .\" You may not use this file except in compliance with the License.
   8 .\"
   9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  10 .\" or http://www.opensolaris.org/os/licensing.
  11 .\" See the License for the specific language governing permissions
  12 .\" and limitations under the License.
  13 .\"
  14 .\" When distributing Covered Code, include this CDDL HEADER in each
  15 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  16 .\" If applicable, add the following below this CDDL HEADER, with the
  17 .\" fields enclosed by brackets "[]" replaced with your own identifying
  18 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  19 .\"
  20 .\" CDDL HEADER END
  21 .\"
  22 .TH check_rtime 1ONBLD "09 March 2010"
  23 .SH NAME
  24 .I check_rtime
  25 \- check ELF runtime attributes
  26 .SH SYNOPSIS
  27 \fBcheck_rtime [-imosv] [-D depfile | -d depdir] [-E errfile] [-e exfile] [-f listfile] [-I infofile] [-w outdir] file | dir, ...\fP
  28 .LP
  29 .SH DESCRIPTION
  30 .IX "OS-Net build tools" "check_rtime" "" "\fBcheck_rtime\fP"
  31 .LP
  32 .I check_rtime
  33 attempts to check a number of ELF runtime attributes
  34 for consistency with common build rules.
  35 These checks involve running \fBldd(1)\fP and
  36 \fBelfdump(1)\fP against a family of dynamic objects.
  37 A dynamic object can be defined explicitly as a \fIfile\fP
  38 or multiple dynamic objects can be located under the directory \fIdir\fP.
  39 .LP
  40 .I check_rtime
  41 is typically called from \fBnightly(1ONBLD)\fP when the \fB-r\fP
  42 option is in effect. In this case the dynamic objects under
  43 the associated \fIproto\fP area (\fB$ROOT\fP) are checked.
  44 .I check_rtime
  45 can also be run standalone against any set of dynamic objects.
  46 .LP
  47 .I check_rtime
  48 uses \fBldd(1)\fP to verify dependencies. This implies that
  49 by default any object inspected will bind to its dependencies
  50 as they are found in the \fBunderlying\fP system.  Use of the \fB-D\fP, \fB-d\fP
  51 option, or the existence of the environment variables
  52 \fB$CODEMGR_WS/$ROOT\fP instruct
  53 .I check_rtime
  54 to establish an alternative dependency mapping using
  55 runtime configuration files generated with \fBcrle(1)\fP.
  56 .LP
  57 .I check_rtime
  58 uses \fBldd(1)\fP to completely relocate any dynamic
  59 object and thus detect missing dependencies, unsatisfied
  60 symbol relocations, unused and unreferenced dependencies. These checks
  61 are carried out for the following reasons:

 359 uses \fBpvs(1)\fP to display version definitions under the \fB-v\fP option.
 360 Each symbol defined by the object is shown along with the version it belongs to.
 361 Changes to the symbols defined by an object, or the versions they belong to,
 362 do not necessarily indicate an error condition, but
 363 provides information that is often useful for gatekeepers to track
 364 changes in a release.
 365 .RE
 366 .sp
 367 .LP
 368 .SH OPTIONS
 369 .LP
 370 The following options are supported:
 371 .TP 4
 372 .B \-D depfile
 373 Use \fIdepfile\fP to generate an alternative dependency mapping.
 374 \fIdepfile\fP must be created by '\fBfind_elf -r\fP'.
 375 The \fB-D\fP and \fB-d\fP options are mutually exclusive.
 376 .TP
 377 .B \-d depdir
 378 Use \fIdepdir\fP to generate an alternative dependency mapping.
 379 \fBfind_elf(1ONBLD)\fP is used to locate the ELF sharable objects for
 380 which alternative mappings are required. The \fB-D\fP and \fB-d\fP options
 381 are mutually exclusive.
 382 .TP 4
 383 .B \-E errfile
 384 Direct error messages for the analyzed objects to \fIerrfile\fP instead 
 385 of stdout.
 386 .TP 4
 387 .B \-e exfile
 388 An exception file is used to exclude objects from
 389 the usual rules. See EXCEPTION FILE FORMAT.
 390 .TP
 391 .B \-f listfile
 392 Normally,
 393 .I interface_check
 394 runs
 395 .I find_elf
 396 to locate the ELF objects to analyze. The \fB-f\fP option can be
 397 used to instead provide a file containing the list of objects to
 398 analyze, in the format produced by '\fBfind_elf -r\fP'.
 399 .TP

 711 .LP
 712 Inspection of an object with \fBldd(1)\fP assumes it is compatible
 713 with the machine on which
 714 .I check_rtime
 715 is being run.  Incompatible objects such as a 64-bit object encountered on
 716 a 32-bit system, or an i386 object encountered on a sparc system,
 717 can not be fully inspected.  These objects are displayed as:
 718 .sp
 719 .RS 4
 720 foo: has wrong class or data encoding
 721 .RE
 722 .LP
 723 .SH FILES
 724 .LP
 725 .RS 5
 726 $CODEMGR_WS/exception_list/check_rtime
 727 /opt/onbld/etc/exception_list/check_rtime
 728 .SH SEE ALSO
 729 .B crle(1),
 730 .B elfdump(1),
 731 .B find_elf(1ONBLD),
 732 .B ldd(1),
 733 .B ld.so.1(1),
 734 .B mcs(1).