Automatic Interception Interface Profile XML File
 

Automatic Interception Interface Profile XML File

The profile XML file is used to define how Automatic Interception Interface should handle the various processes involved in a distributed job.

Contents of This Page:

An Example

In this simple example, our goal is to distribute a main process run by MainProcess.exe. Our main process runs several sub-processes (DummySubProcess.exe) and ends with a link step (link.exe).

In this scenario, we would probably only want to distribute execution of sub-processes (DummySubProcess.exe). Distributing execution of the single link.exe task to a remote machine would involve sending a relatively large amount of data (.obj files, etc.) across the network, so it would probably be best to let this task always run on the initiating machine.

Syntax

The following profile.xml file can be used to run Automatic Interception Interface:

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<Profile FormatVersion="1">
    <Tools>
        <Tool Filename="MainProcess" AllowIntercept="true" />
        <Tool Filename="DummySubProcess" AllowRemote="true" />
        <Tool Filename="link" AllowRemote="false" />
    </Tools>
</Profile>

This command specifies that DummySubProcess.exe is to be executed 10 times:

IBConsole  /command="MainProcess.exe DummySubProcess.exe 10"  /profile="profile.xml"

Explanation

Usage

Once your profile.xml file is ready, it can be used with the following tools to distribute the build process using  Automatic Interception Interface:

Samples and Resources

The following is a detailed specification of the Profile XML file format. In addition to the information below, note the following useful resources:

Profile XML File Specification

The Profile XML file structure is as follows:

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<Profile FormatVersion="1">
    <Tools>
        <Tool ATTRIBUTES />
        ...
    </Tools>
</Profile>

A Tool element should be added for the following cases:

Description AllowRemote Value AllowIntercept Value
Executables whose executions are to be distributed to remote machines True False
Executables responsible for direct or indirect execution of remotely executed Tools False True
Executables to be executed locally (optional) False False

