SCONS-TIME1SCons __VERSION__SCons __VERSION__scons-timegenerate and display SCons timing informationscons-timesubcommandoptionsargumentsGenerating Timing Informationscons-time run
[]
[PROJECT]
[FILE]
[NUMBER]
[OUTDIR]
[STRING]
[PYTHON]
[DIR]
[SCONS]
[URL]
[ARGUMENTS]Extracting Function Timingsscons-time func
[]
[DIR]
[FILE]
[FORMAT]
[NAME]
[STRING]
[NUMBER]
[]
[ARGUMENTS]Extracting Memory Statisticsscons-time mem
[]
[DIR]
[FILE]
[FORMAT]
[STRING]
[STAGE]
[NUMBER]
[TITLE]
[ARGUMENTS]Extracting Object Countsscons-time obj
[]
[DIR]
[FILE]
[FORMAT]
[STRING]
[STAGE]
[NUMBER]
[TITLE]
[ARGUMENTS]Extracting Execution Timesscons-time time
[]
[DIR]
[FILE]
[FORMAT]
[STRING]
[NUMBER]
[TITLE]
[WHICH]
[ARGUMENTS]Help Textscons-time helpSUBCOMMAND
[...]DESCRIPTIONThe
scons-time
command runs an SCons configuration
through a standard set of profiled timings
and can extract and graph information from the
resulting profiles and log files of those timings.
The action to be performed by the
scons-time
script is specified
by a subcommand, the first argument on the command line.
See the
SUBCOMMANDS
section below for information about the operation
of specific subcommands.The basic way to use
scons-time
is to run the
scons-time run
subcommand
(possibly multiple times)
to generate profile and log file output,
and then use one of the other
subcommands to display the results
captured in the profiles and log files
for a particular kind of information:
function timings
(the
scons-time func
subcommand),
total memory used
(the
scons-time mem
subcommand),
object counts
(the
scons-time obj
subcommand)
and overall execution time
(the
scons-time time
subcommand).
Options exist to place and find the
profiles and log files in separate directories,
to generate the output in a format suitable
for graphing with the
gnuplot1
program,
and so on.There are two basic ways the
scons-time run
subcommand
is intended to be used
to gather timing statistics
for a configuration.
One is to use the
option to test a configuration against
a list of revisions from the SCons Subversion repository.
This will generate a profile and timing log file
for every revision listed with the
option,
and can be used to look at the
impact of committed changes to the
SCons code base on a particular
configuration over time.The other way is to profile incremental changes to a
local SCons code base during a development cycle--that is,
to look at the performance impact of changes
you're making in the local tree.
In this mode,
you run the
scons-time run
subcommand
without
the
option,
in which case it simply looks in the profile/log file output directory
(the current directory by default)
and automatically figures out the
next
run number for the output profile and log file.
Used in this way,
the development cycle goes something like:
make a change to SCons;
run
scons-time run
to profile it against a specific configuration;
make another change to SCons;
run
scons-time run
again to profile it;
etc.OPTIONSThe
scons-time
command only supports a few global options:-h, --helpDisplays the global help text and exits,
identical to the
scons-time help
subcommand.-V, --versionDisplays the
scons-time
version and exits.Most functionality is controlled by options
to the individual subcommands.
See the next section for information
about individual subcommand options.SUBCOMMANDSThe
scons-time
command supports the following
individual subcommands.The func Subcommandscons-time func
[]
[DIR]
[FILE]
[FORMAT]
[NAME]
[STRING]
[NUMBER]
[]
[ARGUMENTS]The
scons-time func
subcommand displays timing information
for a specific Python function within SCons.
By default, it extracts information about the
_main()
function,
which includes the Python profiler timing
for all of SCons.The
scons-time func
subcommand extracts function timing information
from all the specified file arguments,
which should be Python profiler output files.
(Normally, these would be
*.prof
files generated by the
scons-time run
subcommand,
but they can actually be generated
by any Python profiler invocation.)
All file name arguments will be
globbed for on-disk files.If no arguments are specified,
then function timing information
will be extracted from all
*.prof
files,
or the subset of them
with a prefix specified by the
option.Options include:-C DIRECTORY, --chdir=DIRECTORYChanges to the specified
DIRECTORY
before looking for the specified files
(or files that match the specified patterns).-f FILE, --file=FILEReads configuration information from the specified
FILE.-fmt=FORMAT, --format=FORMATReports the output in the specified
FORMAT.
The formats currently supported are
ascii
(the default)
and
gnuplot.--func=NAMEExtracts timings for the specified function
NAME.
The default is to report cumulative timings for the
_main()
function,
which contains the entire SCons run.-h, --helpDisplays help text for the
scons-time func
subcommand.-p STRING, --prefix=STRINGSpecifies the prefix string for profiles
from which to extract function timing information.
This will be used to search for profiles
if no arguments are specified on the command line.-t NUMBER, --tail=NUMBEROnly extracts function timings from the last
NUMBER
files.The help Subcommandscons-time helpSUBCOMMAND
[...]
The
help
subcommand prints help text for any
other subcommands listed as later arguments on the command line.The mem Subcommandscons-time mem
[]
[DIR]
[FILE]
[FORMAT]
[STRING]
[STAGE]
[NUMBER]
[TITLE]
[ARGUMENTS]The
scons-time mem
subcommand displays how much memory SCons uses.The
scons-time mem
subcommand extracts memory use information
from all the specified file arguments,
which should be files containing output from
running SCons with the
option.
(Normally, these would be
*.log
files generated by the
scons-time run
subcommand.)
All file name arguments will be
globbed for on-disk files.If no arguments are specified,
then memory information
will be extracted from all
*.log
files,
or the subset of them
with a prefix specified by the
option.-C DIR, --chdir=DIRChanges to the specified
DIRECTORY
before looking for the specified files
(or files that match the specified patterns).-f FILE, --file=FILEReads configuration information from the specified
FILE.-fmt=FORMAT, --format=FORMATReports the output in the specified
FORMAT.
The formats currently supported are
ascii
(the default)
and
gnuplot.-h, --helpDisplays help text for the
scons-time mem
subcommand.-p STRING, --prefix=STRINGSpecifies the prefix string for log files
from which to extract memory usage information.
This will be used to search for log files
if no arguments are specified on the command line.--stage=STAGEPrints the memory used at the end of the specified
STAGE:
pre-read
(before the SConscript files are read),
post-read ,
(after the SConscript files are read),
pre-build
(before any targets are built)
or
post-build
(after any targets are built).
If no
option is specified,
the default behavior is
post-build,
which reports the final amount of memory
used by SCons during each run.-t NUMBER, --tail=NUMBEROnly reports memory statistics from the last
NUMBER
files.The obj Subcommandscons-time obj
[]
[DIR]
[FILE]
[FORMAT]
[STRING]
[STAGE]
[NUMBER]
[TITLE]
[ARGUMENTS]The
scons-time obj
subcommand displays how many objects of a specific named type
are created by SCons.The
scons-time obj
subcommand extracts object counts
from all the specified file arguments,
which should be files containing output from
running SCons with the
option.
(Normally, these would be
*.log
files generated by the
scons-time run
subcommand.)
All file name arguments will be
globbed for on-disk files.If no arguments are specified,
then object counts
will be extracted from all
*.log
files,
or the subset of them
with a prefix specified by the
option.-C DIR, --chdir=DIRChanges to the specified
DIRECTORY
before looking for the specified files
(or files that match the specified patterns).-f FILE, --file=FILEReads configuration information from the specified
FILE.-fmt=FORMAT, --format=FORMATReports the output in the specified
FORMAT.
The formats currently supported are
ascii
(the default)
and
gnuplot.-h, --helpDisplays help text for the
scons-time obj
subcommand.-p STRING, --prefix=STRINGSpecifies the prefix string for log files
from which to extract object counts.
This will be used to search for log files
if no arguments are specified on the command line.--stage=STAGEPrints the object count at the end of the specified
STAGE:
pre-read
(before the SConscript files are read),
post-read ,
(after the SConscript files are read),
pre-build
(before any targets are built)
or
post-build
(after any targets are built).
If no
option is specified,
the default behavior is
post-build,
which reports the final object count during each run.-t NUMBER, --tail=NUMBEROnly reports object counts from the last
NUMBER
files.The run Subcommandscons-time run
[]
[PROJECT]
[FILE]
[NUMBER]
[OUTDIR]
[STRING]
[PYTHON]
[DIR]
[SCONS]
[URL]
[ARGUMENTS]
The
scons-time run
subcommand is the basic subcommand
for profiling a specific configuration
against a version of SCons.The configuration to be tested
is specified as a list of files
or directories that will be unpacked or copied
into a temporary directory
in which SCons will be invoked.
The
scons-time run
subcommand understands file suffixes like
.tar,
.tar.gz,
.tgz
and
.zip
and will unpack their contents into a temporary directory.
If more than one argument is specified,
each one will be unpacked or copied
into the temporary directory "on top of"
the previous archives or directories,
so the expectation is that multiple
specified archives share the same directory layout.Once the file or directory arguments are unpacked or
copied to the temporary directory,
the
scons-time run
subcommand runs the
requested version of SCons
against the configuration
three times:StartupSCons is run with the
option so that just the SConscript files are read,
and then the default help text is printed.
This profiles just the perceived "overhead" of starting up SCons
and processing the SConscript files.Full buildSCons is run to build everything specified in the configuration.
Specific targets to be passed in on the command l ine
may be specified by the
targets
keyword in a configuration file; see below for details.RebuildSCons is run again on the same just-built directory.
If the dependencies in the SCons configuration are correct,
this should be an up-to-date, "do nothing" rebuild.Each invocation captures the output log file and a profile.The
scons-time run
subcommand supports the following options:--aegis=PROJECTSpecifies the Aegis
PROJECT
from which the
version(s) of
scons
being timed will be extracted.
When
is specified, the
NUMBER
option specifies delta numbers
that will be tested.
Output from each invocation run will be placed in file
names that match the Aegis delta numbers.
If the
option is not specified,
then the default behavior is to time the
tip of the specified
PROJECT.-f FILE, --file=FILEReads configuration information from the specified
FILE.
This often provides a more convenient way to specify and
collect parameters associated with a specific timing configuration
than specifying them on the command line.
See the
CONFIGURATION FILE
section below
for information about the configuration file parameters.-h, --helpDisplays help text for the
scons-time run
subcommand.-n, --no-execDo not execute commands,
just printing the command-line equivalents of what would be executed.
Note that the
scons-time
script actually executes its actions in Python,
where possible,
for portability.
The commands displayed are UNIX
equivalents
of what it's doing.--number=NUMBERSpecifies the run number to be used in the names of
the log files and profile outputs generated by this run.When used in conjunction with the
PROJECT
option,
NUMBER
specifies one or more comma-separated Aegis delta numbers
that will be retrieved automatically from the specified Aegis
PROJECT.When used in conjunction with the
URL
option,
NUMBER
specifies one or more comma-separated Subversion revision numbers
that will be retrieved automatically from the Subversion
repository at the specified
URL.
Ranges of delta or revision numbers
may be specified be separating two numbers
with a hyphen
(-).Example:
% scons-time run --svn=http://scons.tigris.org/svn/trunk --num=1247,1249-1252 .
-p STRING, --prefix=STRINGSpecifies the prefix string to be used for all of the log files
and profiles generated by this run.
The default is derived from the first
specified argument:
if the first argument is a directory,
the default prefix is the name of the directory;
if the first argument is an archive
(tar or zip file),
the default prefix is the the base name of the archive,
that is, what remains after stripping the archive suffix
(.tgz, .tar.gz or .zip).--python=PYTHONSpecifies a path to the Python executable to be used
for the timing runs.
The default is to use the same Python executable that
is running the
scons-time
command itself.-q, --quietSuppresses display of the command lines being executed.-s DIR, --subdir=DIRSpecifies the name of directory or subdirectory
from which the commands should be executed.
The default is XXX--scons=SCONSSpecifies a path to the SCons script to be used
for the timing runs.
The default is XXX--svn=URL, --subversion=URLSpecifies the
URL
of the Subversion repository from which the
version(s) of
scons
being timed will be extracted.
When
is specified, the
NUMBER
option specifies revision numbers
that will be tested.
Output from each invocation run will be placed in file
names that match the Subversion revision numbers.
If the
option is not specified,
then the default behavior is to time the
HEAD
of the specified
URL.-v, --verboseDisplays the output from individual commands to the screen
(in addition to capturing the output in log files).The time Subcommandscons-time time
[]
[DIR]
[FILE]
[FORMAT]
[STRING]
[NUMBER]
[TITLE]
[WHICH]
[ARGUMENTS]The
scons-time time
subcommand displays SCons execution times
as reported by the
scons --debug=time
option.The
scons-time time
subcommand extracts SCons timing
from all the specified file arguments,
which should be files containing output from
running SCons with the
option.
(Normally, these would be
*.log
files generated by the
scons-time run
subcommand.)
All file name arguments will be
globbed for on-disk files.If no arguments are specified,
then execution timings
will be extracted from all
*.log
files,
or the subset of them
with a prefix specified by the
option.-C DIR, --chdir=DIRChanges to the specified
DIRECTORY
before looking for the specified files
(or files that match the specified patterns).-f FILE, --file=FILEReads configuration information from the specified
FILE.-fmt=FORMAT, --format=FORMATReports the output in the specified
FORMAT.
The formats currently supported are
ascii
(the default)
and
gnuplot.-h, --helpDisplays help text for the
scons-time time
subcommand.-p STRING, --prefix=STRINGSpecifies the prefix string for log files
from which to extract execution timings.
This will be used to search for log files
if no arguments are specified on the command line.-t NUMBER, --tail=NUMBEROnly reports object counts from the last
NUMBER
files.--which=WHICHPrints the execution time for the specified
WHICH
value:
total
(the total execution time),
SConscripts
(total execution time for the SConscript files themselves),
SCons
(exectuion time in SCons code itself)
or
commands
(execution time of the commands and other actions
used to build targets).
If no
option is specified,
the default behavior is
total,
which reports the total execution time for each run.CONFIGURATION FILEVarious
scons-time
subcommands can read information from a specified
configuration file when passed the
or
options.
The configuration file is actually executed as a Python script.
Setting Python variables in the configuration file
controls the behavior of the
scons-time
script more conveniently than having to specify
command-line options or arguments for every run,
and provides a handy way to "shrink-wrap"
the necessary information for producing (and reporting)
consistent timing runs for a given configuration.aegisThe Aegis executable for extracting deltas.
The default is simply
aegis.aegis_projectThe Aegis project from which deltas should be extracted.
The default is whatever is specified
with the
command-line option.archive_listA list of archives (files or directories)
that will be copied to the temporary directory
in which SCons will be invoked.
.tar,
.tar.gz,
.tgz
and
.zip
files will have their contents unpacked in
the temporary directory.
Directory trees and files will be copied as-is.initial_commandsA list of commands that will be executed
before the actual timed
scons
runs.
This can be used for commands that are necessary
to prepare the source tree-for example,
creating a configuration file
that should not be part of the timed run.key_locationThe location of the key on Gnuplot graphing information
generated with the
option.
The default is
bottom left.prefixThe file name prefix to be used when
running or extracting timing for this configuration.pythonThe path name of the Python executable
to be used when running or extracting information
for this configuration.
The default is the same version of Python
used to run the SConssconsThe path name of the SCons script to be used
when running or extracting information
for this configuration.
The default is simply
scons.scons_flagsThe
scons
flags used when running SCons to collect timing information.
The default value is
.scons_lib_dirscons_wrapperstartup_targetssubdirThe subdirectory of the project into which the
scons-time
script should change
before executing the SCons commands to time.subversion_urlThe Subversion URL fromsvnThe subversion executable used to
check out revisions of SCons to be timed.
The default is simple
svn.svn_co_flagtartargetsA string containing the targets that should be added to
the command line of every timed
scons
run.
This can be used to restrict what's being timed to a
subset of the full build for the configuration.targets0targets1targets2titleunzipverbosevertical_barsExampleHere is an example
scons-time
configuration file
for a hypothetical sample project:
# The project doesn't use SCons natively (yet), so we're
# timing a separate set of SConscript files that we lay
# on top of the vanilla unpacked project tarball.
arguments = ['project-1.2.tgz', 'project-SConscripts.tar']
# The subdirectory name contains the project version number,
# so tell scons-time to chdir there before building.
subdir = 'project-1.2'
# Set the prefix so output log files and profiles are named:
# project-000-[012].{log,prof}
# project-001-[012].{log,prof}
# etc.
prefix = 'project'
# The SConscript files being tested don't do any SConf
# configuration, so run their normal ./configure script
# before we invoke SCons.
initial_commands = [
'./configure',
]
# Only time building the bin/project executable.
targets = 'bin/project'
# Time against SCons revisions of the branches/core branch
subversion_url = 'http://scons.tigris.org/svn/scons/branches/core'
ENVIRONMENTThe
scons-time
script uses the following environment variables:PRESERVEIf this value is set,
the
scons-time
script will
not
remove the temporary directory or directories
in which it builds the specified configuration
or downloads a specific version of SCons.SEE ALSOgnuplot1,
scons1AUTHORSSteven Knight <knight at baldmt dot com>