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>
   1 check_rtime(1)                   User Commands                  check_rtime(1)
   2 
   3 
   4 
   5 NAME
   6        check_rtime - check ELF runtime attributes
   7 
   8 SYNOPSIS
   9        check_rtime [-imosv] [-D depfile | -d depdir] [-E errfile] [-e exfile]
  10        [-f listfile] [-I infofile] [-w outdir] file | dir, ...
  11 
  12 DESCRIPTION
  13        check_rtime attempts to check a number of ELF runtime attributes for
  14        consistency with common build rules.  These checks involve running
  15        ldd(1) and elfdump(1) against a family of dynamic objects.  A dynamic
  16        object can be defined explicitly as a file or multiple dynamic objects
  17        can be located under the directory dir.
  18 
  19        check_rtime is typically called from nightly(1) when the -r option is
  20        in effect. In this case the dynamic objects under the associated proto
  21        area ($ROOT) are checked.  check_rtime can also be run standalone
  22        against any set of dynamic objects.
  23 
  24        check_rtime uses ldd(1) to verify dependencies. This implies that by
  25        default any object inspected will bind to its dependencies as they are
  26        found in the underlying system.  Use of the -D, -d option, or the
  27        existence of the environment variables $CODEMGR_WS/$ROOT instruct
  28        check_rtime to establish an alternative dependency mapping using
  29        runtime configuration files generated with crle(1).
  30 
  31        check_rtime uses ldd(1) to completely relocate any dynamic object and
  32        thus detect missing dependencies, unsatisfied symbol relocations,
  33        unused and unreferenced dependencies. These checks are carried out for
  34        the following reasons:
  35 
  36        o   An object that cannot find its dependencies may fail to load at
  37            runtime.  This error condition often goes unnoticed because the
  38            existing use of the object is as a dependency itself, and the
  39            objects' dependencies are already satisfied by the caller.
  40            However, if the object itself is unable to satisfy its
  41            dependencies, its use in new environments may be compromised.


 259 
 260 
 261        check_rtime uses pvs(1) to display version definitions under the -v
 262        option.  Each symbol defined by the object is shown along with the
 263        version it belongs to.  Changes to the symbols defined by an object, or
 264        the versions they belong to, do not necessarily indicate an error
 265        condition, but provides information that is often useful for
 266        gatekeepers to track changes in a release.
 267 
 268 
 269 OPTIONS
 270        The following options are supported:
 271 
 272        -D depfile
 273            Use depfile to generate an alternative dependency mapping.  depfile
 274            must be created by 'find_elf -r'.  The -D and -d options are
 275            mutually exclusive.
 276 
 277        -d depdir
 278            Use depdir to generate an alternative dependency mapping.
 279            find_elf(1) is used to locate the ELF sharable objects for which
 280            alternative mappings are required. The -D and -d options are
 281            mutually exclusive.
 282 
 283        -E errfile
 284            Direct error messages for the analyzed objects to errfile instead
 285            of stdout.
 286 
 287        -e exfile
 288            An exception file is used to exclude objects from the usual rules.
 289            See EXCEPTION FILE FORMAT.
 290 
 291        -f listfile
 292            Normally, interface_check runs find_elf to locate the ELF objects
 293            to analyze. The -f option can be used to instead provide a file
 294            containing the list of objects to analyze, in the format produced
 295            by 'find_elf -r'.
 296 
 297        -I infofile
 298            Direct informational messages (-i, and -v options) for the analyzed
 299            objects to infofile instead of stdout.
 300 


 476        variable exists, and indicates an earlier release than 5.10 then ldd(1)
 477        also falls back to using the -u option.
 478 
 479        RELEASE
 480            The release version number of the environment being built.
 481 
 482 ERROR CONDITIONS
 483        Inspection of an object with ldd(1) assumes it is compatible with the
 484        machine on which check_rtime is being run.  Incompatible objects such
 485        as a 64-bit object encountered on a 32-bit system, or an i386 object
 486        encountered on a sparc system, can not be fully inspected.  These
 487        objects are displayed as:
 488 
 489            foo: has wrong class or data encoding
 490 
 491 FILES
 492             $CODEMGR_WS/exception_list/check_rtime
 493             /opt/onbld/etc/exception_list/check_rtime
 494 
 495 SEE ALSO
 496        crle(1), elfdump(1), find_elf(1), ldd(1), ld.so.1(1), mcs(1).
 497 
 498 
 499 
 500                                  09 March 2010                  check_rtime(1)
   1 check_rtime(1ONBLD)           illumos Build Tools          check_rtime(1ONBLD)
   2 
   3 
   4 
   5 NAME
   6        check_rtime - check ELF runtime attributes
   7 
   8 SYNOPSIS
   9        check_rtime [-imosv] [-D depfile | -d depdir] [-E errfile] [-e exfile]
  10        [-f listfile] [-I infofile] [-w outdir] file | dir, ...
  11 
  12 DESCRIPTION
  13        check_rtime attempts to check a number of ELF runtime attributes for
  14        consistency with common build rules.  These checks involve running
  15        ldd(1) and elfdump(1) against a family of dynamic objects.  A dynamic
  16        object can be defined explicitly as a file or multiple dynamic objects
  17        can be located under the directory dir.
  18 
  19        check_rtime is typically called from nightly(1ONBLD) when the -r option
  20        is in effect. In this case the dynamic objects under the associated
  21        proto area ($ROOT) are checked.  check_rtime can also be run standalone
  22        against any set of dynamic objects.
  23 
  24        check_rtime uses ldd(1) to verify dependencies. This implies that by
  25        default any object inspected will bind to its dependencies as they are
  26        found in the underlying system.  Use of the -D, -d option, or the
  27        existence of the environment variables $CODEMGR_WS/$ROOT instruct
  28        check_rtime to establish an alternative dependency mapping using
  29        runtime configuration files generated with crle(1).
  30 
  31        check_rtime uses ldd(1) to completely relocate any dynamic object and
  32        thus detect missing dependencies, unsatisfied symbol relocations,
  33        unused and unreferenced dependencies. These checks are carried out for
  34        the following reasons:
  35 
  36        o   An object that cannot find its dependencies may fail to load at
  37            runtime.  This error condition often goes unnoticed because the
  38            existing use of the object is as a dependency itself, and the
  39            objects' dependencies are already satisfied by the caller.
  40            However, if the object itself is unable to satisfy its
  41            dependencies, its use in new environments may be compromised.


 259 
 260 
 261        check_rtime uses pvs(1) to display version definitions under the -v
 262        option.  Each symbol defined by the object is shown along with the
 263        version it belongs to.  Changes to the symbols defined by an object, or
 264        the versions they belong to, do not necessarily indicate an error
 265        condition, but provides information that is often useful for
 266        gatekeepers to track changes in a release.
 267 
 268 
 269 OPTIONS
 270        The following options are supported:
 271 
 272        -D depfile
 273            Use depfile to generate an alternative dependency mapping.  depfile
 274            must be created by 'find_elf -r'.  The -D and -d options are
 275            mutually exclusive.
 276 
 277        -d depdir
 278            Use depdir to generate an alternative dependency mapping.
 279            find_elf(1ONBLD) is used to locate the ELF sharable objects for
 280            which alternative mappings are required. The -D and -d options are
 281            mutually exclusive.
 282 
 283        -E errfile
 284            Direct error messages for the analyzed objects to errfile instead
 285            of stdout.
 286 
 287        -e exfile
 288            An exception file is used to exclude objects from the usual rules.
 289            See EXCEPTION FILE FORMAT.
 290 
 291        -f listfile
 292            Normally, interface_check runs find_elf to locate the ELF objects
 293            to analyze. The -f option can be used to instead provide a file
 294            containing the list of objects to analyze, in the format produced
 295            by 'find_elf -r'.
 296 
 297        -I infofile
 298            Direct informational messages (-i, and -v options) for the analyzed
 299            objects to infofile instead of stdout.
 300 


 476        variable exists, and indicates an earlier release than 5.10 then ldd(1)
 477        also falls back to using the -u option.
 478 
 479        RELEASE
 480            The release version number of the environment being built.
 481 
 482 ERROR CONDITIONS
 483        Inspection of an object with ldd(1) assumes it is compatible with the
 484        machine on which check_rtime is being run.  Incompatible objects such
 485        as a 64-bit object encountered on a 32-bit system, or an i386 object
 486        encountered on a sparc system, can not be fully inspected.  These
 487        objects are displayed as:
 488 
 489            foo: has wrong class or data encoding
 490 
 491 FILES
 492             $CODEMGR_WS/exception_list/check_rtime
 493             /opt/onbld/etc/exception_list/check_rtime
 494 
 495 SEE ALSO
 496        crle(1), elfdump(1), find_elf(1ONBLD), ldd(1), ld.so.1(1), mcs(1).
 497 
 498 
 499 
 500                                  09 March 2010             check_rtime(1ONBLD)