Tool Element Attributes

  1. Filename: The name of the tool (filename extension is optional). Note that wildcards (e.g. "TOOL*.exe") are allowed to support a single Tool definition that covers multiple tool names.
  2. AllowRemote: Execution of Tools with this attribute set to "True" are distributed to remote machines.
  3. AllowRemoteIf: Conditional Value to determine if a task should be distributed, or marked for execution on the local Agent, based on its command line. If the Value specified with this attribute is found in the tasks command line, the task will be marked as allowed to be distributed. The following is an example of how to use it:

    <Tool Filename="cl" AllowRemoteIf="-c,/c" />

    When the above is used in a profile files, only tasks of cl.exe that have the “-c” or “/c” string (without quotes) in the command line will be distributed to remote machines.
  4. AllowIntercept: Tools with this attribute set to "True" are monitored by Automatic Interception Interface. Any tool responsible for direct or indirect execution of remotely executed Tools (Tools with AllowRemote set to "True") should have AllowIntercept set to "True".
  5. DeriveCaptionFrom: This attribute controls the caption that appears in the task's build bar in the build monitor Progress View. The attribute accepts two pre-defined values:
    • firstparam – will echo the first parameter from the task's command line.
    • lastparam – will echo the last parameter from the task's command line.
  6. SingleInstancePerAgent: Tools with this attribute set to "True" never run concurrently on a single Agent – even if the Agent has multi-processor or multi-core hardware. Note that this attribute does not prevent tools from running on different Agents at the same time.
  7. AllowRestartOnLocal: For tools with this attribute set to "True", the initiating Agent will be allowed to apply the performance optimization activated by the "Restart remote processes on local machine when possible" Agent Settings option.
    Important: This attribute should not be set to True for tools that write incrementally to output files, as this might leave a "half-baked" output file if the local instance of the tool is terminated.
  8. SuccessExitCodes: This attribute specifies the exit code(s) that will be considered as success exit codes for the specified tool. Value is a comma-separated list of numerical values. Ranges are also allowed (e.g.: '2..19'). If omitted, the default success exit code for the tool will be 0.
  9. WarningExitCodes: This attribute specifies the exit code(s) that will be considered as warning exit codes for the specified tool. Tasks returning this exit code are displayed as a yellow bar in the Build Monitor Progress page and are counted as warnings in the Summary page. Value is a comma-separated list of numerical values. Ranges are also allowed (e.g.: '2..19').
  10. IdentifyTaskOutput: This attribute should be used whenever double-clicking on a progress bar in the Build Monitor Progress display doesn't work for a certain tool whose execution is distributed using either  Submission Interface or Automatic Interception Interface. When specified using the "True" attribute, IncrediBuild attempts to add textual identifiers to the tool's output to help locate it in the build's output text. The identifiers are removed from the final build output text. The following is a usage example:

    <Tool Filename="cl" AllowRemote="true" DeriveCaptionFrom="lastparam" IdentifyTaskOutput="true"/>
  11. AutoRecover: comma-separated list of strings which, when found in tool output, cause IncrediBuild to re-assign the task to another Agent and discard the previous output.
  12. TimeLimit: Time limit, in seconds, after which a remote task is automatically canceled and re-assigned to a different Agent.
  13. VCCompiler: When set to True (the default is False), this tool and its sub-processes are handled in the same way as the Visual Studio C/C++ compiler in terms of PDB and PCH handling. Use this property only when attempting to distribute execution of the Visual Studio C/C++ compiler through the IB Interfaces.
    The VCCompiler option is only available with the Visual Studio C/C++ Build System extension package.

  14. AutoReserveMemory: This attribute specifies that the tool utilizes memory mapping of files, typically used by compilers for implementing support for precompiled headers. The attribute should specify the file extension(s) of the files to be used with memory mapping (typically the precompiled header file extension). For example, to specify that a tool called "gcc" uses memory mapping for creating precompiled headers with the ".gch" extension, gcc's definition in the profile XML might look like: 

    <Tool Filename="gcc" AllowRemote="true" DeriveCaptionFrom="lastparam" AutoReserveMemory="*.gch"/>

    To specify more than one file extension, enter comma-separated values, e.g.: "*.gch,*.pch". <

  15. AdditionalOutputMask: This attribute specifies that the tool will return additional files to the initiating machine according to the provided mask. For example, to specify that a tool called "gcc" will return all the .log files it generates to the initiating machine, gcc's definition in the profile XML should look like:

    <Tool Filename="gcc" AllowRemote="true" DeriveCaptionFrom="lastparam" AdditionalOutputMask="*.log"/>

Note:

Important Notes

Automatic Interception Interface XML Schema

This section describes the XML schema that is used to build the configuration file for Automatic Interception Interface. A detailed explanation of the XML schema can be found in the XML Interface chapter.

The XML file defines the behavior of the integration using Interception Interface, including those processes that can be distributed and those that will run locally. The XML file describes a set of rules that apply to tasks being executed by IncrediBuild. A rule applies to all tasks sharing the same name. For example, the XML defines the task "Render" as AllowRemote, A job may include several instances of Render; each will be processed remotely according to the rule. IBConsole uses this XML file as a profile, which defines the way the processes will be handled.

<Tool Filename="SubProcess" AllowRemote="true" DeriveCaptionFrom="lastparam"
         IdentifyTaskOutput="true"/>

Example 1

To specify that a tool named LogMe returns all the .log and .dat files that it generates to the initiating machine, LogMe should be defined as follows in the profile XML:

<Tool Filename="LogMe" AllowRemote="true" DeriveCaptionFrom="lastparam"  
         AdditionalOutputMask="*.log"/>,*.dat

Example 2

Assuming that LogMe returns all kinds of files, but you are only interested in the .log files that it returns. In this case, LogMe should be defined as follows in the profile XML:

<Tool Filename="LogMe" AllowRemote="true" DeriveCaptionFrom="lastparam"  
         OutputFileMasks="*.log"/>
  

Note:

Attribute

Description

Values/Notes

Filename

The name of the tool (filename extension is optional). Note that wildcards (e.g. "TOOL*.exe") are allowed to support a single Tool definition that covers multiple tool names.

AllowRemote

Execution of Tools with this attribute set to "True" are distributed to remote machines.

True/False

AllowRemoteIf

