[PATCH] ibutils/ibdm/doc: Add man pages for dump2psl.pl and dump2slvl.pl

[Hal Rosenstock <hal-LDSdmyG8hGV8YrgS2mwiifqBs+8SCbDb@public.gmane.org>]

Signed-off-by: Hal Rosenstock <hal-VPRAkNaXOzVWk0Htik3J/w@public.gmane.org>
---
 ibdm/doc/Makefile.am   |    8 ++-
 ibdm/doc/dump2psl.1    |  171 ++++++++++++++++++++++++++++++++++++++++++++++++
 ibdm/doc/dump2psl.pod  |   48 +++++++++++++
 ibdm/doc/dump2slvl.1   |  155 +++++++++++++++++++++++++++++++++++++++++++
 ibdm/doc/dump2slvl.pod |   32 +++++++++
 5 files changed, 412 insertions(+), 2 deletions(-)
 create mode 100644 ibdm/doc/dump2psl.1
 create mode 100644 ibdm/doc/dump2psl.pod
 create mode 100644 ibdm/doc/dump2slvl.1
 create mode 100644 ibdm/doc/dump2slvl.pod

diff --git a/ibdm/doc/Makefile.am b/ibdm/doc/Makefile.am
index bc28a03..e84720e 100644
--- a/ibdm/doc/Makefile.am
+++ b/ibdm/doc/Makefile.am
@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2004-2010 Mellanox Technologies LTD. All rights reserved.
+# Copyright (c) 2004-2011 Mellanox Technologies LTD. All rights reserved.
 #
 # This software is available to you under a choice of one of two
 # licenses.  You may choose to be licensed under the terms of the GNU
@@ -35,7 +35,9 @@ man_MANS = ibdmtr.1 \
 	ibdmsh.1 \
 	ibdm-topo-file.1 \
 	ibdm-ibnl-file.1 \
-	ibtopodiff.1
+	ibtopodiff.1 \
+	dump2psl.1 \
+	dump2slvl.1
 
 EXTRA_DIST = \
 	ibdmtr.pod         ibdmtr.1 \
@@ -44,6 +46,8 @@ EXTRA_DIST = \
 	ibdm-topo-file.pod ibdm-topo-file.1 \
 	ibdm-ibnl-file.pod ibdm-ibnl-file.1 \
 	ibtopodiff.pod     ibtopodiff.1 \
+	dump2psl.pod       dump2psl.1 \
+	dump2slvl.pod      dump2slvl.1 \
 	ibdm_pod2man
 
 %.1: @MAINTAINER_MODE_TRUE@ %.pod
