Intel® Time Coordinated Computing Tools (Intel® TCC Tools) 2021.2 Developer Guide

Developer Guide

  • 2021.2
  • 06/11/2021
  • Public
Contents

Configure Production Systems

The production tool (
tcc_data_streams_optimizer_prod
) is for the production phase of development. The primary purpose of the tool is to apply a tuning configuration to the target system. The tool can also verify that a particular tuning configuration was applied to the system.

Command-Line Options

usage: tcc_data_streams_optimizer_prod.py [-h] (--apply | --verify) [-v]
                       [--hostname TARGET_HOSTNAME]
                       [--port TARGET_PORT]
                       [--username TARGET_USERNAME]
                       [--password TARGET_PASSWORD]
                       [--targetpath CAPSULE_TARGET_PATH]
                       [--reboot]
                       tuning_configuration
Option
Description
-h, --help
Optional. Show this help message and exit.
--apply
or
--verify
Required. Apply the tuning from the configuration file, or verify the current tuning against the configuration file.
-v, --verbose
Optional. Turn on verbose output with debug messages printed.
--hostname TARGET_HOSTNAME
Optional. Host name of the target system to be tuned (default: localhost).
--port TARGET_PORT
Optional. Port of the target system to be tuned (default: 22).
--username TARGET_USERNAME
Optional. User name for the target system to be tuned (default: root).
--password TARGET_PASSWORD
Optional. Password for the target system to be tuned (empty by default).
--targetpath CAPSULE_TARGET_PATH
Optional. Path to the temporary directory for capsule files on the target system (default: /tmp/capsules)
--reboot
Optional. Reboot the target after applying the capsule.
Positional Argument
Description
tuning_configuration
Required. Path to the tuning configuration file (example: tuning_configuration.json).

Apply a Tuning Configuration

To apply a tuning configuration to a target system, use the
--apply
 option. Specify the tuning configuration file generated by the preproduction tool.
Command Example
On the host system, run the following command:
You need to set up a passwordless connection to your board before running the following command, or provide a password using the
--password
 option.
 python3 ${TCC_ROOT}/tools/tcc_data_streams_optimizer_prod.py --apply <path_to>/tuning_configuration.json --hostname <target_hostname> --reboot

Verify a Tuning Configuration (Host-Target Setup)

To verify that a particular configuration was successfully applied to a target system, use the
--verify
 option. Specify the tuning configuration file to be compared with the current system configuration.
In this release, the verification always passes.
Command Example
On the host system, run the following command:
python3 ${TCC_ROOT}/tools/tcc_data_streams_optimizer_prod.py --verify <path_to>/tuning_configuration.json --hostname <target_hostname>

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.