Developer Guide and Reference for Intel® Cryptography Primitives Library
A newer version of this document is available. Customers should click here to go to the newest version.
Visible to Intel only — GUID: GUID-3B306043-AF01-42BC-BE30-A6BFADA03CD1
Visible to Intel only — GUID: GUID-3B306043-AF01-42BC-BE30-A6BFADA03CD1
Performance Test Tool (perfsys) Command Line Options
Intel® Cryptography Primitives Library installation includes a command-line tool for performance testing in the <install_dir>/tools/perfsys directory. The ps_ippcp executable measures performance for all Intel® Cryptography Primitives Library functions. The ps_crypto_mb executable measures performance for all Intel® Cryptography Primitives Library Multi-buffer functions. Note that ps_crypto_mb executable can be ran on 3rd Gen Intel® Xeon® Scalable processors only.
Many factors may affect Intel® Cryptography Primitives Library performance. One of the best way to understand them is to run multiple tests in the specific environment you are targeting for optimization. The purpose of the perfsys tools is to simplify performance experiments and empower developers with useful information to get the best performance from Intel® Cryptography Primitives Library functions.
With the command-line options you can:
Create a list of functions to test
Set parameters for each function
Set image/buffer sizes
To simplify re-running specific tests, you can define the functions and parameters in the initialization file, or enter them directly from the console.
The command-line format is:
ps_ippcp.exe [option_1] [option_2] ... [option_n]
To invoke the short reference for the command-line options, use -? or -h commands:
ps_ippcp.exe -h
The command-line options are divided into several groups by functionality. You can enter options in arbitrary order with at least one space between each option name. Some options (like -r, -R, -o, -O) may be entered several times with different file names, and option -f may be entered several times with different function patterns. For detailed descriptions of the perfsys command-line options see the following table:
Performance Test Tool Command Line Options
Option |
Description |
|---|---|
-T[cpu-features] |
Call ippcpSetCpuFeatures |
Option |
Description |
|---|---|
-A<Timing|Params|Misalign|All> |
Prompt for the parameters before every test from console |
-o[<file-name>] |
Create <file-name>.txt file and write console output to it |
-O[<file-name>] |
Add console output to the file <file-name>.txt |
-L <ERR|WARN|PARM|INFO|TRACE> |
Set detail level of the console output |
-r[<file-name>] |
Create <file-name>.csv file and write perfsys results to it |
-R[<file-name>] |
Add test results to the file <file-name>.csv |
-q[<file-name>] |
Create <file-name>.csv and write function parameter name lines to it |
-q+ |
Add function parameter name lines to perfsys results table file |
-Q |
Exit after creation of the function parameter name table |
-u[<file-name>] |
Create <file-name>.csv file and write summary table ('_sum' is added to default file name) |
-U[<file-name>] |
Add summary table to the file <file-name>.csv ('_sum' is added to default file name) |
-g[<file-name>] |
Create signal file at the end of the whole testing |
-l<dir-name> |
Set default directory for output files |
-k<and|or> |
Compose different keys (-f, -t, -m) by logical operation |
-F<func-name> |
Start testing from function with func-name full name |
-Y<HIGH/NORMAL> |
Set high or normal process priority (normal is default) |
-H[ONLY] |
Add ‘Interest’ column to .csv file [and run only hot tests] |
-N<num-threads> |
Call ippcpSetNumThreads(<num-treads>) |
-s[-] |
Sort or do not sort functions (sort mode is default) |
-e |
Enumerate tests and exit |
-v |
Display the version number of the perfsys and exit |
-@<file-name> |
Read command-line options for the specified file |
Option |
Description |
|---|---|
-d<name>=<value> |
Set perfsys parameter value |
Option |
Description |
|---|---|
i[<file-name>] |
Read perfsys parameters from the file <file-name>.ini |
-I[<file-name>] |
Write perfsys parameters to the file <file-name>.ini and exit |
-P |
Read tested function names from the .ini file |
-n<title-name> |
Set default title name for .ini file and output files |
-p<dir-name>} |
Set default directory for .ini file and input test data files |
Option |
Description |
|---|---|
-f<or-pattern> |
Run tests for functions with pattern in their names, case sensitive |
-f-<not-pattern> |
Do not test functions with pattern in their names, case sensitive |
-f+<and-pattern> |
Run tests only for functions with pattern in their names, case sensitive |
-f=<eq-pattern> |
Run tests for functions with pattern full name |
-t[-|+|=]<pattern> |
Run (do not run) tests with pattern in test name |
-m[-|+|=]<pattern> |
Run (do not run) tests registered in file with pattern in file name |
Option |
Description |
|---|---|
-h |
Display short help and exit |
-hh |
Display extended help and exit |
-h<key> |
Display extended help for the key and exit |