From patchwork Fri Nov 12 22:11:20 2010 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jim Schutt X-Patchwork-Id: 321562 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 oACMBd9M018672 for ; Fri, 12 Nov 2010 22:11:55 GMT Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S933131Ab0KLWLw (ORCPT ); Fri, 12 Nov 2010 17:11:52 -0500 Received: from sentry-three.sandia.gov ([132.175.109.17]:39002 "EHLO sentry-three.sandia.gov" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S933134Ab0KLWLr (ORCPT ); Fri, 12 Nov 2010 17:11:47 -0500 X-WSS-ID: 0LBSLNG-0C-278-02 X-M-MSG: Received: from sentry.sandia.gov (mm04snlnto.sandia.gov [132.175.109.21]) by sentry-three.sandia.gov (Postfix) with ESMTP id 19D6A4CA602; Fri, 12 Nov 2010 15:11:40 -0700 (MST) Received: from [132.175.109.1] by sentry.sandia.gov with ESMTP (SMTP Relay 01 (Email Firewall v6.3.2)); Fri, 12 Nov 2010 15:11:32 -0700 X-Server-Uuid: AF72F651-81B1-4134-BA8C-A8E1A4E620FF Received: from localhost.localdomain (sale659.sandia.gov [134.253.4.20]) by mailgate.sandia.gov (8.14.4/8.14.4) with ESMTP id oACMBDar000385; Fri, 12 Nov 2010 15:11:22 -0700 From: "Jim Schutt" To: sashak@voltaire.com cc: linux-rdma@vger.kernel.org, "Jim Schutt" Subject: [PATCH 11/13] opensm/man/opensm.8.in: Add references to torus-2QoS. Date: Fri, 12 Nov 2010 15:11:20 -0700 Message-ID: <1289599882-15165-12-git-send-email-jaschut@sandia.gov> X-Mailer: git-send-email 1.6.2.2 In-Reply-To: <1289599882-15165-1-git-send-email-jaschut@sandia.gov> References: <1289599882-15165-1-git-send-email-jaschut@sandia.gov> X-PMX-Version: 5.6.0.2009776, Antispam-Engine: 2.7.2.376379, Antispam-Data: 2010.11.12.220015 X-PMX-Spam: Gauge=IIIIIIII, Probability=8%, Report=' BODY_SIZE_3000_3999 0, BODY_SIZE_5000_LESS 0, BODY_SIZE_7000_LESS 0, DATE_TZ_NA 0, __HAS_MSGID 0, __HAS_X_MAILER 0, __LINES_OF_YELLING 0, __MIME_TEXT_ONLY 0, __SANE_MSGID 0, __TO_MALFORMED_2 0, __TO_NO_NAME 0, __URI_NO_PATH 0, __URI_NO_WWW 0, __URI_NS ' X-TMWD-Spam-Summary: TS=20101112221136; ID=1; SEV=2.3.1; DFV=B2010111222; IFV=NA; AIF=B2010111222; RPD=5.03.0010; ENG=NA; RPDID=7374723D303030312E30413031303230322E34434444424239382E303042363A534346535441543838363133332C73733D312C6667733D30; CAT=NONE; CON=NONE; SIG=AAAAAAAAAAAAAAAAAAAAAAAAfQ== X-MMS-Spam-Filter-ID: B2010111222_5.03.0010 MIME-Version: 1.0 X-WSS-ID: 60C3641E4KO2689021-01-01 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.3 (demeter1.kernel.org [140.211.167.41]); Fri, 12 Nov 2010 22:11:55 +0000 (UTC) diff --git a/opensm/man/opensm.8.in b/opensm/man/opensm.8.in index 47dff99..c021026 100644 --- a/opensm/man/opensm.8.in +++ b/opensm/man/opensm.8.in @@ -1,4 +1,4 @@ -.TH OPENSM 8 "October 22, 2009" "OpenIB" "OpenIB Management" +.TH OPENSM 8 "November 3, 2010" "OpenIB" "OpenIB Management" .SH NAME opensm \- InfiniBand subnet manager and administration (SM/SA) @@ -51,6 +51,7 @@ opensm \- InfiniBand subnet manager and administration (SM/SA) [\-\-prefix_routes_file ] [\-\-consolidate_ipv6_snm_req] [\-\-log_prefix ] +[\-\-torus_config ] [\-v(erbose)] [\-V] [\-D ] [\-d(ebug) ] [\-h(elp)] [\-?] @@ -148,8 +149,10 @@ LID assignments resolving multiple use of same LID. This option chooses routing engine(s) to use instead of Min Hop algorithm (default). Multiple routing engines can be specified separated by commas so that specific ordering of routing algorithms -will be tried if earlier routing engines fail. -Supported engines: minhop, updn, file, ftree, lash, dor +will be tried if earlier routing engines fail. If all configured +routing engines fail, OpenSM will always attempt to route with Min Hop +unless 'no_fallback' is included in the list of routing engines. +Supported engines: minhop, updn, file, ftree, lash, dor, torus-2QoS. .TP \fB\-\-do_mesh_analysis\fR This option enables additional analysis for the lash routing engine to @@ -364,6 +367,11 @@ when two or more instances of OpenSM run in a single node to manage multiple fabrics. For example, in a dual-fabric (or dual-rail) IB cluster, the prefix for the first fabric could be "mpi" and the other fabric could be "storage". .TP +\fB\-\-torus_config\fR +This option defines the file name for the extra configuration +information needed for the torus-2QoS routing engine. The default +name is \fB\%@OPENSM_CONFIG_DIR@/@TORUS2QOS_CONF_FILE@\fP +.TP \fB\-v\fR, \fB\-\-verbose\fR This option increases the log verbosity level. The -v option may be specified multiple times @@ -1004,6 +1012,14 @@ along the mesh dimension, or the -O option used as an override. Use '-R dor' option to activate the DOR algorithm. +Torus-2QoS Routing Algorithm + +Torus-2QoS is routing algorithm designed for large-scale 2D/3D torus fabrics; +see torus-2QoS(8) for full documentation. + +Use '-R torus-2QoS -Q' or '-R torus-2QoS,no_fallback -Q' +to activate the torus-2QoS algorithm. + Routing References @@ -1113,6 +1129,10 @@ default QOS policy config file .B @OPENSM_CONFIG_DIR@/@PREFIX_ROUTES_FILE@ default prefix routes file. +.TP +.B @OPENSM_CONFIG_DIR@/@TORUS2QOS_CONF_FILE@ +default torus-2QoS config file. + .SH AUTHORS .TP Hal Rosenstock @@ -1135,3 +1155,6 @@ Ira Weiny .TP Dale Purdy .RI < purdy@sgi.com > + +.SH SEE ALSO +torus-2QoS(8), torus-2QoS.conf(5).