diff --git a/ibdm/doc/dump2psl.1 b/ibdm/doc/dump2psl.1
new file mode 100644
index 0000000..ac91a44
--- /dev/null
+++ b/ibdm/doc/dump2psl.1
@@ -0,0 +1,171 @@
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sh \" Subsection heading
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings.  \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote.  | will give a
+.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
+.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
+.\" expand to `' in nroff, nothing in troff, for use with C<>.
+.tr \(*W-|\(bv\*(Tr
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+.    ds -- \(*W-
+.    ds PI pi
+.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
+.    ds L" ""
+.    ds R" ""
+.    ds C` ""
+.    ds C' ""
+'br\}
+.el\{\
+.    ds -- \|\(em\|
+.    ds PI \(*p
+.    ds L" ``
+.    ds R" ''
+'br\}
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" entries marked with X<> in POD.  Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.if \nF \{\
+.    de IX
+.    tm Index:\\$1\t\\n%\t"\\$2"
+..
+.    nr % 0
+.    rr F
+.\}
+.\"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.hy 0
+.if n .na
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
+.    \" fudge factors for nroff and troff
+.if n \{\
+.    ds #H 0
+.    ds #V .8m
+.    ds #F .3m
+.    ds #[ \f1
+.    ds #] \fP
+.\}
+.if t \{\
+.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+.    ds #V .6m
+.    ds #F 0
+.    ds #[ \&
+.    ds #] \&
+.\}
+.    \" simple accents for nroff and troff
+.if n \{\
+.    ds ' \&
+.    ds ` \&
+.    ds ^ \&
+.    ds , \&
+.    ds ~ ~
+.    ds /
+.\}
+.if t \{\
+.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+.    \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+.    \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+.    \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+.    ds : e
+.    ds 8 ss
+.    ds o a
+.    ds d- d\h'-1'\(ga
+.    ds D- D\h'-1'\(hy
+.    ds th \o'bp'
+.    ds Th \o'LP'
+.    ds ae ae
+.    ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "DUMP2PSL 1"
+.TH DUMP2PSL 1 "2011-04-08" "IBDM 1.0" "IB DATA MODEL PACKAGE"
+.SH "NAME"
+\&\fBdump2psl.pl\fR \-  Dump psl file to be used for credit loop checking based on some opensm output files
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+cat opensm\-{subnet.lst,path\-records.dump} | dump2psl.pl > opensm.psl
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+dump2psl.pl dumps a psl file based on some opensm output files. A psl file
+contains paths (including SLs) and is needed for subsequent credit loop
+checking (via ibdmchk). This conversion is needed when ibutils is not
+installed and credit loop checking is done on a different machine or later.
+Credit loop checking is especially valuable for the QoS based routing
+algorithms (e.g. torus\-2QoS, lash, etc.).
+.PP
+ibdiagnet \-vlr dumps the psl (and slvl) files needed for ibdmchk \-M \-a \-s
+(which is the credit loop check).
+.PP
+Dumping of path records is accomplished by the PathRecord dumping plugin to the
+OpenSM. When the environment variable \s-1DUMP_FULL_PATH_RECORDS\s0 is set to 1,
+the full set of \s-1SA\s0 path records is dumped to opensm\-path\-records.dump in
+the dump_files_dir directory (default is /var/log).
+.PP
+When the routing protocol is torus\-2QoS, the following two files are dumped
+by the PathRecord dumping plugin: opensm\-peer\-paths.dump and
+opensm\-sw2sw\-path\-records.dump. The peer paths dump file contains the CAs
+and their neighbor switch and includes the link \s-1MTU\s0 and \s-1RATE\s0. The switch to
+switch file contains for each source switch a table of destination switches
+and the \s-1SL\s0, \s-1RATE\s0, and \s-1MTU\s0 to be used for \s-1MPI\s0 traffic.
+.PP
+Note that since the PathRecord dump uses port GUIDs and the ibdmchk psl
+file uses node GUIDs, the fabric .lst file is also required as input
+(see \s-1SYNOPSIS\s0).
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+.IP "\fIdump2slvl\fR\|(1), \fIibdmchk\fR\|(1), \fIibdiagnet\fR\|(1)" 4
+.IX Item "dump2slvl, ibdmchk, ibdiagnet"
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+Hal Rosenstock, Mellanox Technologies \s-1LTD\s0, hal-VPRAkNaXOzVWk0Htik3J/w@public.gmane.org
diff --git a/ibdm/doc/dump2psl.pod b/ibdm/doc/dump2psl.pod
new file mode 100644
index 0000000..37e67eb
--- /dev/null
+++ b/ibdm/doc/dump2psl.pod
@@ -0,0 +1,48 @@
+=head1 NAME
+
+B<dump2psl.pl> -  Dump psl file to be used for credit loop checking based on some opensm output files
+
+=head1 SYNOPSIS
+
+cat opensm-{subnet.lst,path-records.dump} | dump2psl.pl > opensm.psl
+
+=head1 DESCRIPTION
+
+dump2psl.pl dumps a psl file based on some opensm output files. A psl file
+contains paths (including SLs) and is needed for subsequent credit loop
+checking (via ibdmchk). This conversion is needed when ibutils is not
+installed and credit loop checking is done on a different machine or later.
+Credit loop checking is especially valuable for the QoS based routing
+algorithms (e.g. torus-2QoS, lash, etc.).
+
+ibdiagnet -vlr dumps the psl (and slvl) files needed for ibdmchk -M -a -s
+(which is the credit loop check).
+
+Dumping of path records is accomplished by the PathRecord dumping plugin to the
+OpenSM. When the environment variable DUMP_FULL_PATH_RECORDS is set to 1,
+the full set of SA path records is dumped to opensm-path-records.dump in
+the dump_files_dir directory (default is /var/log).
+
+When the routing protocol is torus-2QoS, the following two files are dumped
+by the PathRecord dumping plugin: opensm-peer-paths.dump and
+opensm-sw2sw-path-records.dump. The peer paths dump file contains the CAs
+and their neighbor switch and includes the link MTU and RATE. The switch to
+switch file contains for each source switch a table of destination switches
+and the SL, RATE, and MTU to be used for MPI traffic.
+
+Note that since the PathRecord dump uses port GUIDs and the ibdmchk psl
+file uses node GUIDs, the fabric .lst file is also required as input
+(see SYNOPSIS).
+
+=head1 SEE ALSO
+
+=over
+
+=item dump2slvl(1), ibdmchk(1), ibdiagnet(1)
+
+=back
+
+=head1 AUTHOR
+
+Hal Rosenstock, Mellanox Technologies LTD, hal-VPRAkNaXOzVWk0Htik3J/w@public.gmane.org
+
diff --git a/ibdm/doc/dump2slvl.1 b/ibdm/doc/dump2slvl.1
new file mode 100644
index 0000000..cea5bdd
--- /dev/null
+++ b/ibdm/doc/dump2slvl.1
@@ -0,0 +1,155 @@
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sh \" Subsection heading
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings.  \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote.  | will give a
+.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
+.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
+.\" expand to `' in nroff, nothing in troff, for use with C<>.
+.tr \(*W-|\(bv\*(Tr
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+.    ds -- \(*W-
+.    ds PI pi
+.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
+.    ds L" ""
+.    ds R" ""
+.    ds C` ""
+.    ds C' ""
+'br\}
+.el\{\
+.    ds -- \|\(em\|
+.    ds PI \(*p
+.    ds L" ``
+.    ds R" ''
+'br\}
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" entries marked with X<> in POD.  Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.if \nF \{\
+.    de IX
+.    tm Index:\\$1\t\\n%\t"\\$2"
+..
+.    nr % 0
+.    rr F
+.\}
+.\"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.hy 0
+.if n .na
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
+.    \" fudge factors for nroff and troff
+.if n \{\
+.    ds #H 0
+.    ds #V .8m
+.    ds #F .3m
+.    ds #[ \f1
+.    ds #] \fP
+.\}
+.if t \{\
+.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+.    ds #V .6m
+.    ds #F 0
+.    ds #[ \&
+.    ds #] \&
+.\}
+.    \" simple accents for nroff and troff
+.if n \{\
+.    ds ' \&
+.    ds ` \&
+.    ds ^ \&
+.    ds , \&
+.    ds ~ ~
+.    ds /
+.\}
+.if t \{\
+.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+.    \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+.    \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+.    \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+.    ds : e
+.    ds 8 ss
+.    ds o a
+.    ds d- d\h'-1'\(ga
+.    ds D- D\h'-1'\(hy
+.    ds th \o'bp'
+.    ds Th \o'LP'
+.    ds ae ae
+.    ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "DUMP2SLVL 1"
+.TH DUMP2SLVL 1 "2011-04-08" "IBDM 1.0" "IB DATA MODEL PACKAGE"
+.SH "NAME"
+\&\fBdump2slvl.pl\fR \-  Dump slvl file to be used for credit loop checking based on opensm output file
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+cat opensm\-sl2vl.dump | dump2slvl.pl > opensm.slvl
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+dump2slvl.pl dumps a slvl file based on an opensm output file. A slvl file
+contains the \s-1SL\s0 to \s-1VL\s0 mappings and is needed for subsequent credit loop
+checking (via ibdmchk). This conversion is needed when ibutils is not
+installed and credit loop checking is done on a different machine or later.
+Credit loop checking is especially valuable for the QoS based routing
+algorithms (e.g. torus\-2QoS, lash, etc.).
+.PP
+ibdiagnet \-vlr dumps the slvl (and psl) files needed for ibdmchk \-M \-a \-s
+(which is the credit loop check).
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+.IP "\fIdump2psl\fR\|(1), \fIibdmchk\fR\|(1), \fIibdiagnet\fR\|(1)" 4
+.IX Item "dump2psl, ibdmchk, ibdiagnet"
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+Hal Rosenstock, Mellanox Technologies \s-1LTD\s0, hal-VPRAkNaXOzVWk0Htik3J/w@public.gmane.org
diff --git a/ibdm/doc/dump2slvl.pod b/ibdm/doc/dump2slvl.pod
new file mode 100644
index 0000000..d660f0e
--- /dev/null
+++ b/ibdm/doc/dump2slvl.pod
@@ -0,0 +1,32 @@
+=head1 NAME
+
+B<dump2slvl.pl> -  Dump slvl file to be used for credit loop checking based on opensm output file
+
+=head1 SYNOPSIS
+
+cat opensm-sl2vl.dump | dump2slvl.pl > opensm.slvl
+
+=head1 DESCRIPTION
+
+dump2slvl.pl dumps a slvl file based on an opensm output file. A slvl file
+contains the SL to VL mappings and is needed for subsequent credit loop
+checking (via ibdmchk). This conversion is needed when ibutils is not
+installed and credit loop checking is done on a different machine or later.
+Credit loop checking is especially valuable for the QoS based routing
+algorithms (e.g. torus-2QoS, lash, etc.).
+
+ibdiagnet -vlr dumps the slvl (and psl) files needed for ibdmchk -M -a -s
+(which is the credit loop check).
+
+=head1 SEE ALSO
+
+=over
+
+=item dump2psl(1), ibdmchk(1), ibdiagnet(1)
+
+=back
+
+=head1 AUTHOR
+
+Hal Rosenstock, Mellanox Technologies LTD, hal-VPRAkNaXOzVWk0Htik3J/w@public.gmane.org
+
-- 
1.7.2.1

--
To unsubscribe from this list: send the line "unsubscribe linux-rdma" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html