Environment variables

Mandatory environment variables

The following environment variables MUST be set to run the product:

Environment variable list

 

Environment Variable

Description

TESTRTDIR

A mandatory environment variable that points to the installation directory of the product.

ATTOLSTUDIO_VERBOSE

 

Setting this variable to 1 forces the product GUI to display verbose messages, including file paths, in the Build Message Window.

 

Runtime Analysis features

The Runtime Analysis Features use the following environment variables:

 

Environment Variable

Description

ATLTGT

A mandatory environment variable that points to the Target Deployment Port directory when you are using the product in the command line interface.

When you are using the Instrumentation Launcher or the product GUI, you do not need to set ATLTGT manually, as it is calculated automatically.

ATL_TMP_DIR

 

Indicates the location for temporary files. By default, they are placed in /tmp for UNIX or the current directory for Windows.

ATL_EXT_SRC

 

This variable allows you to instrument additional files with filename extensions other than the defaults (.c and .i). The .c extension is reserved for C source files that require preprocessing, while .i is for already preprocessed files. All other extensions supported by this variable are assumed to be of source files that need to be preprocessed.

ATL_EXT_OBJ

Lets you specify an alternative extension to .o (UNIX) or .obj (DOS) for object files.

ATL_EXT_ASM

Lets you specify more than .s extension for assembler source files when the compiler offers an option to generate an assembler listing without compiling it to the object file.

ATL_EXT_TMP_CMD

Windows only. Lets you specify an alternative extension to the Windows temporary options file. Defaults to ._@@.

ATL_EXT_SRCCP

The variable lets you add C++ source file extensions (defaults are .C, .cpp, .c++, .cxx, .cc, and .i) to specify the C++ source files to be instrumented. Extensions .C to .cc in the list are reserved for source files under analysis.  The .i extension is reserved for those to be processed, if the ATL_FORCE_CPLUSPLUS variable is set to ON. Any other extension implies that pre-processing is to be performed.

ATL_FORCE_CPLUSPLUS

If set to ON, this variable allows you to force C++ instrumentation whether the file extension is .c, .i, or any added extension.

 

 

Component Testing for C and Ada

Component Testing for C and Ada uses the following environment variables:

 

Environment Variable

Description

ATUDIR

Points to the /lib directory in the product installation directory.

ATUTGT

Points to the Target Deployment Port directory for Component Testing for C and Ada.

 

You can change default extensions for Component Testing for C and Ada through the use of environment variables when the Test Script Compiler or Test Report Generator is started.

The following table summarizes these environment variables and the extensions they modify.

 

Environment Variable

File

Default extension

ATTOLPTU

Test script

.ptu

ATTOLTDC

Table of correspondence file

.tdc

ATTOLLIS

List of errors

.lis

ATTOLRIO

Trace file

.rio

ATTOLRO

Test report

.ro

ATTOLROD

Unformatted test report

.rod

ATTOLDEF

Standard definitions file

.def

ATTOLSMB

Symbol table file

.smb

 

The rule whereby a "2" is added to the extension of the .rio trace file when the -compare option is used still applies if the default extension is changed in the ATTOLRIO environment variable.

System Testing for C

System Testing for C uses the following environment variable:

 

Environment Variable

Description

ATS_DIR

Points to the directory containing the System Testing binaries for C.

 

Test Process Monitor

The Test Process Monitor uses the following environment variables.

 

Environment Variable

Description

ATTOL_TPM_ROOT

This variable indicates the directory where Test Process Monitor databases are located for a project. ATTOL_TPM_ROOT is a mandatory variable and must be set when a project is created. It should be a shared directory accessible by all users who work on a project.

ATTOL_TPM_USER

This optional variable specifies the name of the user. If this variable is not set, the Test Process Monitor uses the current user, if possible.

 

C and C++ Instrumentation Launcher

The Instrumentation Launcher uses the following additional variables:

 

Environment Variable

Description

ATTOLBIN

If set, this variable must contain the path to the Instrumentor binaries. If not, this path is determined automatically from the PATH variable. This variable can be useful if the Target Deployment Port has been moved to a non-standard location.

ATTOLOBJ

If set, this variable points to a valid directory where the products.h file is generated and the Target Deployment Port (TP.o or TDP.obj) is compiled. By default, these files are generated in the current directory.

ATL_OVER_SET

This variable must indicate the path to a copy of the BatchCCDefaults.pl file if you want to change any Target Deployment Port compilation flags contained in that file.

ATL_EXT_LIB

Lets you specify additional alternative extensions for library files. By default .a or .lib are used.

ATL_FORCE_C_TDP

If set to ON, the tp.ini file is used instead of the tpcpp.ini file (used for C++ language). If the Target Deployment Port supports only C language, the tp.ini file is always used.

ATL_OVER_SET

As an alternative to using the --settings of the Instrumentation Launcher, you can copy and modify the <InstallDir>/lib/scripts/BatchCCDefaults.pl file. In this case, set ATL_OVER_SET to the directory and filename of the new copy of this file.

 

Ada tools

The Ada Link File Generator and Ada Unit Maker use the following additional variables:

 

Environment Variable

Description

ATTOLCHOP

Selects the default naming convention. The following values can be used:

ATTOLCHOP="APEX" : for Apex naming

ATTOLCHOP="GNAT" : for Gnat naming

All other values end with a fatal error. By default, Gnat naming is used.

ATTOLALK_EXT

Specifies allowed extensions separated by the semicolon (':') character on UNIX systems and (';') on Windows.

By default, the allowed extension list is ".ada:.ads:.adb"

ATTOLALK_NOEXT

Specifies forbidden extensions separated by the ':' character on UNIX systems and ';' on Windows.

By default, the forbidden extension list is empty.

LD_LIBRARY_PATH

Specifies the location of libraries required by the Ada Link File Generator. By default, these libraries are located in the /lib directory of the installation directory.

 

Related Topics

Setting Environment Variables