SCONS-TIME(1) SCONS-TIME(1) NNAAMMEE scons-time - generate and display SCons timing information SSYYNNOOPPSSIISS ssccoonnss--ttiimmee _s_u_b_c_o_m_m_a_n_d [ _o_p_t_i_o_n_s... ] [ _a_r_g_u_m_e_n_t_s... ] GGeenneerraattiinngg TTiimmiinngg IInnffoorrmmaattiioonn ssccoonnss--ttiimmee rruunn [--hhnnqqvv] [----aaeeggiiss==_P_R_O_J_E_C_T] [--ff _F_I_L_E] [----nnuummbbeerr==_N_U_M_B_E_R] [----oouuttddiirr==_O_U_T_D_I_R] [--pp _S_T_R_I_N_G] [----ppyytthhoonn==_P_Y_T_H_O_N] [--ss _D_I_R] [----ssccoonnss==_S_C_O_N_S] [----ssvvnn==_U_R_L] [_A_R_G_U_M_E_N_T_S] EExxttrraaccttiinngg FFuunnccttiioonn TTiimmiinnggss ssccoonnss--ttiimmee ffuunncc [--hh] [----cchhddiirr==_D_I_R] [--ff _F_I_L_E] [----ffmmtt==_F_O_R_M_A_T] [----ffuunncc==_N_A_M_E] [--pp _S_T_R_I_N_G] [--tt _N_U_M_B_E_R] [----ttiittllee== TTIITTLLEE] [_A_R_G_U_M_E_N_T_S] EExxttrraaccttiinngg MMeemmoorryy SSttaattiissttiiccss EExxttrraaccttiinngg OObbjjeecctt CCoouunnttss ssccoonnss--ttiimmee oobbjj [--hh] [----cchhddiirr==_D_I_R] [--ff _F_I_L_E] [----ffmmtt==_F_O_R_M_A_T] [--pp _S_T_R_I_N_G] [----ssttaaggee==_S_T_A_G_E] [--tt _N_U_M_B_E_R] [----ttiittllee==_T_I_T_L_E] [_A_R_G_U_M_E_N_T_S] EExxttrraaccttiinngg EExxeeccuuttiioonn TTiimmeess ssccoonnss--ttiimmee ttiimmee [--hh] [----cchhddiirr==_D_I_R] [--ff _F_I_L_E] [----ffmmtt==_F_O_R_M_A_T] [--pp _S_T_R_I_N_G] [--tt _N_U_M_B_E_R] [----ttiittllee==_T_I_T_L_E] [----wwhhiicchh==_W_H_I_C_H] [_A_R_G_U_M_E_N_T_S] HHeellpp TTeexxtt ssccoonnss--ttiimmee hheellpp _S_U_B_C_O_M_M_A_N_D [...] DDEESSCCRRIIPPTTIIOONN The ssccoonnss--ttiimmee 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 ssccoonnss--ttiimmee script is specified by a subcommand, the first argument on the command line. See the SSUUBBCCOOMMMMAANNDDSS section below for information about the operation of specific subcommands. The basic way to use ssccoonnss--ttiimmee is to run the ssccoonnss--ttiimmee rruunn 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 ssccoonnss--ttiimmee ffuunncc subcommand), total memory used (the ssccoonnss--ttiimmee mmeemm subcommand), object counts (the ssccoonnss--ttiimmee oobbjj subcommand) and overall execution time (the ssccoonnss--ttiimmee ttiimmee 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 ggnnuupplloott(1) program, and so on. There are two basic ways the ssccoonnss--ttiimmee rruunn subcommand is intended to be used to gather timing statistics for a configuration. One is to use the ----ssvvnn== 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 ----nnuummbbeerr== option, and can be used to look at the impact of commited 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 ssccoonnss--ttiimmee rruunn subcommand _w_i_t_h_o_u_t the ----ssvvnn== option, in which case it simply looks in the profile/log file output directory (the current directory by default) and automatically figures out the _n_e_x_t 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 ssccoonnss--ttiimmee rruunn to profile it against a specific configuration; make another change to SCons; run ssccoonnss--ttiimmee rruunn again to profile it; etc. OOPPTTIIOONNSS The ssccoonnss--ttiimmee command only supports a few global options: -h, --help Displays the global help text and exits, identical to the ssccoonnss-- ttiimmee hheellpp subcommand. -V, --version Displays the ssccoonnss--ttiimmee version and exits. Most functionality is controlled by options to the individual subcommands. See the next section for information about individual subcommand options. SSUUBBCCOOMMMMAANNDDSS The ssccoonnss--ttiimmee command supports the following individual subcommands. TThhee ffuunncc SSuubbccoommmmaanndd ssccoonnss--ttiimmee ffuunncc [--hh] [----cchhddiirr==_D_I_R] [--ff _F_I_L_E] [----ffmmtt==_F_O_R_M_A_T] [----ffuunncc==_N_A_M_E] [--pp _S_T_R_I_N_G] [--tt _N_U_M_B_E_R] [----ttiittllee== TTIITTLLEE] [_A_R_G_U_M_E_N_T_S] The ssccoonnss--ttiimmee ffuunncc subcommand displays timing information for a specific Python function within SCons. By default, it extracts information about the __mmaaiinn() function, which includes the Python profiler timing for all of SCons. The ssccoonnss--ttiimmee ffuunncc subcommand extracts function timing information from all the specified file arguments, which should be Python profiler output files. (Normally, these would be **..pprrooff files generated by the ssccoonnss--ttiimmee rruunn 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 **..pprrooff files, or the subset of them with a prefix specified by the --pp option. Options include: -C DIRECTORY, --chdir=DIRECTORY Changes to the specified _D_I_R_E_C_T_O_R_Y before looking for the specified files (or files that match the specified patterns). -f FILE, --file=FILE Reads configuration information from the specified _F_I_L_E. -fmt=FORMAT, --format=FORMAT Reports the output in the specified _F_O_R_M_A_T. The formats currently supported are aasscciiii (the default) and ggnnuupplloott. --func=NAME Extracts timings for the specified function _N_A_M_E. The default is to report cumulative timings for the __mmaaiinn() function, which contains the entire SCons run. -h, --help Displays help text for the ssccoonnss--ttiimmee ffuunncc subcommand. -p STRING, --prefix=STRING Specifies 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=NUMBER Only extracts function timings from the last _N_U_M_B_E_R files. TThhee hheellpp SSuubbccoommmmaanndd ssccoonnss--ttiimmee hheellpp _S_U_B_C_O_M_M_A_N_D [...] The hheellpp subcommand prints help text for any other subcommands listed as later arguments on the command line. TThhee mmeemm SSuubbccoommmmaanndd The ssccoonnss--ttiimmee mmeemm subcommand displays how much memory SCons uses. The ssccoonnss--ttiimmee mmeemm subcommand extracts memory use information from all the specified file arguments, which should be files containing output from running SCons with the ----ddeebbuugg==mmeemmoorryy option. (Normally, these would be **..lloogg files generated by the ssccoonnss--ttiimmee rruunn 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 **..lloogg files, or the subset of them with a prefix specified by the --pp option. -C DIR, --chdir=DIR Changes to the specified _D_I_R_E_C_T_O_R_Y before looking for the specified files (or files that match the specified patterns). -f FILE, --file=FILE Reads configuration information from the specified _F_I_L_E. -fmt=FORMAT, --format=FORMAT Reports the output in the specified _F_O_R_M_A_T. The formats currently supported are aasscciiii (the default) and ggnnuupplloott. -h, --help Displays help text for the ssccoonnss--ttiimmee mmeemm subcommand. -p STRING, --prefix=STRING Specifies 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=STAGE Prints the memory used at the end of the specified _S_T_A_G_E: pprree-- rreeaadd (before the SConscript files are read), ppoosstt--rreeaadd ,, (after the SConscript files are read), pprree--bbuuiilldd (before any targets are built) or ppoosstt--bbuuiilldd (after any targets are built). If no ----ssttaaggee option is specified, the default behavior is ppoosstt--bbuuiilldd, which reports the final amount of memory used by SCons during each run. -t NUMBER, --tail=NUMBER Only reports memory statistics from the last _N_U_M_B_E_R files. TThhee oobbjj SSuubbccoommmmaanndd ssccoonnss--ttiimmee oobbjj [--hh] [----cchhddiirr==_D_I_R] [--ff _F_I_L_E] [----ffmmtt==_F_O_R_M_A_T] [--pp _S_T_R_I_N_G] [----ssttaaggee==_S_T_A_G_E] [--tt _N_U_M_B_E_R] [----ttiittllee==_T_I_T_L_E] [_A_R_G_U_M_E_N_T_S] The ssccoonnss--ttiimmee oobbjj subcommand displays how many objects of a specific named type are created by SCons. The ssccoonnss--ttiimmee oobbjj subcommand extracts object counts from all the specified file arguments, which should be files containing output from running SCons with the ----ddeebbuugg==ccoouunntt option. (Normally, these would be **..lloogg files generated by the ssccoonnss--ttiimmee rruunn 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 **..lloogg files, or the subset of them with a prefix specified by the --pp option. -C DIR, --chdir=DIR Changes to the specified _D_I_R_E_C_T_O_R_Y before looking for the specified files (or files that match the specified patterns). -f FILE, --file=FILE Reads configuration information from the specified _F_I_L_E. -fmt=FORMAT, --format=FORMAT Reports the output in the specified _F_O_R_M_A_T. The formats currently supported are aasscciiii (the default) and ggnnuupplloott. -h, --help Displays help text for the ssccoonnss--ttiimmee oobbjj subcommand. -p STRING, --prefix=STRING Specifies 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=STAGE Prints the object count at the end of the specified _S_T_A_G_E: pprree-- rreeaadd (before the SConscript files are read), ppoosstt--rreeaadd ,, (after the SConscript files are read), pprree--bbuuiilldd (before any targets are built) or ppoosstt--bbuuiilldd (after any targets are built). If no ----ssttaaggee option is specified, the default behavior is ppoosstt--bbuuiilldd, which reports the final object count during each run. -t NUMBER, --tail=NUMBER Only reports object counts from the last _N_U_M_B_E_R files. TThhee rruunn SSuubbccoommmmaanndd ssccoonnss--ttiimmee rruunn [--hhnnqqvv] [----aaeeggiiss==_P_R_O_J_E_C_T] [--ff _F_I_L_E] [----nnuummbbeerr==_N_U_M_B_E_R] [----oouuttddiirr==_O_U_T_D_I_R] [--pp _S_T_R_I_N_G] [----ppyytthhoonn==_P_Y_T_H_O_N] [--ss _D_I_R] [----ssccoonnss==_S_C_O_N_S] [----ssvvnn==_U_R_L] [_A_R_G_U_M_E_N_T_S] The ssccoonnss--ttiimmee rruunn 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 ssccoonnss--ttiimmee rruunn subcommand understands file suffixes like ..ttaarr, ..ttaarr..ggzz, ..ttggzz and ..zziipp 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 ssccoonnss--ttiimmee rruunn subcommand runs the requested version of SCons against the configuration three times: Startup SCons is run with the ----hheellpp 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 build SCons 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 ttaarrggeettss keyword in a configuration file; see below for details. Rebuild SCons 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 ssccoonnss--ttiimmee rruunn subcommand supports the following options: --aegis=PROJECT Specifies the Aegis _P_R_O_J_E_C_T from which the version(s) of ssccoonnss being timed will be extracted. When ----aaeeggiiss is specified, the ----nnuummbbeerr==_N_U_M_B_E_R 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 ----nnuummbbeerr== option is not specified, then the default behavior is to time the tip of the specified _P_R_O_J_E_C_T. -f FILE, --file=FILE Reads configuration information from the specified _F_I_L_E. 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 CCOONNFFIIGGUURRAATTIIOONN FFIILLEE section below for information about the configuration file parameters. -h, --help Displays help text for the ssccoonnss--ttiimmee rruunn subcommand. -n, --no-exec Do not execute commands, just printing the command-line equivalents of what would be executed. Note that the ssccoonnss--ttiimmee script actually executes its actions in Python, where possible, for portability. The commands displayed are UNIX _e_q_u_i_v_a_l_e_n_t_s of what it's doing. --number=NUMBER Specifies the run number to be used in the names of the log files and profile outputs generated by this run. When used in conjuction with the ----aaeeggiiss==_P_R_O_J_E_C_T option, _N_U_M_B_E_R specifies one or more comma-separated Aegis delta numbers that will be retrieved automatically from the specified Aegis _P_R_O_J_E_C_T. When used in conjuction with the ----ssvvnn==_U_R_L option, _N_U_M_B_E_R specifies one or more comma-separated Subversion revision numbers that will be retrieved automatically from the Subversion repository at the specified _U_R_L. 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=STRING Specifies 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 strip- ping the archive suffix (..ttggzz, ..ttaarr..ggzz or ..zziipp). --python=PYTHON Specifies 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 ssccoonnss--ttiimmee command itself. -q, --quiet Suppresses display of the command lines being executed. -s DIR, --subdir=DIR Specifies the name of directory or subdirectory from which the commands should be executed. The default is XXX --scons=SCONS Specifies a path to the SCons script to be used for the timing runs. The default is XXX --svn=URL, --subversion=URL Specifies the _U_R_L of the Subversion repository from which the version(s) of ssccoonnss being timed will be extracted. When ----ssvvnn is specified, the ----nnuummbbeerr==_N_U_M_B_E_R option spec- ifies 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 ----nnuummbbeerr== option is not specified, then the default behavior is to time the HHEEAADD of the specified _U_R_L. -v, --verbose Displays the output from individual commands to the screen (in addition to capturing the output in log files). TThhee ttiimmee SSuubbccoommmmaanndd ssccoonnss--ttiimmee ttiimmee [--hh] [----cchhddiirr==_D_I_R] [--ff _F_I_L_E] [----ffmmtt==_F_O_R_M_A_T] [--pp _S_T_R_I_N_G] [--tt _N_U_M_B_E_R] [----ttiittllee==_T_I_T_L_E] [----wwhhiicchh==_W_H_I_C_H] [_A_R_G_U_M_E_N_T_S] The ssccoonnss--ttiimmee ttiimmee subcommand displays SCons execution times as reported by the ssccoonnss ----ddeebbuugg==ttiimmee option. The ssccoonnss--ttiimmee ttiimmee subcommand extracts SCons timing from all the spec- ified file arguments, which should be files containing output from run- ning SCons with the ----ddeebbuugg==ttiimmee option. (Normally, these would be **..lloogg files generated by the ssccoonnss--ttiimmee rruunn 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 **..lloogg files, or the subset of them with a prefix specified by the --pp option. -C DIR, --chdir=DIR Changes to the specified _D_I_R_E_C_T_O_R_Y before looking for the speci- fied files (or files that match the specified patterns). -f FILE, --file=FILE Reads configuration information from the specified _F_I_L_E. -fmt=FORMAT, --format=FORMAT Reports the output in the specified _F_O_R_M_A_T. The formats cur- rently supported are aasscciiii (the default) and ggnnuupplloott. -h, --help Displays help text for the ssccoonnss--ttiimmee ttiimmee subcommand. -p STRING, --prefix=STRING Specifies 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=NUMBER Only reports object counts from the last _N_U_M_B_E_R files. --which=WHICH Prints the execution time for the specified _W_H_I_C_H value: ttoottaall (the total execution time), SSCCoonnssccrriippttss (total execution time for the SConscript files themselves), SSCCoonnss (exectuion time in SCons code itself) or ccoommmmaannddss (execution time of the commands and other actions used to build targets). If no ----wwhhiicchh option is specified, the default behavior is ttoottaall, which reports the total execution time for each run. CCOONNFFIIGGUURRAATTIIOONN FFIILLEE Various ssccoonnss--ttiimmee subcommands can read information from a specified configuration file when passed the --ff or ----ffiillee options. The configu- ration file is actually executed as a Python script. Setting Python variables in the configuration file controls the behavior of the ssccoonnss-- ttiimmee 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. aaeeggiiss The Aegis executable for extracting deltas. The default is sim- ply aaeeggiiss. aaeeggiiss__pprroojjeecctt The Aegis project from which deltas should be extracted. The default is whatever is specified with the ----aaeeggiiss== command-line option. aarrcchhiivvee__lliisstt A list of archives (files or directories) that will be copied to the temporary directory in which SCons will be invoked. ..ttaarr, ..ttaarr..ggzz, ..ttggzz and ..zziipp files will have their contents unpacked in the temporary directory. Directory trees and files will be copied as-is. iinniittiiaall__ccoommmmaannddss A list of commands that will be executed before the actual timed ssccoonnss 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. kkeeyy__llooccaattiioonn The location of the key on Gnuplot graphing information gener- ated with the ----ffoorrmmaatt==ggnnuupplloott option. The default is bboottttoomm lleefftt. pprreeffiixx The file name prefix to be used when running or extracting tim- ing for this configuration. ppyytthhoonn The 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 SCons ssccoonnss The path name of the SCons script to be used when running or extracting information for this configuration. The default is simply ssccoonnss. ssccoonnss__ffllaaggss The ssccoonnss flags used when running SCons to collect timing infor- mation. The default value is ----ddeebbuugg==ccoouunntt ----ddeebbuugg==mmeemmoorryy ----ddeebbuugg==ttiimmee ----ddeebbuugg==mmeemmooiizzeerr. ssccoonnss__lliibb__ddiirr ssccoonnss__wwrraappppeerr ssttaarrttuupp__ttaarrggeettss ssuubbddiirr The subdirectory of the project into which the ssccoonnss--ttiimmee script should change before executing the SCons commands to time. ssuubbvveerrssiioonn__uurrll The Subversion URL from ssvvnn The subversion executable used to check out revisions of SCons to be timed. The default is simple ssvvnn. ssvvnn__ccoo__ffllaagg ttaarr ttaarrggeettss A string containing the targets that should be added to the com- mand line of every timed ssccoonnss run. This can be used to restrict what's being timed to a subset of the full build for the configuration. ttaarrggeettss00 ttaarrggeettss11 ttaarrggeettss22 ttiittllee uunnzziipp vveerrbboossee vveerrttiiccaall__bbaarrss EExxaammppllee Here is an example ssccoonnss--ttiimmee 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' EENNVVIIRROONNMMEENNTT The ssccoonnss--ttiimmee script uses the following environment variables: PPRREESSEERRVVEE If this value is set, the ssccoonnss--ttiimmee script will _n_o_t remove the temporary directory or directories in which it builds the speci- fied configuration or downloads a specific version of SCons. SSEEEE AALLSSOO ggnnuupplloott(1), ssccoonnss(1) AAUUTTHHOORRSS Steven Knight July 2010 SCONS-TIME(1)