laminfo - Display configuration information about LAM/MPI


SUBMITTED BY: Guest

DATE: June 6, 2014, 9:20 a.m.

FORMAT: Text only

SIZE: 6.7 kB

HITS: 3259

  1. NAME
  2. laminfo - Display configuration information about LAM/MPI
  3. SYNTAX
  4. laminfo [-version <item> <scope>] [-path <item>] [-arch]
  5. [-config] [-pretty|-parsable] [-help|-h]
  6. OPTIONS
  7. -arch
  8. Show architecture that LAM was configured for
  9. -config
  10. Show some information about LAM configuration
  11. -help
  12. Show help message
  13. -parsable
  14. Show output in an easily parsable format
  15. -path <item>
  16. Print a given configuration path
  17. -pretty
  18. Show output in a prettyprint format (default)
  19. -version
  20. Print some or part of a version number of a given item
  21. DESCRIPTION
  22. The laminfo command is used to display information about a LAM/MPI installation. Particularly with the SSI run-time module selection system, the laminfo command can be useful to scripts and resource managers to determine the capabilities of the installed LAM/MPI in order to pass run-time parameters to MPI programs.
  23. Output can be displayed in a "pretty" format (i.e., suitable for human reading) and also in a parsable format (i.e., suitable for easy parsing by scripts or other automated mechanisms). There are no other LAM API functions to retrieve this data (in any language); the laminfo command is the best mechanism to obtain any configuration information about LAM/MPI. The parsable output was designed such that common utilities such as grep, awk, cut, and sed can easily be used to extract relevant information.
  24. Running laminfo with no arguments will display a subset of configuration parameters in the "pretty" format (see the EXAMPLES section, below). Several command line options are available to limit exactly which information is displayed. These options, when used in conjunction with the parsable output, can provide automated mechanisms specific information about the capabilities of LAM/MPI.
  25. GENERAL PARAMETERS
  26. The -pretty and -parsable switches are used to select whether to display the output in "pretty" or machine-parsable format, respectively. If neither is specified, -pretty is the default.
  27. The -arch switch will display the architecture that LAM/MPI was configured and compiled on.
  28. The -config switch will display a set of configuration information about the MPI capabilities of LAM/MPI, such as whether there are C, C++, and Fortran MPI bindings available, whether there is 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), and whether LAM/MPI is "purify clean" (meaning that it is suitable for use with memory checking debuggers). Most of these are options to the LAM/MPI configure script, and are configure/compile-time selections that cannot be changed once LAM has been installed. While there is no fine-grained control to individually request each of these pieces of information, using -config in conjunction with -parsable and commands such as grep can return any individual piece of information.
  29. PATH PARAMETERS
  30. 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 the location of these directories can be useful in order to find LAM data files, binaries, include files, etc. The -path switch takes a parameter: item. Possible values for item are:
  31. prefix
  32. Display the prefix directory for LAM/MPI
  33. bindir
  34. Display the directory where the LAM/MPI executables were installed
  35. libdir
  36. Display the directory where the LAM/MPI libraries were installed
  37. incdir
  38. Display the directory where the LAM/MPI include files were installed
  39. pkglibdir
  40. Display the directory where the LAM/MPI dynamic libraries were installed
  41. sysconfdir
  42. Display the directory where the LAM/MPI help and configuration files were installed
  43. Note that although 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 overriden by command line switches to configure, and should therefore never be assumed. Use laminfo to determine what values were selected at configure time.
  44. VERSION PARAMETERS
  45. Since each SSI module in LAM/MPI is an independant entity in itself, it may have an entirely different version number than LAM/MPI itself. Indeed, each SSI module has three version numbers: the version of the base SSI API that it supports, the version of the component type API that it supports, and its own version number. Most users will only care about the last one (the module's own version number).
  46. The -path switch takes two parameters: item and scope.
  47. 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 that can be obtained from the -version switch are:
  48. lam
  49. The version of LAM/MPI
  50. boot
  51. The three versions of each boot SSI module
  52. boot:name
  53. The three versions of a specific boot SSI module
  54. coll
  55. The three versions of each coll SSI module
  56. coll:name
  57. The three versions of a specific coll SSI module
  58. rpi
  59. The three versions of each rpi SSI module
  60. rpi:name
  61. The three versions of a specific rpi SSI module
  62. cr
  63. The three versions of each cr SSI module
  64. cr:name
  65. The three versions of a specific cr SSI module
  66. The scope argument describes what part of the version number to display. This allows either the full version number to be displayed, or any specific individual component of the version number. Valid values for scope are:
  67. full
  68. Display the full version number (i.e., all components). A sequence of rules are used to run 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.
  69. major
  70. Display the major version number
  71. minor
  72. Display the minor version number
  73. release
  74. Display the release version number
  75. alpha
  76. Display the alpha version number. In the full scope, if nonzero, this number will be preceeded by "a".
  77. beta
  78. Display the beta version number. In the full scope, if nonzero, this number will be preceeded by "b".
  79. cvs
  80. Display whether LAM was installed from a CVS checkout. In pretty mode, this will be the string "cvs" if true, or blank if false. In parsable mode, this will be 1 if true, 0 if false.

comments powered by Disqus