ibdm-topo-file(1) [debian man page]

IBDM-TOPO-FILE(1)					       IB DATA MODEL PACKAGE						 IBDM-TOPO-FILE(1)

NAME

       ibdm-topo-file - 1IBDM Topology File

DESCRIPTION

       The topology file describes the IB connectivity and systems included in the network.  It serves two purposes:

       1. Support for arbitrary system names to be later used in every report that IBDM generates.
       2. Connectivity verification: The specified network topology is verified against the discovered one. Mismatch errors resulting from missing
       cables and/or wrong connections are reported by IBADM.

       The topology file is composed "system" sections. Each such section describes the connectivity of one system to other systems in the
       network. The first line of each section is a declaration of the system composed of a system-type, its system-name section, and optional
       configuration details. The lines to follow until the next empty line describe the connections between this system ports to the other
       systems. The following is a formal definition of a system section syntax.

       An example is listed afterwards.

       SYSTEM-TYPE SYSTEM-NAME [CFG: <b1>=<modifier>, [<b2>=<modifier>]...]

	       LOCAL-PORT-PANEL-NAME -> REM-SYS-TYPE REM-SYS-NAME REM-PORT-PANEL-NAME

	       LOCAL-PORT-PANEL-NAME -> REM-SYS-TYPE REM-SYS-NAME REM-PORT-PANEL-NAME

	       LOCAL-PORT-PANEL-NAME -> REM-SYS-TYPE REM-SYS-NAME REM-PORT-PANEL-NAME

	       . . .

       SYSTEM-TYPE SYSTEM-NAME [CFG: <b1>=<modifier>, [<b2>=<modifier>]...]

	       LOCAL-PORT-PANEL-NAME -> REM-SYS-TYPE REM-SYS-NAME REM-PORT-PANEL-NAME

	       LOCAL-PORT-PANEL-NAME -> REM-SYS-TYPE REM-SYS-NAME REM-PORT-PANEL-NAME

	       . . .

       . . .

       Where:

       SYSTEM-TYPE and REM-SYS-TYPE
	   Any system that has a corresponding IBNL definition. See man ibdm-ibnl-file

       SYSTEM-NAME
	   The name of the system described in this topology file section.

       LOCAL-PORT-PANEL-NAME
	   The name of the local system port. The numbers printed on the front panel are used together with Ln for Leaf no. N or Sn for Spine no.
	   N.

       REM-SYS-NAME
	   The name of the system connected to the local port.

       REM-PORT-PANEL-NAME
	   A name of the remote system port. We use the numbers as printed on the front panel and Ln for Leaf number N or Sn for Spine number N.

EXAMPLE

       The following is a topology file for a simple cluster with one 24 port switch and two HCAs. The firts HCA named H-1 and connect to the
       fabric with its two ports. The second HCA named H-2. The switch is of type MTS2400 and is named S-1

       MTS2400 S-1
	  P1 -> MT23108 H-1 P1
	  P2 -> MT23108 H-1 P2
	  P24 -> MT23108 H-2 P1

OPTIONAL CFG SECTION

       This section in the system declaration line describes the special customization of each board of the system.

       That is the CFG string is a set of comma-separated sub-fields. Each sub-field describes some special configuration of a corresponding
       system board. The actual semantics of the specific board modifiers is defined by the IBNL of the specific system.

EXAMPLE

       The following is an example of a definition-line in a topology file of the MTS9600 switch system. This switch system can have up to eight
       leafs and four spines. This example of the MTS9600 lacks (R) leafs no.6,7 and 8, and lacks spines no. 3 and 4.

       MTS9600 PartialGz1 CFG: leaf3=R,leaf5=R,leaf7=R,spine1=R

AUTHOR

       Eitan Zahavi, Mellanox Technologies LTD, eitan@mellanox.co.il

IBDM 1.0							    2009-02-16							 IBDM-TOPO-FILE(1)

IBDMCHK(1)						       IB DATA MODEL PACKAGE							IBDMCHK(1)

NAME

       IBDM - Network Checker and Attributes Analyzer

