oshmem_info1
Usage
oshmem_info [options]
oshmem_info - Display information about the OpenSHMEM installation
Overview
oshmem_info provides detailed information about the OpenSHMEM installation. It can be useful for at least three common scenarios:
- 1.
-
Checking local configuration and seeing how OpenSHMEM was installed.
- 2.
-
Submitting bug reports / help requests to the OpenSHMEM community (see Getting help).
- 3.
-
Seeing a list of installed OpenSHMEM plugins and querying what MCA parameters they support.
NOTE:
oshmem_info defaults to only showing a few MCA parameters by default (i.e., level 1 parameters). Use the --level option to enable showing more options (see the LEVELS section for more information).
Options
oshmem_info accepts the following options:
- •
-
-a,--all: Show all configuration options and MCA parameters
- •
-
--arch: Show architecture OpenSHMEM was compiled on
- •
-
-c,--config: Show configuration options
- •
-
-gmca, --gmca <param> <value>*: Pass global MCA parameters that are applicable to all contexts.
- •
-
-h,--help*: Shows help / usage message
- •
-
--hostname: Show the hostname that OpenSHMEM was configured and built on
- •
-
--internal: Show internal MCA parameters (not meant to be modified by users)
- •
-
--level: Show only variables with at most this level (1-9). The default is 1 unless--allis specified without--levelin which case the default is 9. See the LEVELS section for more information.
- •
-
-mca, --mca <param> <value>: Pass context-specific MCA parameters; they are considered global if--gmcais not used and only one context is specified.
- •
-
--param <type> <component>: Show MCA parameters. The first parameter is the type of the component to display; the second parameter is the specific component to display (or the keyword
all, meaning “display all components of this type”).
- •
-
--parsable: When used in conjunction with other parameters, the output is displayed in a machine-parsable format--parseableSynonym for--parsable.
- •
-
--path <type>: Show paths that OpenSHMEM was configured with. Accepts the following parameters:
prefix,bindir,libdir,incdir,pkglibdir,sysconfdir.
- •
-
--pretty: When used in conjunction with other parameters, the output is displayed in prettyprint format (default)
- •
-
--selected-only: Show only variables from selected components.
- •
-
-V,--version*: Show version of OpenSHMEM.
Levels
1.
|
Basic information of interest to users |
|---|---|
2.
|
Detailed information of interest to users |
3.
|
All remaining information of interest to users |
4.
|
Basic information required for tuning |
5.
|
Detailed information required for tuning |
6.
|
All remaining information required for tuning |
7.
|
Basic information for OpenSHMEM implementors |
8.
|
Detailed information for OpenSHMEM implementors |
9.
|
All remaining information for OpenSHMEM implementors |
Examples
shell$ oshmem_infoShow the default output of options and listing of installed components in a human-readable / prettyprint format.
shell$ oshmem_info --parsableShow the default output of options and listing of installed components in a machine-parsable format.
shell$ oshmem_info --param btl openibShow the MCA parameters of the “openib” BTL component in a human-readable / prettyprint format.
shell$ oshmem_info --param btl openib --parsableShow the MCA parameters of the “openib” BTL component in a machine-parsable format.
shell$ oshmem_info --path bindirShow the “bindir” that OpenSHMEM was configured with.
shell$ oshmem_info --version ompi full --parsableShow the full version numbers of OpenSHMEM (including the ORTE and OPAL version numbers) in a machine-readable format.
shell$ oshmem_info --version btl majorShow the major version number of all BTL components in a prettyprint format.
shell$ oshmem_info --version btl:tcp minorShow the minor version number of the TCP BTL component in a prettyprint format.
shell$ oshmem_info --allShow all information about the OpenSHMEM installation, including all components that can be found, the MCA parameters that they support, versions of OpenSHMEM and the components, etc.
Releases
6 releases since Debian 9 (Stretch); the text changed 5 times.
--arch until Debian 12 (Bookworm);
--hostname until Debian 12 (Bookworm);
--internal until Debian 12 (Bookworm);
--level until Debian 12 (Bookworm);
--parsable until Debian 12 (Bookworm);
--path until Debian 12 (Bookworm);
--pretty until Debian 12 (Bookworm);
--selected-only until Debian 12 (Bookworm).