Skip to content

Commit f1e47af

Browse files
committed
Reprhase and expand note on logical CPUs
1 parent 7274b3c commit f1e47af

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/config_reference.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1637,8 +1637,12 @@ Processor Info
16371637

16381638
.. versionadded:: 3.5.0
16391639

1640-
A *processor info object* in ReFrame's configuration is used to hold information about the processor of a system partition and is made available to the tests through the :attr:`processor <reframe.core.systems.SystemPartition.processor>` attribute of the :attr:`current_partition <reframe.core.pipeline.RegressionTest.current_partition>`. Note that "logical CPUs" is the number of threads, so for example :attr:`num_cpus_per_core <reframe.core.systems.SystemPartition.processor.num_cpus_per_core>` can be larger than one if a hyper-threading-like system is enabled.
1640+
A *processor info object* in ReFrame's configuration is used to hold information about the processor of a system partition and is made available to the tests through the :attr:`processor <reframe.core.systems.SystemPartition.processor>` attribute of the :attr:`current_partition <reframe.core.pipeline.RegressionTest.current_partition>`.
16411641

1642+
.. note::
1643+
In the following the term *logical CPUs* refers to the smallest processing unit recognized by the OS.
1644+
Depending on the microarchitecture, this can either be a core or a hardware thread in processors that support simultaneous multithreading and this feature is enabled.
1645+
Therefore, properties such as :attr:`num_cpus_per_core` may have a value greater than one.
16421646

16431647
.. attribute:: .arch
16441648

0 commit comments

Comments
 (0)