SYNOPSYS

       ibdmchk has two operation modes: design and verification.

       DESIGN:

       ibdmchk [-v][-h][-u][-r <roots file>] -t <topology file> -n <SM Node>
	 -p <SM Port> [-e] [-l <lmc>]

       VERIFICATION:

       ibdmchk [-v][-h][-r <roots file>] [-s <subnet file>] [-f <fdb file>]
	 [-m <mcfdbs file> [-l <lmc>] [-u] [-M] [-a]
	 [-c <path sl file>] [-d <sl2vl tables file>]

DESIGN MODE DESCRIPTION

       The Design mode is intended to be used before the cluster is built. It provides basic checks of the specified network as described by a
       topology file. After simulating the SM LID assignment and routing algorithms it provides reports of the (H)CA to (H)CA paths depth his-
       togram and credit deadlock potential in the resulting routing scheme.

ARGUMENTS
:
       -t|--topo <topo file>
	      The topology file specifying the network. See man ibdm-topology-file

       -n|--node <SM Node>
	      The name of the Subnet Manager node (syntax: <Topo-File-System>/U1)

       -p|--port <SM Port>
	      The port number by which the SM nodes is attached to the fabric.

OPTIONS

       -v|--verbose
	      Verbsoe mode

       -h|--help
	      Provides this help message

       -l|--lmc <lmc>
	      LMC value > 0 means assigning 2^lmc lids to each port.

       -e|--enh
	      Use enhanced routing algorithm when LMC > 0 and report the resulting paths correlation (using same system/node) histogram

       -r|--roots <roots file> A file with all the roots node names (one on each line).

VERIFICATION MODE DESCRIPTION

       After the cluster is built and OpenSM is run (using flag -D 0x43) it reports the subnet and FDB tables into the files osm-subnet.lst,
       osm.fdbs and osm.fdbs in /var/log/ (or subnet.lst, osm.fdbs and osm.mcfdbs into /var/cache/ibutils in older OpenSM versions). ibdiagnet is
       also producing the same files in its output directory.  Based on these files the utility checks all CA to CA connectivity. Further analysis
       for credit deadlock potential is performed and reported.  In case of an LMC > 0 it reports histograms for how many systems and nodes are
       common between the different paths for the same port pairs.

ARGUMENTS

       -l|--lmc <lmc>
	      The LMC value used while running OpenSM. Mandatory if not the default 0.

OPTIONS

       -v|--verbose
	      Verbsoe mode

       -h|--help
	      Provides this help message

       -s|--subnet <file>
	      OpenSM subnet.lst file (default is /var/log/osm-subnet.lst or /var/cache/ibutils/subnet.lst)

       -f|--fdb <file>
	      OpenSM dump of Ucast LFDB. Use -D 0x41 to generate it (default is /var/log/osm.fdbs or /var/cache/ibutils/osm.fdbs).

       -m|--mcfdb <file>
	      OpenSM dump of Multicast LFDB. Use -D 0x41 to generate it (default is /var/log/osm.mcfdbs or /var/cache/ibutils/osm.mcfdbs).

       -c|--psl <file>
	      Source Guid to DLID -> Path SL mapping.  Each line holds: src_node_guid dlid sl.	Used by the credit loop check to accuartly model
	      SL/VL based routing.

       -d|--slvl <file>
	      SL2VL mapping of all switces.  Each line holds: swguid iport oport 0x(sl0)(sl1) 0x(sl2)(sl3)...  Used by the credit loop check to
	      accuartly model SL/VL based routing.

       -r|--roots <roots file>
	      A file holding all root nodes guids (one per line).

       -u|--updn
	      Use Up/Down based credit loop check algorithm instead of the generic one.

       -M|--MFT
	      Include multicast routing in credit loops analysis.

       -a|--all
	      Verify not only CA-CA paths but also SW-SW, CA-SW and SW-CA.  Both check for FDB path connectivity and also for credit loops.

AUTHOR

       Eitan Zahavi, Mellanox Technologies LTD, eitan@mellanox.co.il

IBDM 1.0							    2009-03-17								IBDMCHK(1)