<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
  <!ENTITY UTE "GTEE">
]>

<sect1 id="ute_harness_modules">
  <title>Harness modules</title>
  <sect2 id="ute_harness_modules_overview">
    <title>Overview</title>
    <para>
      This section is intended for UTE users and describes common module parameters
 and all currently included harness modules and their parameters. Refer to
      <itemizedlist>
        <listitem>
         <xref linkend="ute_usage_standalone"/> and <xref linkend="ute_usage_gtee"/> for
         ways to configure and run UTE.
        </listitem>
        <listitem>
          <xref linkend="ute_harness_interface"/> for detailed description of interface between
          UTE and harness module and information about how to add or modify harness module.
        </listitem>
      </itemizedlist>
    </para>
    <para>
      In UTE, each harness module has an identifier (also the argument to <code>-harness</code>).
    </para>
  </sect2>
  <sect2 id="ute_harness_modules_common">
    <title>Common settings and options</title>
    <para>
        The following table provides user-visible common settings and options.
        <table pgwide="1" id="ute_harness_modules_common_settings_table">
          <title>Common harness settings and options</title>
          <tgroup align="left" valign="top" cols="3">
            <colspec align="left" valign="top" name="Name"/>
            <colspec align="left" valign="top" name="Command line option"/>
            <colspec align="left" valign="top" name="Set by"/>
            <colspec align="left" valign="top" name="Default value"/>
            <colspec align="left" valign="top" name="Description"/>
            <thead>
              <row>
                <entry>Name</entry>
                <entry>Command line option</entry>
                <entry>Set by</entry>
                <entry>Default value</entry>
                <entry>Description</entry>
              </row>
            </thead>
            <tbody>
              <row>
                <entry>-</entry>
                <entry>-env</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Arbitrary setting in <code>name=value</code> format</entry>
              </row>
              <row>
                <entry>-</entry>
                <entry>-envfile</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Arbitrary setting file containing assignments in <code>name=value</code> format</entry>
              </row>
              <row>
                <entry>HARNESS</entry>
                <entry>-harness</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Test harness being executed</entry>
              </row>
              <row>
                <entry>TESTBASE</entry>
                <entry>-testbase</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Location of testbase</entry>
              </row>
              <row>
                <entry>COMPONENT</entry>
                <entry>-component</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Test component</entry>
              </row>
              <row>
                <entry>TESTLIST</entry>
                <entry>-testlist</entry>
                <entry>user (optional)</entry>
                <entry></entry>
                <entry>Testlist to execute</entry>
              </row>
              <row>
                <entry>TESTS</entry>
                <entry>-test</entry>
                <entry>user (optional)</entry>
                <entry></entry>
                <entry>Tests to execute (interpretation depends on harness module)</entry>
              </row>
              <row>
                <entry>RES_DIR</entry>
                <entry>-results</entry>
                <entry>user</entry>
                <entry>-</entry>
                <entry>Result directory</entry>
              </row>
              <row>
                <entry>TEST_JAVA_HOME</entry>
                <entry>-jdk</entry>
                <entry>user</entry>
                <entry>-</entry>
                <entry>Product location</entry>
              </row>
              <row>
                <entry>VM_OPTS</entry>
                <entry>-vmopts</entry>
                <entry>user (optional)</entry>
                <entry></entry>
                <entry>Additional VM options to product</entry>
              </row>
              <row>
                <entry>JAVA_32_64_FLAG</entry>
                <entry>-bits</entry>
                <entry>user (optional)</entry>
                <entry></entry>
                <entry>Bits flag (d32 or d64)</entry>
              </row>
              <row>
                <entry>VM_FLAVOR</entry>
                <entry>-vmflavor</entry>
                <entry>user (optional)</entry>
                <entry></entry>
                <entry>VM flavor</entry>
              </row>
              <row>
                <entry>VM_MODE</entry>
                <entry>-vmmode</entry>
                <entry>user (optional)</entry>
                <entry></entry>
                <entry>VM mode</entry>
              </row>
              <row>
                <entry>PLATFORM</entry>
                <entry>-platform</entry>
                <entry>user (optional)</entry>
                <entry></entry>
                <entry></entry>
              </row>
              <row>
                <entry>JDK_ARCH</entry>
                <entry>-jdkarch</entry>
                <entry>user (optional)</entry>
                <entry></entry>
                <entry>Test JDK architecture</entry>
              </row>
              <row>
                <entry>JAVA_EXE</entry>
                <entry>-javaexe</entry>
                <entry>user (optional)</entry>
                <entry>java</entry>
                <entry>Name of java executable</entry>
              </row>
              <row>
                <entry>STABLE_JAVA_HOME</entry>
                <entry>-stablejavahome</entry>
                <entry>user (optional)</entry>
                <entry></entry>
                <entry>Stable JDK location</entry>
              </row>
              <row>
                <entry>STABLE_VMOPTS</entry>
                <entry>-stablevmopts</entry>
                <entry>user (optional)</entry>
                <entry></entry>
                <entry>Stable JDK options to use</entry>
              </row>
              <row>
                <entry>RUN_SHELL</entry>
                <entry>-shell</entry>
                <entry>user (optional)</entry>
                <entry>ksh</entry>
                <entry>Shell used for scripts</entry>
              </row>
              <row>
                <entry>WORK_SUBDIR</entry>
                <entry>-worksubdir</entry>
                <entry>user (optional)</entry>
                <entry>workDir</entry>
                <entry>Subdirectory of result directory to store test harness work results</entry>
              </row>
              <row>
                <entry>REPORT_SUBDIR</entry>
                <entry>-reportsubdir</entry>
                <entry>user (optional)</entry>
                <entry>report</entry>
                <entry>Subdirectory of result directory to store test harness reports</entry>
              </row>
              <row>
                <entry>DISPLAY</entry>
                <entry>-display</entry>
                <entry>user (optional)</entry>
                <entry></entry>
                <entry>X11 DISPLAY variable</entry>
              </row>
              <row>
                <entry>SETTINGS</entry>
                <entry>-settings</entry>
                <entry>user (optional)</entry>
                <entry></entry>
                <entry>Additional settings file in <code>name=value</code> format</entry>
              </row>
            </tbody>
          </tgroup>
        </table>
      </para>
  </sect2>
  <sect2 id="ute_harness_module_tonga">
    <title><code>tonga</code> - UTB-compatible Tonga</title>
    <para>
      <code>tonga</code> module is UTB-compatible module for Java SE SQE functional testbase.
      <ulink url="http://sqeweb.sfbay.sun.com/nfs/testbase/sqe/7/ws/master/7/docs/">UTB (Unified Test Base)</ulink>
      is a collection of scripts to execute SQE functional tests. UTB provides uniform way to 
      run different SQE Testbases (vm, libs, awt, ...).
    </para>
    <para>
      Note that support for some UTB features is limited, and some do not work.
      Only features related to harness configuration and test execution itself
      (section 1.1 in UTB documentation) are supported. Features that are provided by test
      execution environment (e.g. JDK installation, local mapping) are omitted intentionaly.
    </para>
    <sect3 id="ute_harness_module_tonga_configuration">
      <title>Configuration</title>
      <para>
        The following table provides user-visible settings for <code>tonga</code> module. For
	other settings refer to <xref linkend="ute_harness_modules_common_settings_table"/>. Note
	that component may define other settings, some of which may be mandatory (refer to component
	documentation).
        <table pgwide="1" id="ute_harness_modules_tonga_settings_table">
          <title>Harness settings for <code>tonga</code></title>
          <tgroup align="left" valign="top" cols="3">
            <colspec align="left" valign="top" name="Name"/>
            <colspec align="left" valign="top" name="Command line option"/>
            <colspec align="left" valign="top" name="Set by"/>
            <colspec align="left" valign="top" name="Default value"/>
            <colspec align="left" valign="top" name="Description"/>
            <thead>
              <row>
                <entry>Name</entry>
                <entry>Command line option</entry>
                <entry>Set by</entry>
                <entry>Default value</entry>
                <entry>Description</entry>
              </row>
            </thead>
            <tbody>
              <row>
                <entry>COMPONENT, J2SE_COMPONENT_DIR</entry>
                <entry>-component</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>SQE functional component. Required.</entry>
              </row>
              <row>
                <entry>SUBCOMPONENT</entry>
                <entry>-subcomponent</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Subcomponent (optional)</entry>
              </row>
              <row>
                <entry>TESTBASE</entry>
                <entry>-testbase</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Location of testbase (note: includes component subdirectory)</entry>
              </row>
              <row>
                <entry>TESTLIST</entry>
                <entry>-testlist</entry>
                <entry>user</entry>
                <entry>testlist</entry>
                <entry>Testlist to use</entry>
              </row>
              <row>
                <entry>KEYWORDS</entry>
                <entry>-keywords</entry>
                <entry>user</entry>
                <entry>!manual</entry>
                <entry>Keyword expression to filter tests by</entry>
              </row>
              <row>
                <entry>TONGA_JAR</entry>
                <entry>-tonga</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Path to Tonga JAR</entry>
              </row>
              <row>
                <entry>TONGA_OPTS</entry>
                <entry>-tongaopts</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Additional options to Tonga</entry>
              </row>
              <row>
                <entry>TONGA_MAIN_CLASS</entry>
                <entry>-</entry>
                <entry>user</entry>
                <entry>Tonga</entry>
                <entry>Main class to run from Tonga JAR file.</entry>
              </row>
              <row>
                <entry>GENERATE_RERUN_SCRIPT</entry>
                <entry></entry>
                <entry>user</entry>
                <entry>true</entry>
                <entry>true to generate rerun script for test</entry>
              </row>
              <row>
                <entry namest="Name" nameend="Description">Options processed by component script</entry>
              </row>
              <row>
                <entry>DISPLAY</entry>
                <entry>-display</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>X11 DISPLAY setting</entry>
              </row>
              <row>
                <entry>KNOWN_FAIL_LIST</entry>
                <entry></entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Known failure list for Tonga</entry>
              </row>
              <row>
                <entry>EXCLUDE_LIST</entry>
                <entry></entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Exclude list for Tonga</entry>
              </row>
              <row>
                <entry>TONGA_REMOVE</entry>
                <entry></entry>
                <entry>user</entry>
                <entry>PASS</entry>
                <entry>Tests to remove results for (PASS, NONE, ALL)</entry>
              </row>
            </tbody>
          </tgroup>
        </table>
      </para>
    </sect3>
    <sect3 id="ute_harness_module_tonga_impl">
      <title>Implementation details</title>
      <para>
        Part of <code>tonga</code> module is also used for <code>dtonga</code> module,
        so its code must be changed carefully.
        <code>tonga_setup</code> is split in two parts:  <code>tonga_setup_common</code>
        which is also used by <code>dtonga</code> and <code>tonga_setup_component</code> which is
        only used by <code>tonga</code> module itself.
      </para>
    </sect3>
    <sect3 id="ute_harness_module_tonga_component_interface">
      <title>Component interface</title>
      <para>
        This component interface is completely identical to component interface between UTB and
        SQE component. Each SQE component (also a subdirectory in SQE testbase) has it's own
        <code>Run_component.sh</code> which contains component-specific definitions. This script
        is provided by component owners.
      </para>
      <para>
        Because in UTE <code>TESTBASE</code> already points to component subdirectory, this is
	also where <code>Run_component.sh</code> is located. This script is expected to contain
	shell functions that define the interface between <code>tonga</code> module and component.
        Note that component script only expected to prepare Tonga INI file and the execution of Tonga
	itself is done by UTE.
      </para>
      <para>
	The following functions are used:
	<itemizedlist>
	  <listitem>
	    <code>create_tonga_ini inifile</code> (mandatory) - is called by <code>tonga</code> module
	    to create Tonga ini file for execution with one parameter - path to Tonga ini file.
	    The settings for testrun can be read and used as environment variables.
	  </listitem>
	  <listitem>
	    <code>component_preparation</code> (optional) - may be used for component-specific initialization.
	  </listitem>
	  <listitem>
	    <code>component_initialize</code> (optional) - may be used for component-specific early initialization. This should only be used
            to override default values of some UTE variables. When this function is called, UTE is not yet fully initialized, so it should 
	    be used with caution.
	  </listitem>
	  <listitem>
	    <code>component_post_cleanup</code> (optional) - may be used for component-specific cleanup.
	  </listitem>
	</itemizedlist>
      </para>
      <para>
      </para>
    </sect3>
  </sect2>
  <sect2 id="ute_harness_module_dtonga">
    <title><code>dtonga</code> - DTonga (distributed Tonga)</title>
    <sect3 id="ute_harness_module_dtonga_configuration">
      <title>Configuration</title>
    </sect3>
    <sect3 id="ute_harness_module_dtonga_impl">
      <title>Implementation details</title>
    </sect3>
  </sect2>
  <sect2 id="ute_harness_module_jtreg">
    <title><code>jtreg</code> - Jtreg, OpenJDK test harness based on JavaTest</title>
    <sect3 id="ute_harness_module_jtreg_configuration">
      <title>Configuration</title>
      <para>
        The following table provides user-visible settings for <code>jtreg</code> module
	(for other settings refer to <xref linkend="ute_harness_modules_common_settings_table"/>):
        <table pgwide="1" id="ute_harness_modules_jtreg_settings_table">
          <title>Harness settings for <code>jtreg</code></title>
          <tgroup align="left" valign="top" cols="3">
            <colspec align="left" valign="top" name="Name"/>
            <colspec align="left" valign="top" name="Command line option"/>
            <colspec align="left" valign="top" name="Set by"/>
            <colspec align="left" valign="top" name="Default value"/>
            <colspec align="left" valign="top" name="Description"/>
            <thead>
              <row>
                <entry>Name</entry>
                <entry>Command line option</entry>
                <entry>Set by</entry>
                <entry>Default value</entry>
                <entry>Description</entry>
              </row>
            </thead>
            <tbody>
              <row>
                <entry>JTREG_HOME, JCT_TOOLS</entry>
                <entry>-jtreg</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Location of jtreg harness. Use JTREG_HOME (JCT_TOOLS exists only for backward compatibility and
		may be removed in the future)</entry>
              </row>
              <row>
                <entry>TIMEOUT_FACTOR</entry>
                <entry>-tfactor</entry>
                <entry>user</entry>
                <entry>1</entry>
                <entry>Timeout factor (all test timeouts are multiplied by this positive number)</entry>
              </row>
              <row>
                <entry>JTREG_OPTS</entry>
                <entry>-jtregopts</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Additional options to jtreg</entry>
              </row>
              <row>
                <entry>TESTLIST</entry>
                <entry>-testlist</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Test list (a subdirectory of TESTBASE). It may be used to select particular testbase (e.g. JDI_REGRESSION) or subdirectory of tests.</entry>
              </row>
              <row>
                <entry>WORK_SUBDIR</entry>
                <entry></entry>
                <entry>user</entry>
                <entry>workDir</entry>
                <entry>Subdirectory of result directory to be used as work directory for JavaTest</entry>
              </row>
              <row>
                <entry>REPORT_SUBDIR</entry>
                <entry></entry>
                <entry>user</entry>
                <entry>report</entry>
                <entry>Subdirectory to store JavaTest report</entry>
              </row>
              <row>
                <entry>JTR_IF_PASSED</entry>
                <entry></entry>
                <entry>user</entry>
                <entry>false</entry>
                <entry>If true, retain .jtr log files for passed tests, do not otherwise</entry>
              </row>
            </tbody>
          </tgroup>
        </table>
      </para>
    </sect3>
    <sect3 id="ute_harness_module_jtreg_impl">
      <title>Implementation details</title>
      <para>TBD</para>

    </sect3>
  </sect2>
  <sect2 id="ute_harness_module_javatest">
    <title><code>javatest</code> - JavaTest basic support</title>
    <sect3 id="ute_harness_module_javatest_configuration">
      <title>Configuration</title>
      <para>
        <code>javatest</code> harness module provides generate template-based support for JavaTest harness. It creates
        javatest config file from provided template and UTE settings. Javatest property <code>"a.b.c"</code> corresponds
        to setting <code>a_b_c.</code>
      </para>
      <para>
        The following table provides user-visible settings for <code>javatest</code> module
	(for other settings refer to <xref linkend="ute_harness_modules_common_settings_table"/>):
        <table pgwide="1" id="ute_harness_modules_javatest_settings_table">
          <title>Harness settings for <code>javatest</code></title>
          <tgroup align="left" valign="top" cols="3">
            <colspec align="left" valign="top" name="Name"/>
            <colspec align="left" valign="top" name="Command line option"/>
            <colspec align="left" valign="top" name="Set by"/>
            <colspec align="left" valign="top" name="Default value"/>
            <colspec align="left" valign="top" name="Description"/>
            <thead>
              <row>
                <entry>Name</entry>
                <entry>Command line option</entry>
                <entry>Set by</entry>
                <entry>Default value</entry>
                <entry>Description</entry>
              </row>
            </thead>
            <tbody>
              <row>
                <entry>JAVATEST_JAR</entry>
                <entry>-javatest</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Location of JavaTest JAR.</entry>
              </row>
              <row>
                <entry>TESTLIST</entry>
                <entry>-testlist</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Test list (a subdirectory of TESTBASE). It may be used to select particular testbase (e.g. JDI_REGRESSION) or subdirectory of tests.</entry>
              </row>
              <row>
                <entry>WORK_SUBDIR</entry>
                <entry></entry>
                <entry>user</entry>
                <entry>workDir</entry>
                <entry>Subdirectory of result directory to be used as work directory for jtreg</entry>
              </row>
              <row>
                <entry>REPORT_SUBDIR</entry>
                <entry></entry>
                <entry>user</entry>
                <entry>report</entry>
                <entry>Subdirectory to store jtreg report</entry>
              </row>
              <row>
                <entry>JAVATEST_CONFIG_TEMPLATE</entry>
                <entry></entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Template for JavaTest config</entry>
              </row>
              <row>
                <entry>JTR_IF_PASSED</entry>
                <entry></entry>
                <entry>user</entry>
                <entry>false</entry>
                <entry>If true, retain .jtr log files for passed tests, do not otherwise</entry>
              </row>
            </tbody>
          </tgroup>
        </table>
      </para>

    </sect3>
    <sect3 id="ute_harness_module_javatest_impl">
      <title>Implementation details</title>
    </sect3>
  </sect2>
  <sect2 id="ute_harness_module_javatest_simple">
    <title><code>javatest_simple</code> - JavaTest SimpleTest harness</title>
    <sect3 id="ute_harness_module_javatest_simple_configuration">
      <title>Configuration</title>
      <para>
        <code>javatest_simple</code> harness module is an extension of <code>javatest</code>
        module which also automatically sets <code>SimpleHarness</code> variables in the template.
      </para>
      <para>
       <code>javatest_simple</code> harness module does not provide additional user-visible settings. Refer to
       <xref linkend="ute_harness_modules_javatest_settings_table"/> for information about 
       <code>javatest</code> harness module settings.
      </para>
    </sect3>
    <sect3 id="ute_harness_module_javatest_simple_impl">
      <title>Implementation details</title>
    </sect3>
  </sect2>
  <sect2 id="ute_harness_module_jck">
    <title><code>jck</code> - JCK</title>
    <sect3 id="ute_harness_module_jck_configuration">
      <title>Configuration</title>
      <para>
         <code>jck</code> harness module is an extension of <code>javatest</code> module
         which offers some additional features:
         <itemizedlist>
           <listitem>JCK configuration template is included</listitem>
           <listitem>Some JCK configuration settings are set automatically</listitem>
           <listitem>JCK agent and tnameserv are started for the run</listitem>
           <listitem>Exclude list is converted to javatest format</listitem>
         </itemizedlist>
      </para>
      <para>
        The following table provides user-visible settings for <code>jck</code> module
	(for other settings refer to <xref linkend="ute_harness_modules_common_settings_table"/>
        and <xref linkend="ute_harness_modules_javatest_settings_table"/>):
        <table pgwide="1" id="ute_harness_modules_jck_settings_table">
          <title>Harness settings for <code>jck</code></title>
          <tgroup align="left" valign="top" cols="3">
            <colspec align="left" valign="top" name="Name"/>
            <colspec align="left" valign="top" name="Command line option"/>
            <colspec align="left" valign="top" name="Set by"/>
            <colspec align="left" valign="top" name="Default value"/>
            <colspec align="left" valign="top" name="Description"/>
            <thead>
              <row>
                <entry>Name</entry>
                <entry>Command line option</entry>
                <entry>Set by</entry>
                <entry>Default value</entry>
                <entry>Description</entry>
              </row>
            </thead>
            <tbody>
              <row>
                <entry>JCK_START_AGENT</entry>
                <entry>-agent</entry>
                <entry>user</entry>
                <entry>true</entry>
                <entry>true to start JCK agent</entry>
              </row>
              <row>
                <entry>JCK_START_TNAMESERV</entry>
                <entry>-tnameserv</entry>
                <entry>user</entry>
                <entry>true</entry>
                <entry>true to start tnameserv</entry>
              </row>
            </tbody>
          </tgroup>
        </table>
      </para>
    </sect3>
    <sect3 id="ute_harness_module_jck_impl">
      <title>Implementation details</title>
    </sect3>
  </sect2>
  <sect2 id="ute_harness_module_runThese">
    <title><code>runThese</code> - runThese, reliability harness</title>
    <sect3 id="ute_harness_module_runThese_configuration">
      <title>Configuration</title>
      <para>
        <code>runThese</code> harness module does not have any additional settings.
        Refer to <xref linkend="ute_harness_modules_common_settings_table"/> for information about common settings.
      </para>
    </sect3>
    <sect3 id="ute_harness_module_runThese_impl">
      <title>Implementation details</title>
    </sect3>
  </sect2>
  <sect2 id="ute_harness_module_refworkload">
    <title><code>refworkload</code> - refworkload, collection of performance benchmarks</title>
    <sect3 id="ute_harness_module_refworkload_configuration">
      <title>Configuration</title>
      <para>
        <table pgwide="1" id="ute_harness_modules_refworkload_settings_table">
          <title>Harness settings for <code>refworkload</code></title>
          <tgroup align="left" valign="top" cols="3">
            <colspec align="left" valign="top" name="Name"/>
            <colspec align="left" valign="top" name="Command line option"/>
            <colspec align="left" valign="top" name="Set by"/>
            <colspec align="left" valign="top" name="Default value"/>
            <colspec align="left" valign="top" name="Description"/>
            <thead>
              <row>
                <entry>Name</entry>
                <entry>Command line option</entry>
                <entry>Set by</entry>
                <entry>Default value</entry>
                <entry>Description</entry>
              </row>
            </thead>
            <tbody>
              <row>
                <entry>BENCHMARK</entry>
                <entry>-benchmark</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Refworkload benchmark</entry>
              </row>
              <row>
                <entry>ITERATIONS</entry>
                <entry>-iterations</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Number of iterations</entry>
              </row>
            </tbody>
          </tgroup>
        </table>
	Note: in addition to these settings, <code>refworkload</code> harness module supports
	Phare submission. Refer to <xref linkend="ute_phare_support"/> for more information.
      </para>
    </sect3>
    <sect3 id="ute_harness_module_refworkload_impl">
      <title>Implementation details</title>
    </sect3>
  </sect2>
  <sect2 id="ute_harness_module_rtpresto2">
    <title><code>rtpresto2</code> - rtpresto2, Java Realtime benchmark</title>
    <sect3 id="ute_harness_module_rtpresto2_configuration">
      <title>Configuration</title>
      <para>
        <table pgwide="1" id="ute_harness_modules_rtpresto2_settings_table">
          <title>Harness settings for <code>rtpresto2</code></title>
          <tgroup align="left" valign="top" cols="3">
            <colspec align="left" valign="top" name="Name"/>
            <colspec align="left" valign="top" name="Command line option"/>
            <colspec align="left" valign="top" name="Set by"/>
            <colspec align="left" valign="top" name="Default value"/>
            <colspec align="left" valign="top" name="Description"/>
            <thead>
              <row>
                <entry>Name</entry>
                <entry>Command line option</entry>
                <entry>Set by</entry>
                <entry>Default value</entry>
                <entry>Description</entry>
              </row>
            </thead>
            <tbody>
              <row>
                <entry>PERIOD</entry>
                <entry>-period</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Period, in microseconds</entry>
              </row>
              <row>
                <entry>ITERATIONS</entry>
                <entry>-iterations</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Number of iterations</entry>
              </row>
              <row>
                <entry>TOOLS</entry>
                <entry>-tools</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Base location of GNU tools (should include gnuplot)</entry>
              </row>
            </tbody>
          </tgroup>
        </table>
      </para>
    </sect3>
    <sect3 id="ute_harness_module_rtpresto2_impl">
      <title>Implementation details</title>
      <para>
        rtpresto2 is called through make. Under Linux, <code>prep-linux.sh</code> is called first.
      </para>
    </sect3>
  </sect2>
  <sect2 id="ute_harness_module_rtpresto3">
    <title><code>rtpresto3</code> - rtpresto3, Java Realtime benchmark</title>
    <sect3 id="ute_harness_module_rtpresto3_configuration">
      <title>Configuration</title>
      <para>
        <table pgwide="1" id="ute_harness_modules_rtpresto3_settings_table">
          <title>Harness settings for <code>rtpresto3</code></title>
          <tgroup align="left" valign="top" cols="3">
            <colspec align="left" valign="top" name="Name"/>
            <colspec align="left" valign="top" name="Command line option"/>
            <colspec align="left" valign="top" name="Set by"/>
            <colspec align="left" valign="top" name="Default value"/>
            <colspec align="left" valign="top" name="Description"/>
            <thead>
              <row>
                <entry>Name</entry>
                <entry>Command line option</entry>
                <entry>Set by</entry>
                <entry>Default value</entry>
                <entry>Description</entry>
              </row>
            </thead>
            <tbody>
              <row>
                <entry>PERIOD</entry>
                <entry>-period</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Period, in microseconds</entry>
              </row>
              <row>
                <entry>ITERATIONS</entry>
                <entry>-iterations</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Number of iterations</entry>
              </row>
              <row>
                <entry>TOOLS</entry>
                <entry>-tools</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Base location of GNU tools (should include gnuplot)</entry>
              </row>
              <row>
                <entry>GNUPLOT</entry>
                <entry>-gnuplot</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Location of gnuplot</entry>
              </row>
              <row>
                <entry>CFGS</entry>
                <entry>-cfgs</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Configurations to run (whitespace separated)</entry>
              </row>
              <row>
                <entry>PROPS</entry>
                <entry>-props</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Properties file to use</entry>
              </row>
              <row>
                <entry>DSCRIPT</entry>
                <entry>-dscript</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>dscript to use</entry>
              </row>
              <row>
                <entry>PRE</entry>
                <entry>-pre</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Enable creation of precompilation and preinitialization lists (true/false)</entry>
              </row>
            </tbody>
          </tgroup>
        </table>
	Note: in addition to these settings, <code>rtpresto3</code> harness module supports
	Phare submission. Refer to <xref linkend="ute_phare_support"/> for more information.
      </para>
    </sect3>
    <sect3 id="ute_harness_module_rtpresto3_impl">
      <title>Implementation details</title>
      <para>
      </para>
    </sect3>
  </sect2>
  <sect2 id="ute_harness_module_bigapps">
    <title><code>bigapps</code> - runbigapp, common BigApps harness</title>
    <para>
      <code>bigapps</code> module is the integration module for <emphasis>runbigapp.sh,</emphasis>
      a script for BigApps automation.
    </para>
    <sect3 id="ute_harness_module_bigapps_configuration">
      <title>Configuration</title>
      <para>
        The following table provides user-visible settings for <code>bigapps</code> module
	(for other settings refer to <xref linkend="ute_harness_modules_common_settings_table"/>):
        <table pgwide="1" id="ute_harness_modules_bigapps_settings_table">
          <title>Harness settings for <code>bigapps</code></title>
          <tgroup align="left" valign="top" cols="3">
            <colspec align="left" valign="top" name="Name"/>
            <colspec align="left" valign="top" name="Command line option"/>
            <colspec align="left" valign="top" name="Set by"/>
            <colspec align="left" valign="top" name="Default value"/>
            <colspec align="left" valign="top" name="Description"/>
            <thead>
              <row>
                <entry>Name</entry>
                <entry>Command line option</entry>
                <entry>Set by</entry>
                <entry>Default value</entry>
                <entry>Description</entry>
              </row>
            </thead>
            <tbody>
              <row>
                <entry>HARNESS_LOCATION</entry>
                <entry>-runbigapp</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Location of <code>runbigapp</code> harness (directory)</entry>
              </row>
              <row>
                <entry>BIGAPP</entry>
                <entry>-bigapp</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>BigApp to run</entry>
              </row>
              <row>
                <entry>TESTBASE</entry>
                <entry>-testbase</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Location of BigApp (subdirectory in BigApps workspace)</entry>
              </row>
              <row>
                <entry>EXEC_DURATION</entry>
                <entry>-duration</entry>
                <entry>user</entry>
                <entry></entry>
                <entry>Duration of run in minutes</entry>
              </row>
            </tbody>
          </tgroup>
        </table>
	Note: in addition to these settings, <code>bigapps</code> harness module supports
	Phare submission. Refer to <xref linkend="ute_phare_support"/> for more information.
      </para>
    </sect3>
    <sect3 id="ute_harness_module_bigapps_impl">
      <title>Implementation details</title>
      <para>
        <code>bigapps</code> module is very simple. After doing validation of settings,
	runbigapp.sh is called with a number of parameters.
      </para>
    </sect3>
  </sect2>
</sect1>
