Automatic Interception Interface - Usage

Overview

1. Make sure the tool managing the process to be distributed supports parallel execution of non-dependent processes. For a list of common make tools supporting this feature, see this section. Note that in order to accelerate Microsoft NMAKE builds and other tools which do not appear in the list, it might be possible to use the Submission Interface.

2. Run the process to be distributed with the parallel process execution mode enabled (specify 4-5 max. concurrent processes for this test), to verify that all dependencies are correctly defined and that the process does not break when run in parallel. If necessary, add the relevant dependencies to your makefiles or data files so that the build completes correctly when executed in parallel mode.

3. Create a Profile XML file describing the tools which are to be executed remotely.

4. Run the tool, with the parallel process execution mode enabled, through xgConsole.exe (see below for more details).

Using xgConsole.exe Usage with the Automatic Interception Interface

Once the steps described have been above, the command line string used to run the tool with the parallel process execution mode enabled is specified as an input argument to xgConsole.exe (see examples below). The profile XML file is also specified in the command line arguments.

The process should execute in local parallel mode, with tools specified with "AllowRemote=True" in the Profile XML file executed on remote machines.

The basic command line syntax for running a distributed XML job through the XML Interface is:

• <TOOL COMMAND>- The command line string used to run the tool with the parallel process execution mode enabled.
• <PROFILE XML>- The Profile XML file.
• Other Options = refer to the xgConsole.exe section for more xgConsole.exe command line options.
  
  
  As an alternative to using a profile Profile XML file, it is possible to specify the AllowIntercept and AllowRemote directives explicitly in the xgConsole command line:

• <TOOL COMMAND>- The command line string used to run the tool with the parallel process execution mode enabled.
• <FILENAME1[,FILENAME2,...]>- a comma-separated list of tool filenames.
• Other Options = refer to the xgConsole.exe section for more xgConsole.exe command line options.

xgConsole.exe Examples for Common Make Tools:

• make:
  xgConsole.exe /command="make --file=makefile.mak --jobs=16" /profile="profile.xml"
• JAM:
  xgConsole.exe /command="jam -a -j16 mytarget" /profile="profile.xml"
• SCons:
  xgConsole.exe /command="SCons --sconstruct=mySCons --jobs=16" /profile="profile.xml"