[openib-general] [PATCH] OpenSM: Update opensm man page and modular-routing.txt for LID matrix handling

[Hal Rosenstock]

OpenSM: Update opensm man page and modular-routing.txt for LID matrix
handling

Signed-off-by: Hal Rosenstock <halr at voltaire.com>

Index: man/opensm.8
===================================================================
--- man/opensm.8	(revision 10004)
+++ man/opensm.8	(working copy)
@@ -5,7 +5,7 @@ opensm \- InfiniBand subnet manager and 
 
 .SH SYNOPSIS
 .B opensm
-[\-c(ache-options)] [\-g(uid)[=]<GUID in hex>] [\-l(mc) <LMC>] [\-p(riority) <PRIORITY>] [\-smkey <SM_Key>] [\-r(eassign_lids)] [\-R <engine name> | \-routing_engine <engine name>] [\-U <file name> | \-ucast_file <file name>] [\-a(dd_guid_file) <path to file>] [\-o(nce)] [\-s(weep) <interval>] [\-t(imeout) <milliseconds>] [\-maxsmps <number>] [\-console] [\-i(gnore-guids) <equalize-ignore-guids-file>] [\-f | \-\-log_file] [\-L | \-\-log_limit <size in MB>] [\-e(rase_log_file)] [\-P(config)] [\-Q | \-no_qos] [\-N | \-no_part_enforce] [\-y | \-stay_on_fatal] [\-v(erbose)] [\-V] [\-D <flags>] [\-d(ebug) <number>] [\-h(elp)] [\-?]
+[\-c(ache-options)] [\-g(uid)[=]<GUID in hex>] [\-l(mc) <LMC>] [\-p(riority) <PRIORITY>] [\-smkey <SM_Key>] [\-r(eassign_lids)] [\-R <engine name> | \-routing_engine <engine name>] [\-M <file name> | \-lid_matrix_file <file name>] [\-U <file name> | \-ucast_file <file name>] [\-a(dd_guid_file) <path to file>] [\-o(nce)] [\-s(weep) <interval>] [\-t(imeout) <milliseconds>] [\-maxsmps <number>] [\-console] [\-i(gnore-guids) <equalize-ignore-guids-file>] [\-f | \-\-log_file] [\-L | \-\-log_limit <size in MB>] [\-e(rase_log_file)] [\-P(config)] [\-Q | \-no_qos] [\-N | \-no_part_enforce] [\-y | \-stay_on_fatal] [\-v(erbose)] [\-V] [\-D <flags>] [\-d(ebug) <number>] [\-h(elp)] [\-?]
 
 .SH DESCRIPTION
 .PP
@@ -85,6 +85,11 @@ LID assignments resolving multiple use o
 This option chooses routing engine instead of Min Hop
 algorithm (default). Supported engines: updn, file
 .TP
+\fB\-M\fR, \fB\-\-lid_matrix_file\fR
+This option specifies name of the lid matrix dump file
+from where switch lid matrices (min hops tables will be
+loaded.
+.TP
 \fB\-U\fR, \fB\-\-ucast_file\fR
 This option specifies name of the unicast dump file
 from where switch forwarding tables will be loaded.
@@ -566,6 +571,27 @@ To activate file based routing module, u
 If the dump_file is not found or is in error, the default routing 
 algorithm is utilized.
 
+The ability to dump switch lid matrices (aka min hops tables) to file and
+later to load these is also supported.
+
+The usage is similar to unicast forwarding tables loading from dump
+file (introduced by 'file' routing engine), but new lid matrix file
+name should be specified by -M or --lid_matrix_file option. For example:
+
+  opensm -R file -M ./opensm-lid-matrix.dump
+
+The dump file is named 'opensm-lid-matrix.dump' and will be generated in
+standard opensm dump directory (/var/log by default) when
+OSM_LOG_ROUTING logging flag is set.
+
+When routing engine 'file' is activated, but dump file is not specified
+or not cannot be open default lid matrix algorithm will be used.
+
+There is also a switch forwarding tables dumper which generates
+a file compatible with dump_lfts.sh output. This file can be used
+as input for forwarding tables loading by 'file' routing engine.
+Both or one of options -U and -M can be specified together with '-R file'.
+
 
 .SH AUTHORS
 .TP
Index: doc/modular-routing.txt
===================================================================
--- doc/modular-routing.txt	(revision 10004)
+++ doc/modular-routing.txt	(working copy)
@@ -51,6 +51,27 @@ In order to activate new module use:
 If the dump_file is not found or is in error, the default routing 
 algorithm is utilized.
 
+The ability to dump switch lid matrices (aka min hops tables) to file and
+later to load these is also supported.
+
+The usage is similar to unicast forwarding tables loading from dump
+file (introduced by 'file' routing engine), but new lid matrix file
+name should be specified by -M or --lid_matrix_file option. For example:
+
+  opensm -R file -M ./opensm-lid-matrix.dump
+
+The dump file is named 'opensm-lid-matrix.dump' and will be generated in
+standard opensm dump directory (/var/log by default) when
+OSM_LOG_ROUTING logging flag is set.
+
+When routing engine 'file' is activated, but dump file is not specified
+or not cannot be open default lid matrix algorithm will be used.
+
+There is also a switch forwarding tables dumper which generates
+a file compatible with dump_lfts.sh output. This file can be used
+as input for forwarding tables loading by 'file' routing engine.
+Both or one of options -U and -M can be specified together with '-R file'.
+
 NOTE: ibroute has been updated (for switch management ports) to support this.
 Also, lmc was added to switch management ports. ibroute needs to be r7855 or
 later from the trunk.