[Optional]
Conditional Value to determine if a task should be distributed, or marked for execution on the local Agent, based on its commandline. 

If the Value specified with this attribute is found in the tasks commandline, the task will be marked as allowed to be distributed. 

            

Should be used Instead of the AllowRemote” attribute.

Several values can be specified using comma separation.

AllowPredictedBatch

Tools with this attribute will be allowed to run in parallel, when executed under a Visual Studio 2010 and higher build. Tools that are marked with this option will be scheduled for early execution, and have some prerequisites:

1)      Two Instances of the executable will not attempt to write to the same file (e.g. output file, log file)

2)      None of the instances of the executable should be dependent on anything that the other instances do. (e.g one instance does not depend on the output file of another instance; none of the instances deletes any files or folders the other instances use).
True/False

Works only for Visual Studio solutions which have a defined profile.xml file. This setting is ignored for regular Dev Tools  build.

AllowIntercept

Tools with this attribute set to "True" are monitored by Automatic Interception Interface. Any tool responsible for direct or indirect execution of remotely executed Tools (Tools with AllowRemote set to "True") should have AllowIntercept set to "True".

True/False

SkipIfProjectFailed: associated with the Tool and Task elements

[Optional]
Defines the behavior in case a failure occurs. (For example: Skip the Link task if a Compile task failed.)

WorkingDir: Project, TaskGroup, and Task elements

[Optional]
Defines the working directory used for tasks. The deepest occurrence in the XML definition locally overrides any parent definition. For example: In the demo XML, the filename passed to the application does not contain the full path, but because the Project element defined a WorkingDir, the application can locate the file.

DeriveCaption
From

This attribute controls the caption that appears in the task's bar in Monitor Progress View.

 

firstparam – echoes the first parameter from the task's command line.

lastparam – echoes the last parameter from the task's command line.

SingleInstance
PerAgent

Tools with this attribute set to "True" never run concurrently on a single Agent – even if the Agent has multi-processor or multi-core hardware.
Note that this attribute does not prevent tools from running on different Agents at the same time.

True/False

AllowRestartOn
Local

For tools with this attribute set to "True", the initiating Agent is allowed to apply the "Restart remote processes on local machine when possible" setting for performance optimization.

Important: This attribute should not be set to True for tools that write incrementally to output files: if the local instance of the tool is terminated, an incomplete output file could result.

True/False

SuccessExitCodes

[Optional]
Code(s) that will be considered success exit codes for the tool.

Comma-separated list of numerical values.
Ranges may be used (e.g.: '2..19').
Default success exit code: 0

WarningExitCodes

[Optional]
Code(s) that will be considered warning exit codes for the tool.

Tasks returning this exit code are displayed as a yellow bar in the Execution Monitor Progress page, and are counted as warnings in the Summary page.

Comma-separated list of numerical values.
Ranges may be used (e.g.: '2..19').

IdentifyTask
Output

When this parameter is set to True, IncrediBuild attempts to add textual identifiers to the tool's output to help locate it in the output text. The identifiers are removed from the final output text.

This attribute should be used whenever double-clicking a progress bar in the Execution Monitor Progress display doesn't work for a certain tool whose execution is distributed using either the Manual Interface or the Automatic Interface.

True/False

AutoRecover

If any of these strings are found in the tool’s output, IncrediBuild reassigns the task to another Agent and discards the previous output.

Comma-separated list of strings.

TimeLimit

Time limit, in seconds, after which a remote task is automatically canceled and reassigned to a different Agent.

1 to 20,000 (Integer)

AdditionalOutput
Mask

This attribute specifies that the tool will return additional files to the initiating machine according to the provided mask.

To specify more than one file extension, enter comma-separated values, e.g.: "*.log,*.dat".



EXTRA for Tools:

OutputPrefix / GroupPrefix

[Optional]
The text that appears in the Execution Monitor and logs.

OutputFileMasks

A set of file types to be returned to the builder.
For example: An application uses temporary files that are not required by the job. To prevent unnecessary file syncs over the network, a file mask for the desired files only can be defined. Multiple masks are allowed, such as '*.o, *.d'.