From patchwork Fri Apr 8 13:41:17 2011 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Hal Rosenstock X-Patchwork-Id: 694601 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by demeter1.kernel.org (8.14.4/8.14.3) with ESMTP id p38DfPLd019641 for ; Fri, 8 Apr 2011 13:41:25 GMT Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1756685Ab1DHNlY (ORCPT ); Fri, 8 Apr 2011 09:41:24 -0400 Received: from mail-fx0-f46.google.com ([209.85.161.46]:53581 "EHLO mail-fx0-f46.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1756664Ab1DHNlY (ORCPT ); Fri, 8 Apr 2011 09:41:24 -0400 Received: by fxm17 with SMTP id 17so2335623fxm.19 for ; Fri, 08 Apr 2011 06:41:22 -0700 (PDT) Received: by 10.223.20.216 with SMTP id g24mr2256051fab.115.1302270082578; Fri, 08 Apr 2011 06:41:22 -0700 (PDT) Received: from [192.168.1.103] (c-75-69-247-31.hsd1.ma.comcast.net [75.69.247.31]) by mx.google.com with ESMTPS id 14sm685013fas.6.2011.04.08.06.41.19 (version=SSLv3 cipher=OTHER); Fri, 08 Apr 2011 06:41:20 -0700 (PDT) Message-ID: <4D9F107D.2000507@dev.mellanox.co.il> Date: Fri, 08 Apr 2011 09:41:17 -0400 From: Hal Rosenstock User-Agent: Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.9.2.15) Gecko/20110303 Thunderbird/3.1.9 MIME-Version: 1.0 To: Yevgeny Kliteynik , Yevgeny Kliteynik CC: "linux-rdma@vger.kernel.org" Subject: [PATCH] ibutils/ibdm/doc: Add man pages for dump2psl.pl and dump2slvl.pl Sender: linux-rdma-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-rdma@vger.kernel.org X-Greylist: IP, sender and recipient auto-whitelisted, not delayed by milter-greylist-4.2.6 (demeter1.kernel.org [140.211.167.41]); Fri, 08 Apr 2011 13:41:26 +0000 (UTC) Signed-off-by: Hal Rosenstock --- 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@mellanox.com 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 - 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@mellanox.com + 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@mellanox.com 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 - 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@mellanox.com +