5.1.3 FM_TRACE_PLUGINS environment variable

When it is not possible to specify a trace plug-in to the launching tool, use the environment variable FM_TRACE_PLUGINS. This variable must be set to the full path of the plug-in.

For example, on Linux:

export FM_TRACE_PLUGINS=<installation_path>/plugins/<OS_Compiler>/TarmacTrace.so

or on Windows:

set FM_TRACE_PLUGINS=<installation_path>\plugins\<OS_Compiler>\<version>\TarmacTrace.dll

To set multiple trace plug-ins at the same time, separate them with a semicolon, for example:

set FM_TRACE_PLUGINS=%PVLIB_HOME%\plugins\Win64_VC2015\Release\TarmacTrace.dll;%PVLIB_HOME%\plugins\Win64_VC2015\Release\GenericTrace.dll

You can also load the same plug-in multiple times.

Give the plug-in instance a name by adding the prefix <instancename>= to the plug-in path or paths.

Specify parameters for plug-ins that you load using FM_TRACE_PLUGINS, using the following syntax:


where <param*_without_prefix=value> means you must specify the parameter without the prefix that would be used on the command line. For example, use trace-file=file.txt instead of TRACE.TarmacTrace.trace-file=file.txt.

For example, on Linux:

export FM_TRACE_PLUGINS='|trace-file=/home/myname/work/trace.txt||end-instruction-count=1000|$PVLIB_HOME/plugins/Linux64_GCC-6.4/TarmacTrace.so'

or on Windows:

set FM_TRACE_PLUGINS=^|trace-file=c:\work\trace.txt^|^|end-instruction-count=1000^|%PVLIB_HOME%\plugins\Win64_VC2015\Release\TarmacTrace.dll


  • Do not specify a pipe character | at the end of the environment variable value.
  • Separate individual parameters with two pipe characters ||, not one.
  • Separate the plug-in from the parameters using a single pipe character |.
  • Do not specify quotes around paths that contain spaces, or escape spaces. Spaces are resolved automatically.
  • Do not specify environment variables within this environment variable.
  • Specify the parameters before you specify the plug-in.
  • On Windows, you can either set the environment variable using the Advanced System Settings window, or if you are using the command line, you might need to escape each pipe character, for example ^|.
  • The parameter values that you set using this environment variable are not displayed by the --list-params or -l command-line options. This is because the environment variable is processed at a later stage, when launching the simulation.
Non-ConfidentialPDF file icon PDF version100964_1110_00_en
Copyright © 2014–2020 Arm Limited or its affiliates. All rights reserved.