1LAMINFO(1) LAM TOOLS LAMINFO(1)
2
6 laminfo - Display configuration information about LAM/MPI
7
9 laminfo [-arch] [-config] [-help|-h] [-param <type> <module>]
10 [-parsable|-pretty] [-path <item>] [-version <item> <scope>]
11
13 -all Show all configuration information
14 -arch Show architecture that LAM was configured for
16 -config Show some information about LAM configuration
18 -help Show help message
20 -param Show SSI parameter(s) for a given SSI type and module
22 -parsable Show output in an easily parsable format
24 -path <item> Print a given configuration path
26 -pretty Show output in a prettyprint format (default)
28 -version Print some or part of a version number of a given item
30
32 The laminfo command is used to display information about a LAM/MPI
33 installation. Particularly with the SSI run-time module selection sys‐
34 tem, the laminfo command can be useful to scripts and resource managers
35 to determine the capabilities of the installed LAM/MPI in order to pass
36 run-time parameters to MPI programs.
37 Output can be displayed in a "pretty" format (i.e., suitable for human
39 reading) and also in a parsable format (i.e., suitable for easy parsing
40 by scripts or other automated mechanisms). There are no other LAM API
41 functions to retrieve this data (in any language); the laminfo command
42 is the best mechanism to obtain any configuration information about
43 LAM/MPI. The parsable output was designed such that common utilities
44 such as grep, awk, cut, and sed can easily be used to extract relevant
45 information.
46 Running laminfo with no arguments will display a subset of configura‐
48 tion parameters in the "pretty" format (see the EXAMPLES section,
49 below). Several command line options are available to limit exactly
50 which information is displayed. These options, when used in conjunc‐
51 tion with the parsable output, can provide automated mechanisms spe‐
52 cific information about the capabilities of LAM/MPI.
53 GENERAL PARAMETERS
55 The -pretty and -parsable switches are used to select whether to dis‐
56 play the output in "pretty" or machine-parsable format, respectively.
57 If neither is specified, -pretty is the default.
58 The -arch switch will display the architecture that LAM/MPI was config‐
60 ured and compiled on.
61 The -config switch will display a set of configuration information
63 about the MPI capabilities of LAM/MPI, such as whether there are C,
64 C++, and Fortran MPI bindings available, whether there is MPI profiling
65 support for C, C++, and Fortran, whether ROMIO support is available,
66 whether IMPI support is available, whether debugging support is avail‐
67 able (mostly for LAM/MPI maintainers), and whether LAM/MPI is "purify
68 clean" (meaning that it is suitable for use with memory checking debug‐
69 gers). Most of these are options to the LAM/MPI configure script, and
70 are configure/compile-time selections that cannot be changed once LAM
71 has been installed. While there is no fine-grained control to individ‐
72 ually request each of these pieces of information, using -config in
73 conjunction with -parsable and commands such as grep can return any
74 individual piece of information.
75 PARAM PARAMETERS
77 The -param switch can be used to show available SSI parameters and
78 their default values. The type and module arguments can be used to
79 specify a particular SSI type and/or module, or use the special keyword
80 "all" to indicate all available SSI types/modules (respectively).
81 Available SSI types are:
83 all Show all SSI types
85 base Intrinsic LAM/MPI parameters
87 boot Boot modules (e.g., lamboot)
89 coll MPI collectives
91 cr Checkpoint / restart
93 RPI MPI point-to-point.
95 The names of the modules that are available are dependant upon which
97 modules are available for any given type. See EXAMPLES, below, for
98 example usage.
99 PATH PARAMETERS
101 The -path switch returns various paths that were compiled into LAM/MPI.
102 These were all decided when LAM was configured, and cannot be changed
103 at run-time. However, knowing the location of these directories can be
104 useful in order to find LAM data files, binaries, include files, etc.
105 The -path switch takes a parameter: item. Possible values for item
106 are:
107 prefix Display the prefix directory for LAM/MPI
109 bindir Display the directory where the LAM/MPI executables were
111 installed
112 libdir Display the directory where the LAM/MPI libraries were
114 installed
115 incdir Display the directory where the LAM/MPI include files were
117 installed
118 pkglibdir Display the directory where the LAM/MPI dynamic libraries
120 were installed
121 sysconfdir Display the directory where the LAM/MPI help and configura‐
123 tion files were installed
124 Note that although LAM's GNU configure script defaults to certain val‐
126 ues for all of these directories based on the prefix (e.g., bindir is
127 typically $prefix/bin), they can all be overriden by command line
128 switches to configure, and should therefore never be assumed. Use lam‐
129 info to determine what values were selected at configure time.
130 VERSION PARAMETERS
132 Since each SSI module in LAM/MPI is an independant entity in itself, it
133 may have an entirely different version number than LAM/MPI itself.
134 Indeed, each SSI module has three version numbers: the version of the
135 base SSI API that it supports, the version of the component type API
136 that it supports, and its own version number. Most users will only
137 care about the last one (the module's own version number).
138 The -path switch takes two parameters: item and scope.
140 The item can be the main LAM version itself, any of the SSI types, or a
142 specific SSI module. There are currently four kinds of SSI modules
143 that can be queried: boot, coll, rpi, and cr. Hence, the version num‐
144 bers that can be obtained from the -version switch are:
145 lam The version of LAM/MPI
147 boot The three versions of each boot SSI module
149 boot:name The three versions of a specific boot SSI module
151 coll The three versions of each coll SSI module
153 coll:name The three versions of a specific coll SSI module
155 rpi The three versions of each rpi SSI module
157 rpi:name The three versions of a specific rpi SSI module
159 cr The three versions of each cr SSI module
161 cr:name The three versions of a specific cr SSI module
163 The scope argument describes what part of the version number to dis‐
165 play. This allows either the full version number to be displayed, or
166 any specific individual component of the version number. Valid values
167 for scope are:
168 full Display the full version number (i.e., all components). A
170 sequence of rules are used to run all the components
171 together into a single string. Generally: major and minor
172 are always displayed, but other components are only dis‐
173 played if they are not zero.
174 major Display the major version number
176 minor Display the minor version number
178 release Display the release version number
180 alpha Display the alpha version number. In the full scope, if
182 nonzero, this number will be preceeded by "a".
183 beta Display the beta version number. In the full scope, if
185 nonzero, this number will be preceeded by "b".
186 cvs Display whether LAM was installed from a CVS checkout. In
188 pretty mode, this will be the string "cvs" if true, or
189 blank if false. In parsable mode, this will be 1 if true,
190 0 if false.
191
193 laminfo
194 With no parameters, laminfo displays a default set of information
195 about the LAM/MPI installation. This information includes:
196 - Version of LAM/MPI
198 - Installation prefix directory
200 - Architecture that LAM/MPI is installed for
202 - User who configured LAM/MPI
204 - Time/datestamp when LAM/MPI was configured
206 - Host that LAM/MPI was configured on
208 - Whether MPI bindings are provided for C, C++, Fortran
210 - Whether MPI profiling is available for C, C++, Fortran
212 - Whether ROMIO support is included
214 - Whether IMPI support is included
216 - Whether debug support is included (mainly for LAM/MPI maintainers;
218 specifically indicates whether --with-debug was used to configure
219 LAM)
220 - Whether LAM/MPI is "purify clean" (suitable for memory-checking
222 debuggers; specifically indicates whether --with-purify was used to
223 configure LAM)
224 - List all boot, coll, and rpi SSI modules that are available, and
226 their corresponding versions
227 laminfo -parsable
229 Display the same default set of information but in a machine-read‐
230 able format.
231 laminfo -all
233 Display all information that is available to laminfo.
234 laminfo -param all all
236 Show all SSI parameters (and their corresponding default values)
237 for all available SSI types and modules.
238 laminfo -param rpi all
240 Show all SSI parameters (and their corresponding default values)
241 for all rpi SSI modules.
242 laminfo -param rpi tcp
244 Show all SSI parameters (and their corresponding default values)
245 for the tcp rpi SSI module.
246 laminfo -param rpi tcp -parsable
248 Show all SSI parameters (and their corresponding default values)
249 for the tcp rpi SSI module in a machine-readable format.
250 laminfo -path bindir -path sysconfdir -parsable
252 Display the directories where the LAM/MPI executables and help/con‐
253 figuration files were installed in a machine-readable format.
254 laminfo -version lam full -parsable
256 Display the full version of LAM/MPI in a machine-readable format.
257 laminfo -version rpi:tcp full
259 Show the full version of the TCP RPI SSI module.
260
262 lamssi(7), mpirun(1), lamboot(1), lamwipe(1)
263LAM 7.1.2 March, 2006 LAMINFO(1)