Developer Guide

  • 2021.3
  • 11/18/2021
  • Public
Contents

Run the Preproduction Tool

The preproduction tool (
tcc_data_streams_optimizer_preprod
) is for the preproduction phase of development. The primary purpose of the tool is to search for a tuning configuration that meets your requirements and, if found, apply the configuration to the target system and generate a configuration file. The tool also enables you to apply a configuration file to another target system or to verify that a particular configuration file was applied to the system.

Search and Apply a Tuning Configuration

The
search
command finds and applies a tuning configuration to the target system. This is the main use case of the preproduction tool.
usage: tcc_data_streams_optimizer_preprod.py search [-h] [-e environment_file] [-r requirements_file] [-o output_file] [-v]
Command-Line Options
Option
Description
-h, --help
Optional. Show this help message and exit.
-e, --environment environment_file
Path to the environment file. Required to start a search, optional to continue a search.
-r, --requirements requirements_file
Path to the requirements file. Required to start a search, optional to continue a search.
-o, --output output_file
Optional. Output configuration file (default: ./<hostname>/<requirements_filename>_<date>/<requirements_filename>.tuning_configuration.json).
-v, --verbose
Optional. Turn on verbose output with debug messages printed.
-d, --database
Optional. Configurations Database file or directory with databases.
To avoid yes/no requests (i.e., to remove all temporary files before starting a new flow), set environment variable
DSO_SILENT
.
If you decide to copy the environment file to another location on your host system, be sure to change the relative paths in the environment file or replace them with full paths.
Command example:
python3 tcc_data_streams_optimizer_preprod.py search -e ./demo/environment/sample_environment_uefi.json -r ./demo/requirements/single_pciememrd_1.json

Apply a Tuning Configuration

After using the search command to configure the initial target system, you may choose to apply the same configuration to additional systems. To apply a tuning configuration to another target system, use the
set
command with the
--apply
option. Specify the configuration file generated from the search.
usage: tcc_data_streams_optimizer_preprod.py set [-h] -e environment_file --apply [-v] tuning_configuration
Command-Line Options
Option
Description
-h, --help
Optional. Show this help message and exit.
-e, --environment environment_file
Required. Path to the environment file.
--apply
Required. Apply the tuning from the configuration file.
-v, --verbose
Optional. Turn on verbose output with debug messages printed.
Positional Argument
Description
tuning_configuration
Required. Path to the tuning configuration file (example: tuning_configuration.json).
Command example:
python3 tcc_data_streams_optimizer_preprod.py set -e ./demo/environment/sample_environment_uefi.json --apply ./<hostname>/single_pciememrd_1_<date>/single_pciememrd_1.tuning_configuration.json

Verify a Tuning Configuration

To verify that a particular tuning configuration was successfully applied to a target system, use the
set
command with the
--verify
option. Specify the configuration file to be compared with the current system configuration.
usage: tcc_data_streams_optimizer_preprod.py set [-h] -e environment_file --verify [-v] tuning_configuration
Command-Line Options
Option
Description
-h, --help
Optional. Show this help message and exit.
-e, --environment environment_file
Required. Path to the environment file.
--verify
Required. Verify the current tuning against the tuning configuration file.
-v, --verbose
Optional. Turn on verbose output with debug messages printed.
Positional Argument
Description
tuning_configuration
Required. Path to the tuning configuration file (example: tuning_configuration.json).
Command example:
python3 tcc_data_streams_optimizer_preprod.py set -e ./demo/environment/sample_environment_uefi.json --verify ./<hostname>/single_pciememrd_1_<date>/single_pciememrd_1.tuning_configuration.json

Apply Reset Configuration

To return your target system back to the default state, follow these steps to apply a reset configuration to Data Streams Optimizer. The DSO tuning on your target system will be reset to the same state of configuration at the end of the Get Started Guide for UEFI BIOS or Get Started Guide for Slim Bootloader.
Any changes you have made from using Data Streams Optimizer will be lost.
You need to use the reset only if you have run Data Streams Optimizer before and a successful tuning configuration was found.
To reset the tuning on a target system, use the
reset
command. Specify the enviroment file and target connections with your target.
usage: tcc_data_streams_optimizer_preprod.py reset [-h] -e environment_file [-v]
Command-Line Options
Option
Description
-h, --help
Optional. Show this help message and exit.
-e, --environment environment_file
Required. Path to the environment file.
-v, --verbose
Optional. Turn on verbose output with debug messages printed.
Command example:
python3 tcc_data_streams_optimizer_preprod.py reset -e ./demo/environment/sample_environment_uefi.json
This command will reboot your target system.

Product and Performance Information

1

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