LAMINFO(1)

💖 LAMINFO — the glow-up guide 💖

okay so bestie, this is laminfo from the LAM TOOLS collection, and it's literally the vibe-check tool for your whole LAM/MPI install. it tells you everything about how your LAM was configured, no cap. 🫶

---

✨ NAME ✨

laminfo — display configuration information about LAM/MPI 🌸

---

✨ SYNOPSIS ✨

laminfo [-arch] [-config] [-help|-h] [-param type module]
        [-parsable|-pretty] [-path item] [-version item scope]

---

✨ OPTIONS ✨

• -all — show all the configuration information, the whole entire menu, no skips 💅
• -arch — show the architecture that LAM was configured for
• -config — show some info about the LAM configuration
• -help — show the help message (we love a supportive icon)
• -param — show SSI parameter(s) for a given SSI type and module
• -parsable — show output in an easily parsable format, for the script girlies 🤖
• -path item — print a given configuration path
• -pretty — show output in a prettyprint format (this is the default, bestie, we stay cute by default 🎀)
• -version — print some or part of a version number of a given item

---

✨ DESCRIPTION ✨

so the laminfo command displays information about a LAM/MPI installation. and honestly? especially with the SSI run-time module selection system, laminfo is so useful to scripts and resource managers, because it's how they figure out the capabilities of the installed LAM/MPI so they can pass run-time parameters to MPI programs. main character tool fr fr 👑

output can come in a "pretty" format (aka suitable for human reading, gorgeous, we love) and also in a parsable format (aka suitable for easy parsing by scripts or other automated mechanisms, the nerdy-but-hot version). and here's the thing: there are no other LAM API functions to retrieve this data — in any language — so laminfo is literally the best mechanism to obtain any configuration information about LAM/MPI. the parsable output was designed so that common utilities like grep, awk, cut, and sed can easily extract the relevant info. iconic behavior. 💖

running laminfo with no arguments displays a subset of configuration parameters in the "pretty" format (peep the EXAMPLES section below 👇). several command line options let you limit exactly which information gets displayed. and when you pair those options with the parsable output, automated mechanisms can grab specific info about the capabilities of LAM/MPI. slay.

---

🌈 GENERAL PARAMETERS 🌈

the -pretty and -parsable switches pick whether the output shows in "pretty" or machine-parsable format respectively. if you specify neither, -pretty is the default. periodt.

the -arch switch displays the architecture that LAM/MPI was configured and compiled on.

the -config switch displays a set of configuration information about the MPI capabilities of LAM/MPI, like:

• whether there are C, C++, and Fortran MPI bindings available
• whether there's MPI profiling support for C, C++, and Fortran
• whether ROMIO support is available
• whether IMPI support is available
• whether debugging support is available (mostly for LAM/MPI maintainers, iykyk)
• whether LAM/MPI is "purify clean" (meaning it's suitable for use with memory checking debuggers)

most of these are options to the LAM/MPI configure script, and they're configure/compile-time selections that cannot be changed once LAM has been installed. 😭 and while there's no fine-grained control to individually request each one of these pieces of info, using -config together with -parsable and commands like grep can return any individual piece you want. work smarter not harder.

---

🌸 PARAM PARAMETERS 🌸

the -param switch shows available SSI parameters and their default values. the type and module arguments specify a particular SSI type and/or module, or you can use the special keyword all to mean all available SSI types/modules (respectively).

available SSI types are:

• all — show all SSI types
• base — intrinsic LAM/MPI parameters
• boot — boot modules (e.g., lamboot)
• coll — MPI collectives
• cr — checkpoint / restart
• RPI — MPI point-to-point.

the names of the available modules depend on which modules are available for any given type. see EXAMPLES below for example usage. 👀

---

🦋 PATH PARAMETERS 🦋

the -path switch returns various paths that were compiled into LAM/MPI. these were all decided when LAM was configured, and cannot be changed at run-time. however, knowing where these directories live is useful for finding LAM data files, binaries, include files, etc. the -path switch takes a parameter: item. possible values for item are:

• prefix — display the prefix directory for LAM/MPI
• bindir — display the directory where the LAM/MPI executables were installed
• libdir — display the directory where the LAM/MPI libraries were installed
• incdir — display the directory where the LAM/MPI include files were installed
• pkglibdir — display the directory where the LAM/MPI dynamic libraries were installed
• sysconfdir — display the directory where the LAM/MPI help and configuration files were installed

bestie, heads up: even though LAM's GNU configure script defaults to certain values for all of these directories based on the prefix (e.g., bindir is typically $prefix/bin), they can all be overridden by command line switches to configure, and should therefore never be assumed. use laminfo to find out what values were actually selected at configure time. don't guess, ok? 🙈

---

💜 VERSION PARAMETERS 💜

since each SSI module in LAM/MPI is an independent entity in itself, it may have a completely different version number than LAM/MPI itself. and actually, each SSI module has three version numbers:

1. the version of the base SSI API that it supports
2. the version of the component type API that it supports
3. its own version number

most users only care about the last one (the module's own version number). same, honestly.

the -path switch takes two parameters: item and scope.

the item can be the main LAM version itself, any of the SSI types, or a specific SSI module. there are currently four kinds of SSI modules that can be queried: boot, coll, rpi, and cr. hence, the version numbers you can get from the -version switch are:

• lam — the version of LAM/MPI
• boot — the three versions of each boot SSI module
• boot:name — the three versions of a specific boot SSI module
• coll — the three versions of each coll SSI module
• coll:name — the three versions of a specific coll SSI module
• rpi — the three versions of each rpi SSI module
• rpi:name — the three versions of a specific rpi SSI module
• cr — the three versions of each cr SSI module
• cr:name — the three versions of a specific cr SSI module

the scope argument describes what part of the version number to display, so you can get the full version number or any specific individual component. valid values for scope are:

• full — display the full version number (i.e., all components). a sequence of rules runs all the components together into a single string. generally: major and minor are always displayed, but other components are only displayed if they are not zero.
• major — display the major version number
• minor — display the minor version number
• release — display the release version number
• alpha — display the alpha version number. in the full scope, if nonzero, this number will be preceded by "a".
• beta — display the beta version number. in the full scope, if nonzero, this number will be preceded by "b".
• cvs — display whether LAM was installed from a CVS checkout. in pretty mode, this is the string "cvs" if true, or blank if false. in parsable mode, this is 1 if true, 0 if false.

---

✨ EXAMPLES ✨

• laminfo
  • with no parameters, laminfo displays a default set of information about the LAM/MPI installation. this info includes:
• version of LAM/MPI
• installation prefix directory
• architecture that LAM/MPI is installed for
• user who configured LAM/MPI
• time/datestamp when LAM/MPI was configured
• host that LAM/MPI was configured on
• whether MPI bindings are provided for C, C++, Fortran
• whether MPI profiling is available for C, C++, Fortran
• whether ROMIO support is included
• whether IMPI support is included
• whether debug support is included (mainly for LAM/MPI maintainers; specifically indicates whether --with-debug was used to configure LAM)
• whether LAM/MPI is "purify clean" (suitable for memory-checking debuggers; specifically indicates whether --with-purify was used to configure LAM)
• list all boot, coll, and rpi SSI modules that are available, and their corresponding versions
• laminfo -parsable
  • display the same default set of information but in a machine-readable format.
• laminfo -all
  • display all information that is available to laminfo.
• laminfo -param all all
  • show all SSI parameters (and their corresponding default values) for all available SSI types and modules.
• laminfo -param rpi all
  • show all SSI parameters (and their corresponding default values) for all rpi SSI modules.
• laminfo -param rpi tcp
  • show all SSI parameters (and their corresponding default values) for the tcp rpi SSI module.
• laminfo -param rpi tcp -parsable
  • show all SSI parameters (and their corresponding default values) for the tcp rpi SSI module in a machine-readable format.
• laminfo -path bindir -path sysconfdir -parsable
  • display the directories where the LAM/MPI executables and help/configuration files were installed in a machine-readable format.
• laminfo -version lam full -parsable
  • display the full version of LAM/MPI in a machine-readable format.
• laminfo -version rpi:tcp full
  • show the full version of the TCP RPI SSI module.

---

🌈 SEE ALSO 🌈

lamssi(7), mpirun(1), lamboot(1), lamwipe(1)

---

okay and for the lil sign-off bestie: this whole thing is from LAM 7.1.4, dated July, 2007 🎀 she's vintage, she's classic, she ate. go forth and laminfo responsibly 💖✨🦋