Skip to content

Latest commit

 

History

History
126 lines (97 loc) · 5.34 KB

pepc-topology.rst

File metadata and controls

126 lines (97 loc) · 5.34 KB
Raw
Date: 09-03-2023
Title:TOPOLOGY

Contents

Command 'topology'

General options

-h
Show a short help message and exit.
-q
Be quiet.
-d
Print debugging information.
--version
Print version and exit.
-H HOSTNAME, --host HOSTNAME
Name of the host to run the command on.
-U USERNAME, --username USERNAME
Name of the user to use for logging into the remote host over SSH. The default user name is 'root'.
-K PRIVKEY, --priv-key PRIVKEY
Path to the private SSH key that should be used for logging into the remote host. By default the key is automatically found from standard paths like '$HOME/.ssh'.
-T TIMEOUT, --timeout TIMEOUT
SSH connection timeout in seconds, default is 8.
-D DATASET, --dataset DATASET

This option is for debugging and testing purposes only, it defines the dataset that will be used to emulate a host for running the command on. This option is typically used when running 'pepc' from the source code directory, which includes datasets for many different systems.

The argument can be the dataset path, 'all' to specify all available dataset or name in which case the following locations will be searched for.

  1. './tests/data', in the directory of the running program
  2. '$PEPC_DATA_PATH/tests/data'
  3. '$HOME/.local/share/pepc/tests/data'
  4. '/usr/local/share/pepc/tests/data'
  5. '/usr/share/pepc/tests/data'
--force-color
Force coloring of the text output.

Subcommand 'info'

Print CPU topology information.

Note, Linux kernel provides topology information only for online CPUs, but not for offline CPUs. Therefore, unknown topology numbers (e.g., package number) for offline CPUs are substituted with "?".

--cpus CPUS
List of CPUs to print topology information for. The list can include individual CPU numbers and CPU number ranges. For example,'1-4,7,8,10-12' would mean CPUs 1 to 4, CPUs 7, 8, and 10 to 12. Use the special keyword 'all' to specify all CPUs.
--cores CORES
List of cores to print topology information for. The list can include individual core numbers and core number ranges. For example, '1-4,7,8,10-12' would mean cores 1 to 4, cores 7, 8, and 10 to 12. Use the special keyword 'all' to specify all cores. This option has to be accompanied by the '--package' option, because core numbers are per-package.
--modules MODULES
List of dies to print topology information for. The list can include individual module numbers and module number ranges. For example, '0,2-5' would mean module 0 and modules 2, 3, 4, and 5. Use the special keyword 'all' to specify all modules. Note, unlike core and die numbers, module numbers are absolute.
--dies DIES
List of dies to print topology information for. The list can include individual die numbers and die number ranges. For example, '0-3,5' would mean dies 0 to 3, and die 5. Use the special keyword 'all' to specify all dies. On some systems, die numbers are globally unique, while on other systems they are relative to the package. In the latter case, this option has to be accompanied by the '--package' option.
--packages PACKAGES
List of packages to print topology information for. The list can include individual package numbers and package number ranges. For example, '0,2-4' would mean package 0 and packages 2 to 4. Use the special keyword 'all' to specify all packages.
--core-siblings CORE_SIBLINGS
Core siblings are CPUs sharing the same core. The list can include individual core sibling indices or index ranges. For example, if a core includes CPUs 3 and 4, index '0' would mean CPU 3 and index '1' would mean CPU 4. This option can only be used to reference online CPUs, because Linux does not provide topology information for offline CPUs. In the example with CPUs 3 and 4, if CPU 3 was offline, then index '0' would mean CPU 4.
--module-siblings MODULE_SIBLINGS
Module siblings are CPUs sharing the same module. The list can include individual module sibling indices or index ranges. For example, if a module includes CPUs 3, 4, 5, and 6, index '0' would mean CPU 3, index '1' would mean CPU 4, and idex '3' would mean CPU 5. This option can only be used to reference online CPUs, because Linux does not provide topology information for offline CPUs. In the example with CPUs 3, 4, 5 and 6, if CPU 4 was offline, then index '1' would mean CPU 5.
--order ORDER
By default, the topology table is printed in CPU number order. Use this option to print it in a different order (e.g., core or package number order). Here are the supported order names: cpu, core, module, die, node, package.
--online-only
Include only online CPUs. By default offline and online CPUs are included.
--columns COLUMNS
Comma-separated list of the topology columns to print. Available columns are: CPU, core, module, die, node, package, hybrid. Example: --columns Package,Core,CPU. By default, all columns that are meaningful for the platform are printed. If the platform does not have modules or dies, the corresponding columns won't be printed. The "hybrid" column is not printed for non-hybrid