diff --git a/ibdiag/doc/ibdiagui.1 b/ibdiag/doc/ibdiagui.1 deleted file mode 100644 index 3aa898f..0000000 --- a/ibdiag/doc/ibdiagui.1 +++ /dev/null @@ -1,159 +0,0 @@ -.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13 -.\" -.\" 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 "IBDIAGUI 1" -.TH IBDIAGUI 1 "2006-11-17" "IBDIAG 1.0" "IB DIAGNOSTIC PACKAGE" -.SH "NAME" -\&\fBibdiagui \- IB Diagnostic GUI\fR -.SH "SYNOPSYS" -.IX Header "SYNOPSYS" -ibdiagui [\-c ] [\-v] [\-r] [\-o ] - [\-t ] [\-s ] [\-i ] [\-p ] - [\-pm] [\-pc] [\-P <\s-1PM\s0 counter>=] - [\-lw <1x|4x|12x>] [\-ls <2.5|5|10>] -.SH "DESCRIPTION" -.IX Header "DESCRIPTION" -.Vb 2 -\& ibdiagui is a GUI wrapper for ibdiagnet. -\& Its main features: -.Ve -.IP "1. Display a graph of the discovered fabric (with optional names annotattion)" 4 -.IX Item "1. Display a graph of the discovered fabric (with optional names annotattion)" -.PD 0 -.IP "2. Hyperlink the ibdiagnet log to the graph objects" 4 -.IX Item "2. Hyperlink the ibdiagnet log to the graph objects" -.IP "3. Show each object properties and object type specific actions on a properties pannel." 4 -.IX Item "3. Show each object properties and object type specific actions on a properties pannel." -.PD -.SH "OPTIONS" -.IX Header "OPTIONS" -.RE -.IP "ibdiagui simply passes its options to ibdiagnet. Please see ibdiagnet man page for the complete list." -.IX Item "ibdiagui simply passes its options to ibdiagnet. Please see ibdiagnet man page for the complete list." diff --git a/ibdm/doc/ibdm-ibnl-file.1 b/ibdm/doc/ibdm-ibnl-file.1 deleted file mode 100644 index 3f5f33a..0000000 --- a/ibdm/doc/ibdm-ibnl-file.1 +++ /dev/null @@ -1,363 +0,0 @@ -.\" 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 "IBDM-IBNL-FILE 1" -.TH IBDM-IBNL-FILE 1 "2008-06-16" "IBDM 1.0" "IB DATA MODEL PACKAGE" -.SH "NAME" -\&\fBibnl\fR \- a generic IB netlist format -.SH "DESCRIPTION" -.IX Header "DESCRIPTION" -\&\s-1IBDM\s0 topology file \fBibdm-topo-file\fR provide means to describe the \s-1IB\s0 fabric using a set of predefined systems. A system definition is provided in a single file in \s-1IBNL\s0 format that describes the internal InfiniBand connectivity of the system in terms of boards and devices. When \s-1IBDM\s0 starts it parses all the available system definition files before it handles the topology file. The files are located in the following directory relative to the installation prefix: /lib/ibdm1.0/ibnl. -.PP -This man page describes the \s-1IBNL\s0 file format used to define an arbitrary \s-1IB\s0 system internal \s-1IB\s0 connectivity. It outlines the main concepts used by the file, provides details for how to write such a file and provides a formal definition of the file syntax in \s-1BNF\s0 like format (YACC/Bison readable). -.SH "1. Main Concepts" -.IX Header "1. Main Concepts" -The described file format for defining generic system \s-1IB\s0 connectivity uses the following terminology: -.IP "\s-1NODE\s0" 4 -.IX Item "NODE" -The instantiation of an \s-1IB\s0 device may it be a switch or a channel adapter -.IP "SUB-SYSTEM" 4 -.IX Item "SUB-SYSTEM" -The instantiation of a board or module in a system -.IP "\s-1SYSTEM\s0" 4 -.IX Item "SYSTEM" -A definition of a board or a module -.IP "\s-1TOPSYSTEM\s0" 4 -.IX Item "TOPSYSTEM" -The top most system defined in the given file -.IP "SUB-SYSTEM \s-1MODIFIER\s0" 4 -.IX Item "SUB-SYSTEM MODIFIER" -Many systems allow multiple variations of their subsystem such as a 12X version of a leaf board in a \s-1MTS9600\s0. The modifier is a suffix to the board name. The \s-1IBNL\s0 format supports assigning multiple names to the same board. -.SH "2. File Format" -.IX Header "2. File Format" -The exact file format is provided in section 4. This section only provides extra information regarding the specific semantics of various sections. -.PP -The \s-1IBNL\s0 file is line sensitive as it requires different sections to start on a new line. The file is broken into several \s-1SYSTEM\s0 (optional) and one \s-1TOPSYSTEM\s0 sections. Each has one or more names. -.PP -Connections are defined inside the \s-1SYSTEM/TOPSYSTEM\s0 section only and thus might be of two types: -.IP "1. Between any node or sub-system to other node or sub-system" 4 -.IX Item "1. Between any node or sub-system to other node or sub-system" -.PD 0 -.IP "2. From any node or sub-system to a connector of the system." 4 -.IX Item "2. From any node or sub-system to a connector of the system." -.PD -.PP -\&\s-1NOTE\-1:\s0 The top system can define ports that might be redundant and not connected to any lower level board connector. In these cases the ports are simply omitted from the resulting system. This feature enables defining the front panel ports of a 12X/4X such that if a 12X leaf is selected only the 12X front panel ports are used. -.PP -\&\s-1NOTE\-2:\s0 Port width and speed provided at the lowest level have precedence over definitions provided at upper levels of the hierarchy. -.SH "3. Guidelines for writing a System IBNL File" -.IX Header "3. Guidelines for writing a System IBNL File" -The following procedure should be followed in order to provide a new system \s-1IBNL:\s0 -.IP "a)" 4 -Name the file after the system name: .ibnl -.IP "b)" 4 -Define a \s-1SYSTEM\s0 section for each board included in the system -.IP "c)" 4 -The port names of the boards are just strings, we use the simple format of Pn where N is just a serial number but you can pick any name you want. Just make sure it is unique. -.IP "d)" 4 -When different flavors of the boards exists like when you have a 4x and 12x option for a board name the optional boards with a modifier postfix. An example for such system that supports a \s-1LEAF\s0 board of 12x and 4x types would be to define two \s-1SYSTEMS:\s0 -.RS 4 -.Sp -.RS 4 -\&\s-1SYSTEM\s0 \s-1LEAF\s0,LEAF:4x,LEAF:4X -.Sp -\&... -.Sp -\&\s-1SYSTEM\s0 LEAF:12x,LEAF:12X -.Sp -\&... -.Sp -\&\s-1NOTE\-3:\s0 The instantiations of the \s-1LEAF\s0 boards in another board or the top system need not specify the postfix and are being decided upon only when the topology file is being parsed. The \*(L"\s-1SYSTEM\s0 \s-1LEAF\s0\*(R" with no postfix will be used by default. To continue the example here is how the LEAFs are instantiated in the top system: -.Sp -.RS 4 -\&\s-1TOPSYSTEM\s0 MyIbSystem -.Sp -\&\s-1LEAF\s0 leaf1 -.Sp -\&... -.Sp -\&\s-1LEAF\s0 leaf2 -.Sp -\&... -.RE -.RE -.RS 4 -.Sp -The actual 4x or 12x version of the \s-1LEAF\s0 board can then be specified in the topology file \s-1CFG\s0 section to select the right combination of optional boards in the system. An example will be: -.Sp -.RS 4 -MyIbSystem N001 \s-1CFG:\s0 leaf2=12x -.Sp -In this case leaf1 will be 4x as no special modifier is defined for it (and \s-1LEAF\s0 is by default a 4x leaf). Leaf2 will be 12x as defined in the \s-1CFG\s0 section. -.RE -.IP "e)" 4 -Special considerations should be made to design the top system section when several optional board types exist. Top system section might include multiple definitions for front panel plugs like P1\-4x and P1\-12x (yes these are just names that should follow the writing on the front or back panels). As the different flavors of the boards are not required to define the same names for their ports including a 12x port might leave some of the top level connections dangling (not connected) and thus the front panel ports of the other flavor will be removed from the final system definition. As an example let us consider a simple board \s-1LEAF\s0 with 3 4x port flavor and one 12x port flavors. We recommend connecting it in the top level using the following scheme: -.RS 4 -.Sp -.RS 4 -\&\s-1SYSTEM\s0 LEAF:4x -.Sp -\&\s-1NODE\s0 U1 -.Sp -1 \-4x\-> 4XP1 -.Sp -2 \-4x\-> 4XP2 -.Sp -3 \-4x\-> 4XP3 -.Sp -\&... -.Sp -\&\s-1SYSTEM\s0 LEAF:12x -.Sp -\&\s-1NODE\s0 U1 -.Sp -1 \-12x\-> 12XP1 -.Sp -\&... -.Sp -\&\s-1TOPSYSTEM\s0 myIbSystem -.Sp -\&\s-1SUBSYSTEM\s0 \s-1LEAF\s0 leaf1 -.Sp -4XP1 \-> L1/P1 -.Sp -4XP2 \-> L1/P2 -.Sp -4XP3 \-> L1/P3 -.Sp -12XP1 \-> L1/P1\-12x -.RE -.RE -.RS 4 -.IP "f)" 4 -Place the file in the /lib/IBDM/ibdm1.0/ibnl directory -.IP "g)" 4 -Check the new file syntax by placing it in the ibnl directory as described above, creating a simple topology (\fBibdm-topo-file\fR file with one such system and running \fBibdmtr\fR utility to parse it tracing a simple path through it. -.SH "4. Formal definition in YACC Syntax:" -.IX Header "4. Formal definition in YACC Syntax:" -\&\s-1INT\s0 ::= ([1\-9][0\-9]*|0) ; -.Sp -\&\s-1WIDTH\s0 ::= (4x|8x|12x) ; -.Sp -\&\s-1SPEED\s0 ::= (2.5G|5G|10G) ; -.Sp -\&\s-1NODETYPE\s0 ::= (SW|CA|HCA) ; -.Sp -\&\s-1NAME\s0 ::= ([\e[\e]\e\e\e*/A\-Za\-z0\-9_.:%@~]+) ; -.Sp -\&\s-1NL:\s0 -\&\s-1LINE\s0 -| \s-1NL\s0 \s-1LINE\s0; -.Sp -\&\s-1ONL:\s0 -| \s-1NL\s0; -.Sp -ibnl: \s-1ONL\s0 systems topsystem; -.Sp -systems: -| systems system ; -.Sp -sub_inst_attributes: -| sub_inst_attributes sub_inst_attribute \s-1NL\s0; -.Sp -sub_inst_attribute: -\&\s-1NAME\s0 '=' \s-1NAME\s0 '=' \s-1NAME\s0 -| \s-1NAME\s0 '=' \s-1NAME\s0 '=' \s-1INT\s0 -| \s-1NAME\s0 '=' \s-1NAME\s0 ; -.Sp -topsystem: -\&\s-1TOPSYSTEM\s0 system_names \s-1NL\s0 sub_inst_attributes insts ; -.Sp -system: -\&\s-1SYSTEM\s0 system_names \s-1NL\s0 insts ; -.Sp -system_names: -system_name -| system_names ',' system_name ; -.Sp -system_name: -\&\s-1NAME\s0 ; -.Sp -insts: -| insts node -| insts subsystem ; -.Sp -node: -node_header \s-1NL\s0 node_connections ; -.Sp -node_header: -\&\s-1NODE\s0 \s-1NODETYPE\s0 \s-1INT\s0 \s-1NAME\s0 \s-1NAME\s0 ; -.Sp -node_connections: -| node_connections node_connection \s-1NL\s0 ; -.Sp -node_connection: -node_to_node_link -| node_to_port_link ; -.Sp -node_to_node_link: -\&\s-1INT\s0 '\-' \s-1WIDTH\s0 '\-' \s-1SPEED\s0 '\-' '>' \s-1NAME\s0 -| \s-1INT\s0 '\-' \s-1WIDTH\s0 '\-' '>' \s-1NAME\s0 \s-1INT\s0 -| \s-1INT\s0 '\-' \s-1SPEED\s0 '\-' '>' \s-1NAME\s0 \s-1INT\s0 -| \s-1INT\s0 '\-' '>' \s-1NAME\s0 \s-1INT\s0 ; -.Sp -node_to_port_link: -\&\s-1INT\s0 '\-' \s-1WIDTH\s0 '\-' \s-1SPEED\s0 '\-' '>' \s-1NAME\s0 -| \s-1INT\s0 '\-' \s-1WIDTH\s0 '\-' '>' \s-1NAME\s0 -| \s-1INT\s0 '\-' \s-1SPEED\s0 '\-' '>' \s-1NAME\s0 -| \s-1INT\s0 '\-' '>' \s-1NAME\s0 ; -.Sp -subsystem: -subsystem_header \s-1NL\s0 subsystem_connections ; -.Sp -subsystem_header: -\&\s-1SUBSYSTEM\s0 \s-1NAME\s0 \s-1NAME\s0 ; -.Sp -subsystem_connections: -| subsystem_connections subsystem_connection \s-1NL\s0 ; -.Sp -subsystem_connection: -subsystem_to_subsystem_link -| subsystem_to_port_link ; -.Sp -subsystem_to_subsystem_link: -\&\s-1NAME\s0 '\-' \s-1WIDTH\s0 '\-' \s-1SPEED\s0 '\-' '>' \s-1NAME\s0 \s-1NAME\s0 -| \s-1NAME\s0 '\-' \s-1WIDTH\s0 '\-' '>' \s-1NAME\s0 \s-1NAME\s0 -| \s-1NAME\s0 '\-' \s-1SPEED\s0 '\-' '>' \s-1NAME\s0 \s-1NAME\s0 -| \s-1NAME\s0 '\-' '>' \s-1NAME\s0 \s-1NAME\s0 ; -.Sp -subsystem_to_port_link: -\&\s-1NAME\s0 '\-' \s-1WIDTH\s0 '\-' \s-1SPEED\s0 '\-' '>' \s-1NAME\s0 -| \s-1NAME\s0 '\-' \s-1WIDTH\s0 '\-' '>' \s-1NAME\s0 -| \s-1NAME\s0 '\-' \s-1SPEED\s0 '\-' '>' \s-1NAME\s0 -| \s-1NAME\s0 '\-' '>' \s-1NAME\s0 ; -.SH "AUTHOR" -.IX Header "AUTHOR" -Eitan Zahavi, Mellanox Technologies \s-1LTD\s0, eitan@mellanox.co.il diff --git a/ibdm/doc/ibdm-topo-file.1 b/ibdm/doc/ibdm-topo-file.1 deleted file mode 100644 index 4bf0300..0000000 --- a/ibdm/doc/ibdm-topo-file.1 +++ /dev/null @@ -1,219 +0,0 @@ -.\" 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 "IBDM-TOPO-FILE 1" -.TH IBDM-TOPO-FILE 1 "2008-06-16" "IBDM 1.0" "IB DATA MODEL PACKAGE" -.SH "NAME" -\&\fBIBDM Topology File\fR -.PP -The topology file describes the IB connectivity and systems included in the network. -It serves two purposes: -.IP "1. Support for arbitrary system names to be later used in every report that IBDM generates." 4 -.IX Item "1. Support for arbitrary system names to be later used in every report that IBDM generates." -.PD 0 -.IP "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." 4 -.IX Item "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." -.PD -.PP -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. -.PP -An example is listed afterwards. -.PP -SYSTEM\-TYPE SYSTEM\-NAME [CFG: =, [=]...] -.PP -.Vb 1 -\& LOCAL-PORT-PANEL-NAME -> REM-SYS-TYPE REM-SYS-NAME REM-PORT-PANEL-NAME -.Ve -.PP -.Vb 1 -\& LOCAL-PORT-PANEL-NAME -> REM-SYS-TYPE REM-SYS-NAME REM-PORT-PANEL-NAME -.Ve -.PP -.Vb 1 -\& LOCAL-PORT-PANEL-NAME -> REM-SYS-TYPE REM-SYS-NAME REM-PORT-PANEL-NAME -.Ve -.PP -.Vb 1 -\& . . . -.Ve -.PP -SYSTEM\-TYPE SYSTEM\-NAME [CFG: =, [=]...] -.PP -.Vb 1 -\& LOCAL-PORT-PANEL-NAME -> REM-SYS-TYPE REM-SYS-NAME REM-PORT-PANEL-NAME -.Ve -.PP -.Vb 1 -\& LOCAL-PORT-PANEL-NAME -> REM-SYS-TYPE REM-SYS-NAME REM-PORT-PANEL-NAME -.Ve -.PP -.Vb 1 -\& . . . -.Ve -.PP -\&. . . -.PP -Where: -.IP "\fBSYSTEM\-TYPE\fR and \fBREM\-SYS\-TYPE\fR" 4 -.IX Item "SYSTEM-TYPE and REM-SYS-TYPE" -Any system that has a corresponding IBNL definition. See man \fBibdm\-ibnl\-file\fR -.IP "\fBSYSTEM\-NAME\fR" 4 -.IX Item "SYSTEM-NAME" -The name of the system described in this topology file section. -.IP "\fBLOCAL\-PORT\-PANEL\-NAME\fR" 4 -.IX Item "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. -.IP "\fBREM\-SYS\-NAME\fR" 4 -.IX Item "REM-SYS-NAME" -The name of the system connected to the local port. -.IP "\fBREM\-PORT\-PANEL\-NAME\fR" 4 -.IX Item "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. -.SH "EXAMPLE" -.IX Header "EXAMPLE" -The following is a topology file for a simple cluster with one 24 port switch and two HCAs. The firts \s-1HCA\s0 named H\-1 and connect to the fabric with its two ports. The second \s-1HCA\s0 named H\-2. The switch is of type \s-1MTS2400\s0 and is named S\-1 -.PP -\&\s-1MTS2400\s0 S\-1 - P1 \-> \s-1MT23108\s0 H\-1 P1 - P2 \-> \s-1MT23108\s0 H\-1 P2 - P24 \-> \s-1MT23108\s0 H\-2 P1 -.SH "OPTIONAL CFG SECTION" -.IX Header "OPTIONAL CFG SECTION" -This section in the system declaration line describes the special customization of each board of the system. -.PP -That is the \s-1CFG\s0 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 \s-1IBNL\s0 of the specific system. -.SH "EXAMPLE" -.IX Header "EXAMPLE" -The following is an example of a definition-line in a topology file of the \s-1MTS9600\s0 switch system. This switch system can have up to eight leafs and four spines. This example of the \s-1MTS9600\s0 lacks (R) leafs no.6,7 and 8, and lacks spines no. 3 and 4. -.PP -\&\s-1MTS9600\s0 PartialGz1 \s-1CFG:\s0 leaf3=R,leaf5=R,leaf7=R,spine1=R -.SH "AUTHOR" -.IX Header "AUTHOR" -Eitan Zahavi, Mellanox Technologies \s-1LTD\s0, eitan@mellanox.co.il diff --git a/ibdm/doc/ibdmchk.1 b/ibdm/doc/ibdmchk.1 deleted file mode 100644 index 7537473..0000000 --- a/ibdm/doc/ibdmchk.1 +++ /dev/null @@ -1,251 +0,0 @@ -.\" 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 "IBDMCHK 1" -.TH IBDMCHK 1 "2009-03-17" "IBDM 1.0" "IB DATA MODEL PACKAGE" -.SH "NAME" -\&\fBIBDM \- Network Checker and Attributes Analyzer\fR -.SH "SYNOPSYS" -.IX Header "SYNOPSYS" -ibdmchk has two operation modes: design and verification. -.PP -\&\s-1DESIGN:\s0 -.PP -ibdmchk [\-v][\-h][\-u][\-r ] \-t \-n <\s-1SM\s0 Node> - \-p <\s-1SM\s0 Port> [\-e] [\-l ] -.PP -\&\s-1VERIFICATION:\s0 -.PP -ibdmchk [\-v][\-h][\-r ] [\-s ] [\-f ] - [\-m [\-l ] [\-u] [\-M] [\-a] - [\-c ] [\-d ] -.SH "DESIGN MODE DESCRIPTION" -.IX Header "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 \s-1SM\s0 \s-1LID\s0 assignment and routing algorithms it provides reports of the (H)CA to (H)CA paths depth histogram and credit deadlock potential in the resulting routing scheme. -.SH "ARGUMENTS:" -.IX Header "ARGUMENTS:" -.RE -.IP "\-t|\-\-topo " -.IX Item "-t|--topo " -The \fBtopology file\fR specifying the network. See man \fBibdm-topology-file\fR -.RE -.IP "\-n|\-\-node <\s-1SM\s0 Node>" -.IX Item "-n|--node " -The name of the Subnet Manager node (syntax: /U1) -.RE -.IP "\-p|\-\-port <\s-1SM\s0 Port>" -.IX Item "-p|--port " -The port number by which the \s-1SM\s0 nodes is attached to the fabric. -.SH "OPTIONS" -.IX Header "OPTIONS" -.RE -.IP "\-v|\-\-verbose" -.IX Item "-v|--verbose" -Verbsoe mode -.RE -.IP "\-h|\-\-help" -.IX Item "-h|--help" -Provides this help message -.RE -.IP "\-l|\-\-lmc " -.IX Item "-l|--lmc " -\&\s-1LMC\s0 value > 0 means assigning 2^lmc lids to each port. -.RE -.IP "\-e|\-\-enh" -.IX Item "-e|--enh" -Use enhanced routing algorithm when \s-1LMC\s0 > 0 and report the resulting paths correlation (using same system/node) histogram -.RE -.IP "\-r|\-\-roots A file with all the roots node names (one on each line)." -.IX Item "-r|--roots A file with all the roots node names (one on each line)." -.SH "VERIFICATION MODE DESCRIPTION" -.IX Header "VERIFICATION MODE DESCRIPTION" -After the cluster is built and OpenSM is run (using flag \-D 0x43) it reports the subnet and \s-1FDB\s0 tables into the files osm\-subnet.lst, osm.fdbs and osm.fdbs in /var/log/ (or subnet.lst, osm.fdbs and osm.mcfdbs into /tmp in older OpenSM versions). ibdiagnet is also producing the same files in its output directory. -Based on these files the utility checks all \s-1CA\s0 to \s-1CA\s0 connectivity. Further analysis for credit deadlock potential is performed and reported. -In case of an \s-1LMC\s0 > 0 it reports histograms for how many systems and nodes are common between the different paths for the same port pairs. -.SH "ARGUMENTS" -.IX Header "ARGUMENTS" -.RE -.IP "\-l|\-\-lmc " -.IX Item "-l|--lmc " -The \s-1LMC\s0 value used while running OpenSM. Mandatory if not the default 0. -.SH "OPTIONS" -.IX Header "OPTIONS" -.RE -.IP "\-v|\-\-verbose" -.IX Item "-v|--verbose" -Verbsoe mode -.RE -.IP "\-h|\-\-help" -.IX Item "-h|--help" -Provides this help message -.RE -.IP "\-s|\-\-subnet " -.IX Item "-s|--subnet " -OpenSM subnet.lst file (default is /var/log/osm\-subnet.lst or /tmp/subnet.lst) -.RE -.IP "\-f|\-\-fdb " -.IX Item "-f|--fdb " -OpenSM dump of Ucast \s-1LFDB\s0. Use \-D 0x41 to generate it (default is /var/log/osm.fdbs or /tmp/osm.fdbs). -.RE -.IP "\-m|\-\-mcfdb " -.IX Item "-m|--mcfdb " -OpenSM dump of Multicast \s-1LFDB\s0. Use \-D 0x41 to generate it (default is /var/log/osm.mcfdbs or /tmp/osm.mcfdbs). -.RE -.IP "\-c|\-\-psl " -.IX Item "-c|--psl " -Source Guid to \s-1DLID\s0 \-> Path \s-1SL\s0 mapping. -Each line holds: src_node_guid dlid sl. -Used by the credit loop check to accuartly model \s-1SL/VL\s0 based routing. -.RE -.IP "\-d|\-\-slvl " -.IX Item "-d|--slvl " -\&\s-1SL2VL\s0 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 \s-1SL/VL\s0 based routing. -.RE -.IP "\-r|\-\-roots " -.IX Item "-r|--roots " -A file holding all root nodes guids (one per line). -.RE -.IP "\-u|\-\-updn" -.IX Item "-u|--updn" -Use Up/Down based credit loop check algorithm instead of the generic one. -.RE -.IP "\-M|\-\-MFT" -.IX Item "-M|--MFT" -Include multicast routing in credit loops analysis. -.RE -.IP "\-a|\-\-all" -.IX Item "-a|--all" -Verify not only CA-CA paths but also \s-1SW\-SW\s0, CA-SW and \s-1SW\-CA\s0. -Both check for \s-1FDB\s0 path connectivity and also for credit loops. -.SH "AUTHOR" -.IX Header "AUTHOR" -Eitan Zahavi, Mellanox Technologies \s-1LTD\s0, eitan@mellanox.co.il diff --git a/ibdm/doc/ibdmsh.1 b/ibdm/doc/ibdmsh.1 deleted file mode 100644 index 444d8d2..0000000 --- a/ibdm/doc/ibdmsh.1 +++ /dev/null @@ -1,725 +0,0 @@ -.\" 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 "IBDMSH 1" -.TH IBDMSH 1 "2009-03-16" "IBDM 1.0" "IB DATA MODEL PACKAGE" -.SH "NAME" -\&\fBibdmsh\fR IB DATA MODEL \- Extentended TCL shell -.SH "DESCRIPTION" -.IX Header "DESCRIPTION" -\&\fBibdmsh\fR is a \s-1TCL\s0 shell extended with interface for the \s-1IB\s0 data model. -To use this shell you will write \s-1TCL\s0 code that directly access the \s-1IB\s0 data model objects and functions. -.PP -The following sub sections provide detailed definition for those objects and \s-1API\s0. -.SH "IBDM Constants" -.IX Header "IBDM Constants" -.Sh "Node Types" -.IX Subsection "Node Types" -The following constants are used by the node object type field -.Sp -.RS 4 -[ Constant : int ] \f(CW$IB_UNKNOWN_NODE_TYPE\fR = \s-1IB_UNKNOWN_NODE_TYPE\s0 -.Sp -[ Constant : int ] \f(CW$IB_SW_NODE\fR = \s-1IB_SW_NODE\s0 -.Sp -[ Constant : int ] \f(CW$IB_CA_NODE\fR = \s-1IB_CA_NODE\s0 -.RE -.Sh "Log Verbosity Flags" -.IX Subsection "Log Verbosity Flags" -The following constants are used as argument bits for the global variable \f(CW$FabricUtilsVerboseLevel\fR -.Sp -.RS 4 -[ Constant : int ] \f(CW$FABU_LOG_NONE\fR = 0x0 -.Sp -[ Constant : int ] \f(CW$FABU_LOG_ERROR\fR = 0x1 -.Sp -[ Constant : int ] \f(CW$FABU_LOG_INFO\fR = 0x2 -.Sp -[ Constant : int ] \f(CW$FABU_LOG_VERBOSE\fR = 0x4 -.RE -.SH "IBDM Globals" -.IX Header "IBDM Globals" -Log level: set to FABU_LOG* values -.Sp -.RS 4 -[ Global : int ] \f(CW$FabricUtilsVerboseLevel\fR -.RE -.SH "IBDM Objects" -.IX Header "IBDM Objects" -This section decribes the various object types exposed by \s-1IBDM\s0. -.PP -\&\s-1IBDM\s0 exposes some of its internal objects. The objects identifiers returned by the various function calls are formatted according to the following rules: -.PP -Fabric: fabric: -.PP -System: system:: -.PP -SysPort: sysport::: -.PP -Node: node:: -.PP -Port: port::/ -.PP -\&\s-1IBDM\s0 Objects are standard Swig-Tcl objects. As such they have two flavors for their usage: Variables, Objects. -.PP -\&\fBVariables/Pointers:\fR - For each object attribute a \*(L"get\*(R" and \*(L"set\*(R" methods are provided. - The format of the methods is: __. - The \*(L"set\*(R" method is only available for read/write attributes. -.PP -.Vb 4 -\& Example: -\& set nodes [ibdm_get_nodes] -\& set node [lindex $nodes 0] -\& IBNode_numPorts_get $node -.Ve -.PP -\&\fBObjects:\fR - Given an object pointer one can convert it to a Tcl \*(L"Object\*(R" - using the following command: - \-this -.PP -.Vb 2 -\& Once declared the can be used in conjunction to -\& with the standard "configure" and "cget" commands. -.Ve -.PP -.Vb 3 -\& Example (following the previous one): -\& IBFabric VaTech -this $fabric -\& VaTech cget -NodeByName -.Ve -.PP -.Vb 5 -\& To delete an object symbol (and enable its mapping to another -\& pointer) use: -\& rename "" -\& for example: -\& rename VaTech "" -.Ve -.Sh "class IBPort" -.IX Subsection "class IBPort" -The following are the different fields and methods of the \s-1IB\s0 Port class which describes an \s-1IB\s0 device (chip) physical port. -.RE -.IP "[ Member data: returns IBPort * ] \-p_remotePort" -.IX Item "[ Member data: returns IBPort * ] -p_remotePort" -Port connected on the other side of link -.RE -.IP "[ Member data: returns IBSysPort * ] \-p_sysPort" -.IX Item "[ Member data: returns IBSysPort * ] -p_sysPort" -The system port (if any) connected to -.RE -.IP "[ Member data: returns IBNode * ] \-p_node" -.IX Item "[ Member data: returns IBNode * ] -p_node" -The node the port is part of. -.RE -.IP "[ Member data: returns int ] \-num" -.IX Item "[ Member data: returns int ] -num" -Physical ports are identified by number. -.RE -.IP "[ Member data: returns unsigned int ] \-base_lid" -.IX Item "[ Member data: returns unsigned int ] -base_lid" -The base lid assigned to the port. -.RE -.IP "[ Member data: returns IBLinkWidth * ] \-width" -.IX Item "[ Member data: returns IBLinkWidth * ] -width" -The link width of the port -.RE -.IP "[ Member data: returns IBLinkSpeed * ] \-speed" -.IX Item "[ Member data: returns IBLinkSpeed * ] -speed" -The link speed of the port -.RE -.IP "[ Member data: returns unsigned int ] \-counter1" -.IX Item "[ Member data: returns unsigned int ] -counter1" -A generic value to be used by various algorithms -.RE -.IP "[ Constructor: returns IBPort * ] IBPort name p_nodePtr number" -.IX Item "[ Constructor: returns IBPort * ] IBPort name p_nodePtr number" -IBPort constructor -.RE -.IP "[ Member : returns new_uint64_t ] guid_get" -.IX Item "[ Member : returns new_uint64_t ] guid_get" -Obtain the guid of the port -.RE -.IP "[ Member : returns void ] guid_set guid" -.IX Item "[ Member : returns void ] guid_set guid" -Modify the guid of the port -.RE -.IP "[ Member : returns new_string ] getName" -.IX Item "[ Member : returns new_string ] getName" -Get the port name: A device port connected to system port (front pannel) returns the front pannel port name. -.RE -.IP "[ Member : returns void ] connect p_otherPort ?width? ?speed?" -.IX Item "[ Member : returns void ] connect p_otherPort ?width? ?speed?" -Connect the port to another node port with optional width and speed parameters -.RE -.IP "[ Member : returns int ] disconnect" -.IX Item "[ Member : returns int ] disconnect" -Disconnect the port. Return 0 if successful -.Sh "class IBNode" -.IX Subsection "class IBNode" -The \s-1IB\s0 Node class represents a single \s-1IB\s0 Device (chip) -.RE -.IP "[ Member data: returns string * ] \-name" -.IX Item "[ Member data: returns string * ] -name" -Name of the node (instance name of the chip) -.RE -.IP "[ Member data: returns IBNodeType ] \-type" -.IX Item "[ Member data: returns IBNodeType ] -type" -Either a \f(CW$IB_SW_NODE\fR or \f(CW$IB_CA_NODE\fR -.RE -.IP "[ Member data: returns uint16_t * ] \-devId" -.IX Item "[ Member data: returns uint16_t * ] -devId" -The device \s-1ID\s0 of the node -.RE -.IP "[ Member data: returns uint16_t * ] \-revId" -.IX Item "[ Member data: returns uint16_t * ] -revId" -The device revision Id. -.RE -.IP "[ Member data: returns uint16_t * ] \-vendId" -.IX Item "[ Member data: returns uint16_t * ] -vendId" -The device Vendor \s-1ID\s0. -.RE -.IP "[ Member data: returns string * ] \-attributes" -.IX Item "[ Member data: returns string * ] -attributes" -Comma-sep string of arbitrary attributes k=v -.RE -.IP "[ Member data: returns uint8_t ] \-rank" -.IX Item "[ Member data: returns uint8_t ] -rank" -The rank of the node (0 is a root) -.RE -.IP "[ Member data: returns IBSystem * ] \-p_system" -.IX Item "[ Member data: returns IBSystem * ] -p_system" -What system we belong to -.RE -.IP "[ Member data: returns IBFabric * ] \-p_fabric" -.IX Item "[ Member data: returns IBFabric * ] -p_fabric" -What fabric we belong to. -.RE -.IP "[ Member data: returns unsigned int ] \-numPorts" -.IX Item "[ Member data: returns unsigned int ] -numPorts" -Number of physical ports -.RE -.IP "[ Member data: returns vec_pport * ] \-Ports" -.IX Item "[ Member data: returns vec_pport * ] -Ports" -Vector of all the ports -.RE -.IP "[ Member data: returns vec_vec_byte * ] \-MinHopsTable" -.IX Item "[ Member data: returns vec_vec_byte * ] -MinHopsTable" -A table of the number of hops required to get from each port to each target \s-1LID\s0 -.RE -.IP "[ Member data: returns vec_byte * ] \-LFT" -.IX Item "[ Member data: returns vec_byte * ] -LFT" -The \s-1LFT\s0 of this node (for switches only) which is a long vector of target ports \- index is the \s-1LID\s0 -.RE -.IP "[ Member : returns new_uint64_t ] guid_get" -.IX Item "[ Member : returns new_uint64_t ] guid_get" -Obtain the node \s-1GUID\s0 -.RE -.IP "[ Member : returns void ] guid_set guid" -.IX Item "[ Member : returns void ] guid_set guid" -Set the node \s-1GUID\s0 -.RE -.IP "[ Constructor: returns IBNode * ] IBNode name n p_fab p_sys t np" -.IX Item "[ Constructor: returns IBNode * ] IBNode name n p_fab p_sys t np" -Constractor -.RE -.IP "[ Member : returns IBPort * ] makePort num" -.IX Item "[ Member : returns IBPort * ] makePort num" -Create a new port by its number (if required) return the port pointer -.RE -.IP "[ Member : returns IBPort * ] getPort num" -.IX Item "[ Member : returns IBPort * ] getPort num" -Get a port by number num = 1..N: -.RE -.IP "[ Member : returns void ] setHops p_port lid hops" -.IX Item "[ Member : returns void ] setHops p_port lid hops" -Set the min hop for the given port (* is all) lid pair -.RE -.IP "[ Member : returns int ] getHops p_port lid" -.IX Item "[ Member : returns int ] getHops p_port lid" -Get the min number of hops defined for the given port or all -.RE -.IP "[ Member : returns IBPort * ] getFirstMinHopPort lid" -.IX Item "[ Member : returns IBPort * ] getFirstMinHopPort lid" -Scan the node ports and find the first port with min hop to the lid -.RE -.IP "[ Member : returns void ] setLFTPortForLid lid portNum" -.IX Item "[ Member : returns void ] setLFTPortForLid lid portNum" -Set the Linear Forwarding Table for the given \s-1LID\s0 -.RE -.IP "[ Member : returns int ] getLFTPortForLid lid" -.IX Item "[ Member : returns int ] getLFTPortForLid lid" -Get the \s-1LFT\s0 for a given \s-1LID\s0 -.RE -.IP "[ Member : returns void ] repHopTable" -.IX Item "[ Member : returns void ] repHopTable" -Dump out the min hop table of the node -.Sh "class IBSysPort" -.IX Subsection "class IBSysPort" -The IBSysPort class represents an \s-1IB\s0 plug on the system front or back pannels -.RE -.IP "[ Member data: returns string * ] \-name" -.IX Item "[ Member data: returns string * ] -name" -The front pannel name (silk) of the port -.RE -.IP "[ Member data: returns IBSysPort * ] \-p_remoteSysPort" -.IX Item "[ Member data: returns IBSysPort * ] -p_remoteSysPort" -If connected the other side sys port -.RE -.IP "[ Member data: returns IBSystem * ] \-p_system" -.IX Item "[ Member data: returns IBSystem * ] -p_system" -System it benongs to -.RE -.IP "[ Member data: returns IBPort * ] \-p_nodePort" -.IX Item "[ Member data: returns IBPort * ] -p_nodePort" -The node port it connects to. -.RE -.IP "[ Constructor: returns IBSysPort * ] IBSysPort name n p_sys" -.IX Item "[ Constructor: returns IBSysPort * ] IBSysPort name n p_sys" -Constructor -.RE -.IP "[ Member : returns void ] connect p_otherSysPort ?width? ?speed?" -.IX Item "[ Member : returns void ] connect p_otherSysPort ?width? ?speed?" -Connect two SysPorts -.RE -.IP "[ Member : returns int ] disconnect" -.IX Item "[ Member : returns int ] disconnect" -Disconnect the SysPort (and ports). Return 0 if successful -.Sh "class IBSystem" -.IX Subsection "class IBSystem" -The IBSystem class represents an entire chassis -.RE -.IP "[ Member data: returns string * ] \-name" -.IX Item "[ Member data: returns string * ] -name" -The \*(L"host\*(R" name of the system -.RE -.IP "[ Member data: returns string * ] \-type" -.IX Item "[ Member data: returns string * ] -type" -What is the type i.e. Cougar, Buffalo, \s-1MTS2400\s0, etc. A corresponding \s-1IBNL\s0 file should exist \- defining this system type -.RE -.IP "[ Member data: returns IBFabric * ] \-p_fabric" -.IX Item "[ Member data: returns IBFabric * ] -p_fabric" -Fabric the system belongs to -.RE -.IP "[ Member data: returns map_str_pnode * ] \-NodeByName" -.IX Item "[ Member data: returns map_str_pnode * ] -NodeByName" -Provide the node pointer by its name -.RE -.IP "[ Member data: returns map_str_psysport * ] \-PortByName" -.IX Item "[ Member data: returns map_str_psysport * ] -PortByName" -A map provising pointer to the SysPort by name -.RE -.IP "[ Constructor: returns IBSystem * ] IBSystem name n p_fab t" -.IX Item "[ Constructor: returns IBSystem * ] IBSystem name n p_fab t" -Constractor -.RE -.IP "[ Member : returns new_uint64_t ] guid_get" -.IX Item "[ Member : returns new_uint64_t ] guid_get" -Obtain the system image \s-1GUID\s0 -.RE -.IP "[ Member : returns void ] guid_set guid" -.IX Item "[ Member : returns void ] guid_set guid" -Set the system image \s-1GUID\s0 -.RE -.IP "[ Member : returns IBSysPort * ] makeSysPort pName" -.IX Item "[ Member : returns IBSysPort * ] makeSysPort pName" -Make sure we got the port defined (so define it if not) -.RE -.IP "[ Member : returns IBPort * ] getSysPortNodePortByName sysPortName" -.IX Item "[ Member : returns IBPort * ] getSysPortNodePortByName sysPortName" -Get the node port for the given sys port by name -.RE -.IP "[ Member : returns IBSysPort * ] getSysPort name" -.IX Item "[ Member : returns IBSysPort * ] getSysPort name" -Get a Sys Port by name -.Sh "class IBFabric" -.IX Subsection "class IBFabric" -Represents an entire \s-1IB\s0 subnet made of systems -.RE -.IP "[ Member data: returns map_str_pnode * ] \-NodeByName" -.IX Item "[ Member data: returns map_str_pnode * ] -NodeByName" -Provide a list of node name and pointer pairs -.RE -.IP "[ Member data: returns map_str_psys * ] \-SystemByName" -.IX Item "[ Member data: returns map_str_psys * ] -SystemByName" -Provide a list of system name and pointer pairs -.RE -.IP "[ Member data: returns vec_pport * ] \-PortByLid" -.IX Item "[ Member data: returns vec_pport * ] -PortByLid" -Provides a list of system port name and pointer pairs -.RE -.IP "[ Member data: returns map_guid_pnode * ] \-NodeByGuid" -.IX Item "[ Member data: returns map_guid_pnode * ] -NodeByGuid" -Provides a list of node guid and node pointer pairs -.RE -.IP "[ Member data: returns map_guid_psys * ] \-SystemByGuid" -.IX Item "[ Member data: returns map_guid_psys * ] -SystemByGuid" -Provides a list of system image guid and system pointer pairs -.RE -.IP "[ Member data: returns map_guid_pport * ] \-PortByGuid" -.IX Item "[ Member data: returns map_guid_pport * ] -PortByGuid" -Provides a list of port guid and port pointer pairs -.RE -.IP "[ Member data: returns unsigned int ] \-minLid" -.IX Item "[ Member data: returns unsigned int ] -minLid" -Track min lid used. -.RE -.IP "[ Member data: returns unsigned int ] \-maxLid" -.IX Item "[ Member data: returns unsigned int ] -maxLid" -Track max lid used. -.RE -.IP "[ Member data: returns unsigned int ] \-lmc" -.IX Item "[ Member data: returns unsigned int ] -lmc" -\&\s-1LMC\s0 value used -.RE -.IP "[ Member : returns IBNode * ] makeNode n p_sys type numPorts" -.IX Item "[ Member : returns IBNode * ] makeNode n p_sys type numPorts" -Get the node by its name (create one of does not exist) -.RE -.IP "[ Member : returns IBNode * ] getNode name" -.IX Item "[ Member : returns IBNode * ] getNode name" -Get the node by its name -.RE -.IP "[ Member : returns list_pnode * ] getNodesByType type" -.IX Item "[ Member : returns list_pnode * ] getNodesByType type" -Return the list of node pointers matching the required type -.RE -.IP "[ Member : returns IBSystem * ] makeGenericSystem name" -.IX Item "[ Member : returns IBSystem * ] makeGenericSystem name" -Create a new generic system \- basically an empty container for nodes... -.RE -.IP "[ Member : returns IBSystem * ] makeSystem name type" -.IX Item "[ Member : returns IBSystem * ] makeSystem name type" -Create a new system \- the type must have a registed factory. -.RE -.IP "[ Member : returns IBSystem * ] getSystem name" -.IX Item "[ Member : returns IBSystem * ] getSystem name" -Get system by name -.RE -.IP "[ Member : returns IBSystem * ] getSystemByGuid guid" -.IX Item "[ Member : returns IBSystem * ] getSystemByGuid guid" -get the system by its guid -.RE -.IP "[ Member : returns IBNode * ] getNodeByGuid guid" -.IX Item "[ Member : returns IBNode * ] getNodeByGuid guid" -get the node by its guid -.RE -.IP "[ Member : returns IBPort * ] getPortByGuid guid" -.IX Item "[ Member : returns IBPort * ] getPortByGuid guid" -get the port by its guid -.RE -.IP "[ Member : returns void ] addCable t1 n1 p1 t2 n2 p2 ?width? ?speed?" -.IX Item "[ Member : returns void ] addCable t1 n1 p1 t2 n2 p2 ?width? ?speed?" -Adds a cable given two sets of node type, node name and port number. Optionally use a given width and speed for the connection -.RE -.IP "[ Member : returns int ] parseCables fn" -.IX Item "[ Member : returns int ] parseCables fn" -Parse the cables file and build the fabric -.RE -.IP "[ Member : returns int ] parseTopology fn" -.IX Item "[ Member : returns int ] parseTopology fn" -Parse Topology File and build the fabric -.RE -.IP "[ Member : returns int ] addLink type1 numPorts1 sysGuid1 nodeGuid1 portGuid1 vend1 devId1 rev1 desc1 lid1 portNum1 type2 numPorts2 sysGuid2 nodeGuid2 portGuid2 vend2 devId2 rev2 desc2 lid2 portNum2 ?width? ?speed?" -.IX Item "[ Member : returns int ] addLink type1 numPorts1 sysGuid1 nodeGuid1 portGuid1 vend1 devId1 rev1 desc1 lid1 portNum1 type2 numPorts2 sysGuid2 nodeGuid2 portGuid2 vend2 devId2 rev2 desc2 lid2 portNum2 ?width? ?speed?" -Add a link into the fabric \- this will create system and nodes as required. -.RE -.IP "[ Member : returns int ] parseSubnetLinks fn" -.IX Item "[ Member : returns int ] parseSubnetLinks fn" -Parse the OpenSM subnet.lst file and build the fabric from it. -.RE -.IP "[ Member : returns int ] parseFdbFile fn" -.IX Item "[ Member : returns int ] parseFdbFile fn" -Parse OpenSM \s-1FDB\s0 dump file and fill in the switches \s-1LFT\s0 tables -.RE -.IP "[ Member : returns int ] parseMCFdbFile fn" -.IX Item "[ Member : returns int ] parseMCFdbFile fn" -Parse an OpenSM MCFDBs file and set the \s-1MFT\s0 table accordingly -.RE -.IP "[ Member : returns int ] parsePSLFile fn" -.IX Item "[ Member : returns int ] parsePSLFile fn" -Parse Path to \s-1SL\s0 mapping file. Each line with: -src_node_guid \s-1DLID\s0 \s-1SL\s0 -.PP -Used by credit loop check -.RE -.IP "[ Member : returns int ] parseSLVLFile fn" -.IX Item "[ Member : returns int ] parseSLVLFile fn" -Parse \s-1SLVL\s0 tables file. Each line holds: -sw_node_guid in_port out_port 0x(sl0)(sl1) 0x(sl2)(sl3)... -.RE -.IP "[ Member : returns void ] setLidPort lid p_port" -.IX Item "[ Member : returns void ] setLidPort lid p_port" -Set a lid port -.RE -.IP "[ Member : returns IBPort * ] getPortByLid lid" -.IX Item "[ Member : returns IBPort * ] getPortByLid lid" -Get a port by lid -.RE -.IP "[ returns IBFabric * ] new_IBFabric" -.IX Item "[ returns IBFabric * ] new_IBFabric" -Construct a new fabric -.RE -.IP "[ returns void ] delete_IBFabric p_fabric" -.IX Item "[ returns void ] delete_IBFabric p_fabric" -Destruct a fabric -.SH "IBDM Functions" -.IX Header "IBDM Functions" -This section provide the details about the functions \s-1IBDM\s0 exposes. -The order follows the expected order in a regular \s-1IBDM\s0 flow. -They all return 0 on succes. -.Sh "Subnet Utilities" -.IX Subsection "Subnet Utilities" -The file holds a set of utilities to be run on the subnet to mimic OpenSM initialization and analyze the results: -.RE -.IP "[ returns int ] ibdmAssignLids p_smNodePort ?lmc?" -.IX Item "[ returns int ] ibdmAssignLids p_smNodePort ?lmc?" -Assign LIDs with an optional \s-1LMC\s0 (multiple \s-1LID\s0 per port) -.RE -.IP "[ returns int ] ibdmCalcMinHopTables p_fabric" -.IX Item "[ returns int ] ibdmCalcMinHopTables p_fabric" -Calculate and populate the MinHopTables required for running OpenSM style routing. -.RE -.IP "[ returns int ] ibdmCalcUpDnMinHopTbls p_fabric rootNodesNameRex" -.IX Item "[ returns int ] ibdmCalcUpDnMinHopTbls p_fabric rootNodesNameRex" -Calculate and populate the MinHopTables following Up/Down rule. -.RE -.IP "[ returns int ] ibdmOsmRoute p_fabric" -.IX Item "[ returns int ] ibdmOsmRoute p_fabric" -Route the fabric with OpenSM style routing -.RE -.IP "[ returns int ] ibdmEnhancedRoute p_fabric" -.IX Item "[ returns int ] ibdmEnhancedRoute p_fabric" -Route the fabric with OpenSM style routing enhanced with better support for \s-1LMC\s0 > 0 -.RE -.IP "[ returns int ] ibdmFatTreeRoute p_fabric rootNodes" -.IX Item "[ returns int ] ibdmFatTreeRoute p_fabric rootNodes" -Route the fabric using algorithm that fits only full fat trees -.RE -.IP "[ returns int ] ibdmFatTreeAnalysis p_fabric" -.IX Item "[ returns int ] ibdmFatTreeAnalysis p_fabric" -Analyze the fabric to see if it is a fat tree and route it if it is -.RE -.IP "[ returns int ] ibdmVerifyCAtoCARoutes p_fabric" -.IX Item "[ returns int ] ibdmVerifyCAtoCARoutes p_fabric" -Make sure all (H)CAs are connected to each other based on the \s-1LFT\s0 settings -.RE -.IP "[ returns int ] ibdmVerifyAllPaths p_fabric" -.IX Item "[ returns int ] ibdmVerifyAllPaths p_fabric" -Make sure all Switches and (H)CAs are connected to each other based on the \s-1LFT\s0 settings -.RE -.IP "[ returns int ] ibdmAnalyzeLoops p_fabric" -.IX Item "[ returns int ] ibdmAnalyzeLoops p_fabric" -A rigorous check for credit loops. This algorithm does a full and accurate check but its reporting of credit loop paths is hard to interpret. If you know the roots of the tree (or the tree is symmetrical) it is preferable to use the ibdmReportNonUpDownCa2CaPaths -.RE -.IP "[ returns list_pnode ] ibdmFindSymmetricalTreeRoots p_fabric" -.IX Item "[ returns list_pnode ] ibdmFindSymmetricalTreeRoots p_fabric" -Analyze the tree topology and find the roots of the tree based on its symmetry -.RE -.IP "[ returns list_pnode ] ibdmFindRootNodesByMinHop p_fabric" -.IX Item "[ returns list_pnode ] ibdmFindRootNodesByMinHop p_fabric" -Based on the MinHopTable find the roots of the tree. A 5% assymetry is allowed -.RE -.IP "[ returns int ] ibdmRankFabricByRoots p_fabric rootNodes" -.IX Item "[ returns int ] ibdmRankFabricByRoots p_fabric rootNodes" -Given the list of root nodes (names) rank the nodes (root = 0) -.RE -.IP "[ returns int ] ibdmReportNonUpDownCa2CaPaths p_fabric rootNodes" -.IX Item "[ returns int ] ibdmReportNonUpDownCa2CaPaths p_fabric rootNodes" -Analyze the routes to make sure Up/Down rule is maintained -.RE -.IP "[ returns int ] ibdmCheckMulticastGroups p_fabric" -.IX Item "[ returns int ] ibdmCheckMulticastGroups p_fabric" -Verify connectivity of multicast routing -.RE -.IP "[ returns int ] ibdmCheckFabricMCGrpsForCreditLoopPotential p_fabric rootNodes" -.IX Item "[ returns int ] ibdmCheckFabricMCGrpsForCreditLoopPotential p_fabric rootNodes" -Analyze multicast routing to make sure it obeys Up/Down rule -.RE -.IP "[ returns int ] ibdmLinkCoverageAnalysis p_fabric rootNodes" -.IX Item "[ returns int ] ibdmLinkCoverageAnalysis p_fabric rootNodes" -Prepare a schedule for transmission from a set of sources to destinations such that in each stage there are no links that are over subscribed and after all stages all the links of the fabric were excersized -.Sh "Tracing Utilities" -.IX Subsection "Tracing Utilities" -These functions allows tracing paths reporting back the visited nodes -.RE -.IP "[ returns int ] ibdmTraceDRPathRoute p_smNodePort drPathPortNums" -.IX Item "[ returns int ] ibdmTraceDRPathRoute p_smNodePort drPathPortNums" -Trace a directed route path from the given port -.RE -.IP "[ returns int ] ibdmTraceRouteByMinHops p_fabric slid dlid" -.IX Item "[ returns int ] ibdmTraceRouteByMinHops p_fabric slid dlid" -Trace a path along the MinHop from the source to destination LIDs -.RE -.IP "[ returns int ] ibdmTraceRouteByLFT p_fabric slid dlid hops p_nodesList" -.IX Item "[ returns int ] ibdmTraceRouteByLFT p_fabric slid dlid hops p_nodesList" -Trace a path following the \s-1LFT\s0 updating the hops and node list variables -.Sh "Topology Matching Utilities" -.IX Subsection "Topology Matching Utilities" -The following utilities matches two fabrics providing both missmatch messages and a unified fabric -.RE -.IP "[ returns int ] ibdmMatchFabrics p_spec_fabric p_discovered_fabric anchorNodeName anchorPortNum anchorPortGuid" -.IX Item "[ returns int ] ibdmMatchFabrics p_spec_fabric p_discovered_fabric anchorNodeName anchorPortNum anchorPortGuid" -Match a topology based fabric with a discovered one starting at the enchor port -.RE -.IP "[ returns int ] ibdmBuildMergedFabric p_spec_fabric p_discovered_fabric p_merged_fabric" -.IX Item "[ returns int ] ibdmBuildMergedFabric p_spec_fabric p_discovered_fabric p_merged_fabric" -After matching using ibdmMatchFabrics populate the \*(L"merged fabric\*(R" with information merged for the matched nodes -.Sh "Congestion Analysis Utilities" -.IX Subsection "Congestion Analysis Utilities" -Provide ability to track and report link oversubscription -.RE -.IP "[ returns int ] ibdmCongInit p_fabric" -.IX Item "[ returns int ] ibdmCongInit p_fabric" -Initialize the tracking system -.RE -.IP "[ returns int ] ibdmCongCleanup p_fabric" -.IX Item "[ returns int ] ibdmCongCleanup p_fabric" -Cleanup the counters and deallocate -.RE -.IP "[ returns int ] ibdmCongClear p_fabric" -.IX Item "[ returns int ] ibdmCongClear p_fabric" -Cleanup counters -.RE -.IP "[ returns int ] ibdmCongTrace p_fabric srcLid dstLid" -.IX Item "[ returns int ] ibdmCongTrace p_fabric srcLid dstLid" -Trace a path between the LIDs updating link usage info -.RE -.IP "[ returns int ] ibdmCongReport p_fabric" -.IX Item "[ returns int ] ibdmCongReport p_fabric" -Report the resulting congestion information -.RE -.IP "[ returns int ] ibdmCongDump p_fabric" -.IX Item "[ returns int ] ibdmCongDump p_fabric" -Dump all congestion tracking info -.SH "AUTHOR" -.IX Header "AUTHOR" -Eitan Zahavi, Mellanox Technologies \s-1LTD\s0, eitan@mellanox.co.il diff --git a/ibdm/doc/ibdmtr.1 b/ibdm/doc/ibdmtr.1 deleted file mode 100644 index 9442c4a..0000000 --- a/ibdm/doc/ibdmtr.1 +++ /dev/null @@ -1,211 +0,0 @@ -.\" 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 "IBDMTR 1" -.TH IBDMTR 1 "2008-06-16" "IBDM 1.0" "IB DATA MODEL PACKAGE" -.SH "NAME" -\&\fBibdmtr\fR \- Fabric Trace Route -.SH "SYNOPSYS" -.IX Header "SYNOPSYS" -ibdmtr [\-v][\-h] {\-c |\-t } \-s - \-p \-d -.SH "DESCRIPTION" -.IX Header "DESCRIPTION" -This utility parses a cabling list or topology file describing the systems connections that make a fabric. Then it start following the direct route provided and print out the systems and nodes on the route. -.SH "ARGUMENTS Required arguments description." -.IX Header "ARGUMENTS Required arguments description." -.IP "\-t|\-\-topology " 4 -.IX Item "-t|--topology " -.RS 4 -.PD 0 -.IP "Topology file describing the network. See man ibdm\-topology\-file." 4 -.IX Item "Topology file describing the network. See man ibdm-topology-file." -.RE -.RS 4 -.RE -.IP "\-c|\-\-cables " 4 -.IX Item "-c|--cables " -.RS 4 -.IP "Cabling list file. Following the line format:" 4 -.IX Item "Cabling list file. Following the line format:" -.RE -.RS 4 -.PD -.Sp - -.RE -.IP "\-s|\-\-sm\-node " 4 -.IX Item "-s|--sm-node " -.RS 4 -.PD 0 -.IP "The name of the \s-1SM\s0 node (not system). E.g. \s-1OSM/U1\s0." 4 -.IX Item "The name of the SM node (not system). E.g. OSM/U1." -.RE -.RS 4 -.RE -.IP "\-p|\-\-port\-num " 4 -.IX Item "-p|--port-num " -.RS 4 -.IP "The number of the \s-1SM\s0 node port the \s-1SM\s0 is attached to" 4 -.IX Item "The number of the SM node port the SM is attached to" -.RE -.RS 4 -.RE -.IP "\-d|\-\-dr\-path " 4 -.IX Item "-d|--dr-path " -.RS 4 -.IP "A list of ports to go out through" 4 -.IX Item "A list of ports to go out through" -.RE -.RS 4 -.PD -.SH "OPTIONS" -.IX Header "OPTIONS" -.RE -.IP "\-v|\-\-verbose" 4 -.IX Item "-v|--verbose" -.RS 4 -.PD 0 -.IP "verbsoe mode" 4 -.IX Item "verbsoe mode" -.RE -.RS 4 -.RE -.IP "\-h|\-\-help" 4 -.IX Item "-h|--help" -.RS 4 -.IP "provide this help message" 4 -.IX Item "provide this help message" -.RE -.RS 4 -.PD -.SH "AUTHOR" -.IX Header "AUTHOR" -Eitan Zahavi, Mellanox Technologies \s-1LTD\s0, eitan@mellanox.co.il diff --git a/ibdm/doc/ibtopodiff.1 b/ibdm/doc/ibtopodiff.1 deleted file mode 100644 index cef1579..0000000 --- a/ibdm/doc/ibtopodiff.1 +++ /dev/null @@ -1,176 +0,0 @@ -.\" 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 "IBTOPODIFF 1" -.TH IBTOPODIFF 1 "2008-06-16" "IBDM 1.0" "IB DATA MODEL PACKAGE" -.SH "NAME" -\&\fBibtoopdiff \- Fabric Topology Matcher\fR -.SH "SYNOPSYS" -.IX Header "SYNOPSYS" -ibtopodiff [\-v][\-h] \-t \-d \-s - \-p \-g -.SH "DESCRIPTION" -.IX Header "DESCRIPTION" -This utility performs matching between a given topology file (see man \fBibdm-topology-file\fR) and a \fBsubnet.lst file\fR (this file provides a dump of all links in the discovered fabric and generated by ibdiagnet or OpenSM). -.SH "ARGUMENTS" -.IX Header "ARGUMENTS" -.RE -.IP "\-t|\-\-topology " -.IX Item "-t|--topology " -Topology file. See man \fBibdm-topology-file\fR for its definition. -.RE -.IP "\-d|\-\-discovered " -.IX Item "-d|--discovered " -subnet.lst file produced by \fBOpenSM\fR or \fBibdiagnet\fR -.RE -.IP "\-s|\-\-start\-node " -.IX Item "-s|--start-node " -The name of the matching start node, also known as anchor node. E.g. H\-1/U1 -.RE -.IP "\-p|\-\-port\-num " -.IX Item "-p|--port-num " -The number of the matching start port, also known as anchor port -.RE -.IP "\-g|\-\-port\-guid " -.IX Item "-g|--port-guid " -The guid of the matching start port -.SH "OPTIONS" -.IX Header "OPTIONS" -.RE -.IP "\-v|\-\-verbose" -.IX Item "-v|--verbose" -Verbsoe mode -.RE -.IP "\-h|\-\-help" -.IX Item "-h|--help" -Provides this help message -.SH "AUTHOR" -.IX Header "AUTHOR" -Eitan Zahavi, Mellanox Technologies \s-1LTD\s0, eitan@mellanox.co.il diff --git a/ibis/doc/ibis.1 b/ibis/doc/ibis.1 deleted file mode 100644 index f80e425..0000000 --- a/ibis/doc/ibis.1 +++ /dev/null @@ -1,2254 +0,0 @@ -.\" 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 "IBIS 1" -.TH IBIS 1 "2008-06-16" "IBIS 1.0" "IB MANAGEMENT IN-BAND SERVICES PACKAGE" -.SH "NAME" -\&\fBibis\fR \- IB management Inband Services \- an extended TCL shell -.SH "SYNOPSYS" -.IX Header "SYNOPSYS" -ibis [\-port_num ] -.SH "DESCRIPTION" -.IX Header "DESCRIPTION" -\&\fBibis\fR is a \s-1TCL\s0 shell extended with interface for sending and receiving \s-1IB\s0 management datagrams (\s-1MADS\s0). -To use this shell you will write \s-1TCL\s0 code that excersizes the regular \s-1TCL\s0 command and the special \s-1API\s0 provided by this extension. Interactive use is also possible and is greatly enhanced if tclreadline package is available on the machine. -.PP -The following sub sections provide detailed definition for the \s-1API\s0 and global objects defined by the extension. The different MADs APIs are group by the management class. -.SH "IBIS Constants" -.IX Header "IBIS Constants" -These constants are provided by \s-1IBIS:\s0 -.Sh "Log Verbosity Flags" -.IX Subsection "Log Verbosity Flags" -.ie n .IP "[ Constant : int ] $IBIS_LOG_NONE = 0x00" 4 -.el .IP "[ Constant : int ] \f(CW$IBIS_LOG_NONE\fR = 0x00" 4 -.IX Item "[ Constant : int ] $IBIS_LOG_NONE = 0x00" -.PD 0 -.ie n .IP "[ Constant : int ] $IBIS_LOG_ERROR = 0x01" 4 -.el .IP "[ Constant : int ] \f(CW$IBIS_LOG_ERROR\fR = 0x01" 4 -.IX Item "[ Constant : int ] $IBIS_LOG_ERROR = 0x01" -.ie n .IP "[ Constant : int ] $IBIS_LOG_INFO = 0x02" 4 -.el .IP "[ Constant : int ] \f(CW$IBIS_LOG_INFO\fR = 0x02" 4 -.IX Item "[ Constant : int ] $IBIS_LOG_INFO = 0x02" -.ie n .IP "[ Constant : int ] $IBIS_LOG_VERBOSE = 0x04" 4 -.el .IP "[ Constant : int ] \f(CW$IBIS_LOG_VERBOSE\fR = 0x04" 4 -.IX Item "[ Constant : int ] $IBIS_LOG_VERBOSE = 0x04" -.ie n .IP "[ Constant : int ] $IBIS_LOG_DEBUG = 0x08" 4 -.el .IP "[ Constant : int ] \f(CW$IBIS_LOG_DEBUG\fR = 0x08" 4 -.IX Item "[ Constant : int ] $IBIS_LOG_DEBUG = 0x08" -.ie n .IP "[ Constant : int ] $IBIS_LOG_FUNCS = 0x10" 4 -.el .IP "[ Constant : int ] \f(CW$IBIS_LOG_FUNCS\fR = 0x10" 4 -.IX Item "[ Constant : int ] $IBIS_LOG_FUNCS = 0x10" -.ie n .IP "[ Constant : int ] $IBIS_LOG_FRAMES = 0x20" 4 -.el .IP "[ Constant : int ] \f(CW$IBIS_LOG_FRAMES\fR = 0x20" 4 -.IX Item "[ Constant : int ] $IBIS_LOG_FRAMES = 0x20" -.PD -.SH "IBIS Functions" -.IX Header "IBIS Functions" -This section provide the details about the functions \s-1IBIS\s0 exposes. -They all return 0 on succes. -.IP "[return list] ibis_get_local_ports_info" 4 -.IX Item "[return list] ibis_get_local_ports_info" -Return the list of available \s-1IB\s0 ports with \s-1GUID\s0, \s-1LID\s0, state and port number. -.IP "[ returns int ] ibis_init" 4 -.IX Item "[ returns int ] ibis_init" -Initialize ibis object -.IP "[ returns int ] ibis_set_verbosity level" 4 -.IX Item "[ returns int ] ibis_set_verbosity level" -Change the log verbosity -.IP "[ returns int ] ibis_set_port guid" 4 -.IX Item "[ returns int ] ibis_set_port guid" -Set the port \s-1IBIS\s0 is attached to and initialize all sub packages. -Must be called once during ibis operation. -.IP "[ returns new_uint64_t ] ibis_get_port" 4 -.IX Item "[ returns new_uint64_t ] ibis_get_port" -Provide the \s-1GUID\s0 of the port \s-1IBIS\s0 is attached to -.IP "[ returns int ] ibis_set_transaction_timeout timeout_ms" 4 -.IX Item "[ returns int ] ibis_set_transaction_timeout timeout_ms" -Set the transaction time out in [msec] -.IP "[ returns int ] ibis_exit" 4 -.IX Item "[ returns int ] ibis_exit" -Exit \s-1IBIS\s0. -.IP "[ returns int ] ibis_puts verbosity msg" 4 -.IX Item "[ returns int ] ibis_puts verbosity msg" -Appends a message to the OpenSM log -.Sh "\s-1IBIS\s0 Options Object" -.IX Subsection "IBIS Options Object" -.RS 4 -The \s-1IBIS\s0 options are available through the predefined object: ibis_opts. -It can be manipulated using the standard Tcl methods: cget and configure. -Examples: -.Sp -.Vb 1 -\& ibis_opts cget -force_log_flush -.Ve -.Sp -.Vb 1 -\& ibis_opts configure -force_log_flush TRUE -.Ve -.Sp -The following are the different options that can be configured: -.RE -.IP "[ Member data: returns boolean_t * ] \-single_thread" 4 -.IX Item "[ Member data: returns boolean_t * ] -single_thread" -Run single threaded -.IP "[ Member data: returns boolean_t * ] \-force_log_flush" 4 -.IX Item "[ Member data: returns boolean_t * ] -force_log_flush" -If \s-1TRUE\s0 \- forces flash after each log message (\s-1TRUE\s0). -.IP "[ Member data: returns uint8_t * ] \-log_flags" 4 -.IX Item "[ Member data: returns uint8_t * ] -log_flags" -The log levels to be used -.IP "[ Member data: returns char * ] \-log_file" 4 -.IX Item "[ Member data: returns char * ] -log_file" -The name of the log file to be used.Must be configured before \fBibis_init\fR -is used to make an affect -.IP "[ Member data: returns uint64_t * ] \-sm_key" 4 -.IX Item "[ Member data: returns uint64_t * ] -sm_key" -The SM_Key to be used when sending SubnetMgt and SubnetAdmin MADs -.IP "[ Member data: returns uint64_t * ] \-m_key" 4 -.IX Item "[ Member data: returns uint64_t * ] -m_key" -The M_Key to be used when sending SubnetMgt -.IP "[ Member data: returns uint64_t * ] \-v_key" 4 -.IX Item "[ Member data: returns uint64_t * ] -v_key" -The Vendor Key to be used when sending Vendor Specific MADs. -.SH "IBPM" -.IX Header "IBPM" -\&\s-1IBPM\s0 stands for \s-1IB\s0 Performance Monitoring MADs. \s-1IB\s0 provides standard facilities for tracking statistics on every port. -.Sp -This section provide the details about the functions \s-1IBPM\s0 exposes. -They all return 0 on succes. -.IP "[ returns int ] pmMultiMaxGet" 4 -.IX Item "[ returns int ] pmMultiMaxGet" -Obtain the maximal number of parallel queries that can be sent -.IP "[ returns int ] pmGetPortCounters lid port_select" 4 -.IX Item "[ returns int ] pmGetPortCounters lid port_select" -Send a \*(L"PortCounters\*(R" query to teh given \s-1LID\s0 and port -.IP "[ returns int ] pmGetPortCountersMulti num lid_list port_select_list" 4 -.IX Item "[ returns int ] pmGetPortCountersMulti num lid_list port_select_list" -Send a batch of \*(L"PortCounters\*(R" queries to the given list of LIDs and ports. -num \- defines the number of elements in each list. -.IP "[ returns int ] pmGetExtPortCountersMulti num lid_list port_select_list" 4 -.IX Item "[ returns int ] pmGetExtPortCountersMulti num lid_list port_select_list" -Send a batch of \*(L"ExtendedPortCounters\*(R" queries to the given list of LIDs and ports. -num \- defines the number of elements in each list. -.IP "[ returns int ] pmClrAllCounters lid port_select" 4 -.IX Item "[ returns int ] pmClrAllCounters lid port_select" -Sends a command to \*(L"clear all counters\*(R" on the given \s-1LID\s0 and port -.IP "[ returns int ] pmClrAllCountersMulti num lid_list port_select_list" 4 -.IX Item "[ returns int ] pmClrAllCountersMulti num lid_list port_select_list" -Send a batch of \*(L"clear all counters\*(R" commands to the given list of LIDs and ports. -num \- defines the number of elements in each list. -.SH "IBSAC" -.IX Header "IBSAC" -\&\s-1IBSAC\s0 stands for \s-1IB\s0 Subnet Administrator (\s-1SA\s0) Client. It provide means to query the \s-1SA\s0 for information about the various objects it manages -.Sp -The following sections describe the concepts behind the \s-1SAC\s0 interface and then provides detailed description of each attribute that can be queried. -.Sh "\s-1IBSAC\s0 Objects" -.IX Subsection "IBSAC Objects" -.RS 4 -\&\s-1IBSAC\s0 uses predefined global objects to facilitate \s-1SA\s0 Queries. -Such objects are named sacQuery. Each such object -exposes a standard set of methods: -.RE -.IP "dump" 4 -.IX Item "dump" -dump out all fields and values for the obejct -.IP "cget \-:" 4 -.IX Item "cget -:" -obtain the value of the given field -.IP "configure \- :" 4 -.IX Item "configure - :" -set the field value -.IP "get :" 4 -.IX Item "get :" -query the \s-1SA\s0 for one record using the component mask and field values as set on the query object -.IP "getTable :" 4 -.IX Item "getTable :" -query the \s-1SA\s0 for all records matching component mask and field values as set on the query object -.Sp -Some \s-1SA\s0 maintained objects support the \*(L"set\*(R" and \*(L"delete\*(R" methods. In that case the following methods are made available on the corresponding query object: -.IP "set :" 4 -.IX Item "set :" -send a \fBset\fR method to the \s-1SA\s0 with the component mask and field values as set on the query object -.IP "delete :" 4 -.IX Item "delete :" -send a \fBdelete\fR method to the \s-1SA\s0 with the component mask and field values as set on the query object -.Sh "Returned Objects" -.IX Subsection "Returned Objects" -This section describes the values returned from the get/getTable/set/delete methods of the query objects: -.Sp -Each query returns a list (or one) identifiers (pointers) for objects. There identifiers are formatted according to the type of object they point to using the following prefixes: -.Sp -Queries embedding Subnet Management Attributes: -.IP "ni: = node info" 4 -.IX Item "ni: = node info" -.PD 0 -.IP "nr: = node info record (\s-1SA\s0 \s-1RID\s0 + node info)" 4 -.IX Item "nr: = node info record (SA RID + node info)" -.IP "pi: = port info" 4 -.IX Item "pi: = port info" -.IP "pir: = port info record (\s-1SA\s0 \s-1RID\s0 + port info)" 4 -.IX Item "pir: = port info record (SA RID + port info)" -.IP "smi: = \s-1SM\s0 info" 4 -.IX Item "smi: = SM info" -.IP "smir: = \s-1SM\s0 info record (\s-1SA\s0 \s-1RID\s0 + \s-1SM\s0 info)" 4 -.IX Item "smir: = SM info record (SA RID + SM info)" -.IP "swi: = switch info" 4 -.IX Item "swi: = switch info" -.IP "swir: = switch info record (\s-1SA\s0 \s-1RID\s0 + switch info)" 4 -.IX Item "swir: = switch info record (SA RID + switch info)" -.IP "slvt: = \s-1SL\s0 to \s-1VL\s0 table" 4 -.IX Item "slvt: = SL to VL table" -.IP "slvr: = \s-1SL\s0 to \s-1VL\s0 table Record (\s-1SA\s0 \s-1RID\s0 + \s-1SL\s0 to \s-1VL\s0 table)" 4 -.IX Item "slvr: = SL to VL table Record (SA RID + SL to VL table)" -.IP "pkt: = PKey table" 4 -.IX Item "pkt: = PKey table" -.IP "pkr: = PKey table record (\s-1SA\s0 \s-1RID\s0 + PKey table)" 4 -.IX Item "pkr: = PKey table record (SA RID + PKey table)" -.PD -Queries of non embedded attributes: -.IP "link: = link record" 4 -.IX Item "link: = link record" -.PD 0 -.IP "path: = path record" 4 -.IX Item "path: = path record" -.IP "lft: = Linear forwarding table" 4 -.IX Item "lft: = Linear forwarding table" -.IP "mcm: = Multicast Member Record" 4 -.IX Item "mcm: = Multicast Member Record" -.IP "cpi: = \s-1SA\s0 Class Port Info" 4 -.IX Item "cpi: = SA Class Port Info" -.IP "info: = Inform info (registration of event forwarding)" 4 -.IX Item "info: = Inform info (registration of event forwarding)" -.IP "svc: = Service Record" 4 -.IX Item "svc: = Service Record" -.IP "vlarb:= \s-1VL\s0 Arbitration table record" 4 -.IX Item "vlarb:= VL Arbitration table record" -.PD -.Sh "\s-1NODE\s0 \s-1INFO\s0 \s-1RECORD\s0" -.IX Subsection "NODE INFO RECORD" -.RS 4 -Component mask bits: -.RE -.ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_LID = 0x1" 4 -.el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_LID\fR = 0x1" 4 -.IX Item "[ Constant : int ] $IB_NR_COMPMASK_LID = 0x1" -.PD 0 -.ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_RESERVED1 = 0x2" 4 -.el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_RESERVED1\fR = 0x2" 4 -.IX Item "[ Constant : int ] $IB_NR_COMPMASK_RESERVED1 = 0x2" -.ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_BASEVERSION = 0x4" 4 -.el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_BASEVERSION\fR = 0x4" 4 -.IX Item "[ Constant : int ] $IB_NR_COMPMASK_BASEVERSION = 0x4" -.ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_CLASSVERSION = 0x8" 4 -.el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_CLASSVERSION\fR = 0x8" 4 -.IX Item "[ Constant : int ] $IB_NR_COMPMASK_CLASSVERSION = 0x8" -.ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_NODETYPE = 0x10" 4 -.el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_NODETYPE\fR = 0x10" 4 -.IX Item "[ Constant : int ] $IB_NR_COMPMASK_NODETYPE = 0x10" -.ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_NUMPORTS = 0x20" 4 -.el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_NUMPORTS\fR = 0x20" 4 -.IX Item "[ Constant : int ] $IB_NR_COMPMASK_NUMPORTS = 0x20" -.ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_SYSIMAGEGUID = 0x40" 4 -.el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_SYSIMAGEGUID\fR = 0x40" 4 -.IX Item "[ Constant : int ] $IB_NR_COMPMASK_SYSIMAGEGUID = 0x40" -.ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_NODEGUID = 0x80" 4 -.el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_NODEGUID\fR = 0x80" 4 -.IX Item "[ Constant : int ] $IB_NR_COMPMASK_NODEGUID = 0x80" -.ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_PORTGUID = 0x100" 4 -.el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_PORTGUID\fR = 0x100" 4 -.IX Item "[ Constant : int ] $IB_NR_COMPMASK_PORTGUID = 0x100" -.ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_PARTCAP = 0x200" 4 -.el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_PARTCAP\fR = 0x200" 4 -.IX Item "[ Constant : int ] $IB_NR_COMPMASK_PARTCAP = 0x200" -.ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_DEVID = 0x400" 4 -.el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_DEVID\fR = 0x400" 4 -.IX Item "[ Constant : int ] $IB_NR_COMPMASK_DEVID = 0x400" -.ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_REV = 0x800" 4 -.el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_REV\fR = 0x800" 4 -.IX Item "[ Constant : int ] $IB_NR_COMPMASK_REV = 0x800" -.ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_PORTNUM = 0x1000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_PORTNUM\fR = 0x1000" 4 -.IX Item "[ Constant : int ] $IB_NR_COMPMASK_PORTNUM = 0x1000" -.ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_VENDID = 0x2000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_VENDID\fR = 0x2000" 4 -.IX Item "[ Constant : int ] $IB_NR_COMPMASK_VENDID = 0x2000" -.ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_NODEDESC = 0x4000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_NODEDESC\fR = 0x4000" 4 -.IX Item "[ Constant : int ] $IB_NR_COMPMASK_NODEDESC = 0x4000" -.PD -\&\-\-\-\- -.Sp -\fIclass sacNodeInfo\fR -.IX Subsection "class sacNodeInfo" -.Sp -Fields: -.IP "[ Member data: returns uint8_t * ] \-base_version" 4 -.IX Item "[ Member data: returns uint8_t * ] -base_version" -.PD 0 -.IP "[ Member data: returns uint8_t * ] \-class_version" 4 -.IX Item "[ Member data: returns uint8_t * ] -class_version" -.IP "[ Member data: returns uint8_t * ] \-node_type" 4 -.IX Item "[ Member data: returns uint8_t * ] -node_type" -.IP "[ Member data: returns uint8_t * ] \-num_ports" 4 -.IX Item "[ Member data: returns uint8_t * ] -num_ports" -.IP "[ Member data: returns ib_net64_t * ] \-sys_guid" 4 -.IX Item "[ Member data: returns ib_net64_t * ] -sys_guid" -.IP "[ Member data: returns ib_net64_t * ] \-node_guid" 4 -.IX Item "[ Member data: returns ib_net64_t * ] -node_guid" -.IP "[ Member data: returns ib_net64_t * ] \-port_guid" 4 -.IX Item "[ Member data: returns ib_net64_t * ] -port_guid" -.IP "[ Member data: returns ib_net16_t * ] \-partition_cap" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -partition_cap" -.IP "[ Member data: returns ib_net16_t * ] \-device_id" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -device_id" -.IP "[ Member data: returns ib_net32_t * ] \-revision" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -revision" -.IP "[ Member data: returns ib_net32_t * ] \-port_num_vendor_id" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -port_num_vendor_id" -.IP "[ Member : returns void ] delete" 4 -.IX Item "[ Member : returns void ] delete" -.PD -\&\-\-\-\- -.Sp -\fIclass sacNodeRec\fR -.IX Subsection "class sacNodeRec" -.Sp -\&\s-1RID\s0 Fields: -.IP "[ Member data: returns ib_net16_t * ] \-lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lid" -.PD 0 -.IP "[ Member data: returns sacNodeInfo * ] \-node_info" 4 -.IX Item "[ Member data: returns sacNodeInfo * ] -node_info" -.IP "[ Member data: returns ib_node_desc_t * ] \-node_desc" 4 -.IX Item "[ Member data: returns ib_node_desc_t * ] -node_desc" -.PD -Methods: -.IP "[ Member : returns char * ] get comp_mask" 4 -.IX Item "[ Member : returns char * ] get comp_mask" -.PD 0 -.IP "[ Member : returns char * ] getTable comp_mask" 4 -.IX Item "[ Member : returns char * ] getTable comp_mask" -.IP "[ Member : returns void ] delete" 4 -.IX Item "[ Member : returns void ] delete" -.PD -.Sh "\s-1PORT\s0 \s-1INFO\s0 \s-1RECORD\s0" -.IX Subsection "PORT INFO RECORD" -.RS 4 -Component mask bits: -.RE -.ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_LID = 0x1" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_LID\fR = 0x1" 4 -.IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_LID = 0x1" -.PD 0 -.ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_PORTNUM = 0x2" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_PORTNUM\fR = 0x2" 4 -.IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_PORTNUM = 0x2" -.ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_RESV1 = 0x4" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_RESV1\fR = 0x4" 4 -.IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_RESV1 = 0x4" -.ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_MKEY = 0x8" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_MKEY\fR = 0x8" 4 -.IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_MKEY = 0x8" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_GIDPRE = 0x10" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_GIDPRE\fR = 0x10" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_GIDPRE = 0x10" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_BASELID = 0x20" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_BASELID\fR = 0x20" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_BASELID = 0x20" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_SMLID = 0x40" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_SMLID\fR = 0x40" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_SMLID = 0x40" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_CAPMASK = 0x80" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_CAPMASK\fR = 0x80" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_CAPMASK = 0x80" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_DIAGCODE = 0x100" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_DIAGCODE\fR = 0x100" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_DIAGCODE = 0x100" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_MKEYLEASEPRD = 0x200" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_MKEYLEASEPRD\fR = 0x200" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_MKEYLEASEPRD = 0x200" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_LOCALPORTNUM = 0x400" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_LOCALPORTNUM\fR = 0x400" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_LOCALPORTNUM = 0x400" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_LNKWIDTHSUPPORT = 0x800" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_LNKWIDTHSUPPORT\fR = 0x800" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_LNKWIDTHSUPPORT = 0x800" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_LNKWIDTHACTIVE = 0x1000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_LNKWIDTHACTIVE\fR = 0x1000" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_LNKWIDTHACTIVE = 0x1000" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_LINKWIDTHENABLED = 0x2000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_LINKWIDTHENABLED\fR = 0x2000" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_LINKWIDTHENABLED = 0x2000" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_LNKSPEEDSUPPORT = 0x4000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_LNKSPEEDSUPPORT\fR = 0x4000" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_LNKSPEEDSUPPORT = 0x4000" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_PORTSTATE = 0x10000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_PORTSTATE\fR = 0x10000" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_PORTSTATE = 0x10000" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_PORTPHYSTATE = 0x20000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_PORTPHYSTATE\fR = 0x20000" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_PORTPHYSTATE = 0x20000" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_LINKDWNDFLTSTATE = 0x40000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_LINKDWNDFLTSTATE\fR = 0x40000" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_LINKDWNDFLTSTATE = 0x40000" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_MKEYPROTBITS = 0x80000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_MKEYPROTBITS\fR = 0x80000" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_MKEYPROTBITS = 0x80000" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_LMC = 0x100000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_LMC\fR = 0x100000" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_LMC = 0x100000" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_LINKSPEEDACTIVE = 0x200000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_LINKSPEEDACTIVE\fR = 0x200000" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_LINKSPEEDACTIVE = 0x200000" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_LINKSPEEDENABLE = 0x400000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_LINKSPEEDENABLE\fR = 0x400000" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_LINKSPEEDENABLE = 0x400000" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_NEIGHBORMTU = 0x800000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_NEIGHBORMTU\fR = 0x800000" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_NEIGHBORMTU = 0x800000" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_MASTERSMSL = 0x1000000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_MASTERSMSL\fR = 0x1000000" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_MASTERSMSL = 0x1000000" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_VLCAP = 0x2000000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_VLCAP\fR = 0x2000000" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_VLCAP = 0x2000000" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_INITTYPE = 0x4000000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_INITTYPE\fR = 0x4000000" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_INITTYPE = 0x4000000" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_VLHIGHLIMIT = 0x8000000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_VLHIGHLIMIT\fR = 0x8000000" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_VLHIGHLIMIT = 0x8000000" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_VLARBHIGHCAP = 0x10000000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_VLARBHIGHCAP\fR = 0x10000000" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_VLARBHIGHCAP = 0x10000000" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_VLARBLOWCAP = 0x20000000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_VLARBLOWCAP\fR = 0x20000000" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_VLARBLOWCAP = 0x20000000" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_INITTYPEREPLY = 0x40000000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_INITTYPEREPLY\fR = 0x40000000" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_INITTYPEREPLY = 0x40000000" -.ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_MTUCAP = 0x80000000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_MTUCAP\fR = 0x80000000" 4 -.IX Item "[ Constant : int ] $IB_PIR_COMPMASK_MTUCAP = 0x80000000" -.ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_VLSTALLCNT = 0x100000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_VLSTALLCNT\fR = 0x100000000" 4 -.IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_VLSTALLCNT = 0x100000000" -.ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_HOQLIFE = 0x200000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_HOQLIFE\fR = 0x200000000" 4 -.IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_HOQLIFE = 0x200000000" -.ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_OPVLS = 0x400000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_OPVLS\fR = 0x400000000" 4 -.IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_OPVLS = 0x400000000" -.ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_PARENFIN = 0x800000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_PARENFIN\fR = 0x800000000" 4 -.IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_PARENFIN = 0x800000000" -.ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_PARENFOUT = 0x1000000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_PARENFOUT\fR = 0x1000000000" 4 -.IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_PARENFOUT = 0x1000000000" -.ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_FILTERRAWIN = 0x2000000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_FILTERRAWIN\fR = 0x2000000000" 4 -.IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_FILTERRAWIN = 0x2000000000" -.ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_FILTERRAWOUT = 0x4000000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_FILTERRAWOUT\fR = 0x4000000000" 4 -.IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_FILTERRAWOUT = 0x4000000000" -.ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_MKEYVIO = 0x8000000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_MKEYVIO\fR = 0x8000000000" 4 -.IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_MKEYVIO = 0x8000000000" -.ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_PKEYVIO = 0x10000000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_PKEYVIO\fR = 0x10000000000" 4 -.IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_PKEYVIO = 0x10000000000" -.ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_QKEYVIO = 0x20000000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_QKEYVIO\fR = 0x20000000000" 4 -.IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_QKEYVIO = 0x20000000000" -.ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_GUIDCAP = 0x40000000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_GUIDCAP\fR = 0x40000000000" 4 -.IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_GUIDCAP = 0x40000000000" -.ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_RESV2 = 0x80000000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_RESV2\fR = 0x80000000000" 4 -.IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_RESV2 = 0x80000000000" -.ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_SUBNTO = 0x100000000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_SUBNTO\fR = 0x100000000000" 4 -.IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_SUBNTO = 0x100000000000" -.ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_RESV3 = 0x200000000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_RESV3\fR = 0x200000000000" 4 -.IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_RESV3 = 0x200000000000" -.ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_RESPTIME = 0x400000000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_RESPTIME\fR = 0x400000000000" 4 -.IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_RESPTIME = 0x400000000000" -.ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_LOCALPHYERR = 0x800000000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_LOCALPHYERR\fR = 0x800000000000" 4 -.IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_LOCALPHYERR = 0x800000000000" -.ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_OVERRUNERR = 0x1000000000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_OVERRUNERR\fR = 0x1000000000000" 4 -.IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_OVERRUNERR = 0x1000000000000" -.PD -\&\-\-\-\- -.Sp -\fIclass sacPortInfo\fR -.IX Subsection "class sacPortInfo" -.Sp -Fields: -.IP "[ Member data: returns ib_net64_t * ] \-m_key" 4 -.IX Item "[ Member data: returns ib_net64_t * ] -m_key" -.PD 0 -.IP "[ Member data: returns ib_net64_t * ] \-subnet_prefix" 4 -.IX Item "[ Member data: returns ib_net64_t * ] -subnet_prefix" -.IP "[ Member data: returns ib_net16_t * ] \-base_lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -base_lid" -.IP "[ Member data: returns ib_net16_t * ] \-master_sm_base_lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -master_sm_base_lid" -.IP "[ Member data: returns ib_net32_t * ] \-capability_mask" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -capability_mask" -.IP "[ Member data: returns ib_net16_t * ] \-diag_code" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -diag_code" -.IP "[ Member data: returns ib_net16_t * ] \-m_key_lease_period" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -m_key_lease_period" -.IP "[ Member data: returns uint8_t * ] \-local_port_num" 4 -.IX Item "[ Member data: returns uint8_t * ] -local_port_num" -.IP "[ Member data: returns uint8_t * ] \-link_width_enabled" 4 -.IX Item "[ Member data: returns uint8_t * ] -link_width_enabled" -.IP "[ Member data: returns uint8_t * ] \-link_width_supported" 4 -.IX Item "[ Member data: returns uint8_t * ] -link_width_supported" -.IP "[ Member data: returns uint8_t * ] \-link_width_active" 4 -.IX Item "[ Member data: returns uint8_t * ] -link_width_active" -.IP "[ Member data: returns uint8_t * ] \-state_info1" 4 -.IX Item "[ Member data: returns uint8_t * ] -state_info1" -.PD -LinkSpeedSupported and PortState -.IP "[ Member data: returns uint8_t * ] \-state_info2" 4 -.IX Item "[ Member data: returns uint8_t * ] -state_info2" -PortPhysState and LinkDownDefaultState -.IP "[ Member data: returns uint8_t * ] \-mkey_lmc" 4 -.IX Item "[ Member data: returns uint8_t * ] -mkey_lmc" -.PD 0 -.IP "[ Member data: returns uint8_t * ] \-link_speed" 4 -.IX Item "[ Member data: returns uint8_t * ] -link_speed" -.PD -LinkSpeedEnabled and LinkSpeedActive -.IP "[ Member data: returns uint8_t * ] \-mtu_smsl" 4 -.IX Item "[ Member data: returns uint8_t * ] -mtu_smsl" -.PD 0 -.IP "[ Member data: returns uint8_t * ] \-vl_cap" 4 -.IX Item "[ Member data: returns uint8_t * ] -vl_cap" -.PD -VlCap and InitType -.IP "[ Member data: returns uint8_t * ] \-vl_high_limit" 4 -.IX Item "[ Member data: returns uint8_t * ] -vl_high_limit" -.PD 0 -.IP "[ Member data: returns uint8_t * ] \-vl_arb_high_cap" 4 -.IX Item "[ Member data: returns uint8_t * ] -vl_arb_high_cap" -.IP "[ Member data: returns uint8_t * ] \-vl_arb_low_cap" 4 -.IX Item "[ Member data: returns uint8_t * ] -vl_arb_low_cap" -.IP "[ Member data: returns uint8_t * ] \-mtu_cap" 4 -.IX Item "[ Member data: returns uint8_t * ] -mtu_cap" -.IP "[ Member data: returns uint8_t * ] \-vl_stall_life" 4 -.IX Item "[ Member data: returns uint8_t * ] -vl_stall_life" -.IP "[ Member data: returns uint8_t * ] \-vl_enforce" 4 -.IX Item "[ Member data: returns uint8_t * ] -vl_enforce" -.IP "[ Member data: returns ib_net16_t * ] \-m_key_violations" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -m_key_violations" -.IP "[ Member data: returns ib_net16_t * ] \-p_key_violations" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -p_key_violations" -.IP "[ Member data: returns ib_net16_t * ] \-q_key_violations" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -q_key_violations" -.IP "[ Member data: returns uint8_t * ] \-guid_cap" 4 -.IX Item "[ Member data: returns uint8_t * ] -guid_cap" -.IP "[ Member data: returns uint8_t * ] \-subnet_timeout" 4 -.IX Item "[ Member data: returns uint8_t * ] -subnet_timeout" -.IP "[ Member data: returns uint8_t * ] \-resp_time_value" 4 -.IX Item "[ Member data: returns uint8_t * ] -resp_time_value" -.IP "[ Member data: returns uint8_t * ] \-error_threshold" 4 -.IX Item "[ Member data: returns uint8_t * ] -error_threshold" -.IP "[ Member : returns void ] delete" 4 -.IX Item "[ Member : returns void ] delete" -.PD -\&\-\-\-\- -.Sp -\fIclass sacPortRec\fR -.IX Subsection "class sacPortRec" -.Sp -\&\s-1RID\s0 Fields: -.IP "[ Member data: returns ib_net16_t * ] \-lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lid" -.PD 0 -.IP "[ Member data: returns uint8_t * ] \-port_num" 4 -.IX Item "[ Member data: returns uint8_t * ] -port_num" -.IP "[ Member data: returns sacPortInfo * ] \-port_info" 4 -.IX Item "[ Member data: returns sacPortInfo * ] -port_info" -.PD -Methods: -.IP "[ Member : returns char * ] get comp_mask" 4 -.IX Item "[ Member : returns char * ] get comp_mask" -.PD 0 -.IP "[ Member : returns char * ] getTable comp_mask" 4 -.IX Item "[ Member : returns char * ] getTable comp_mask" -.IP "[ Member : returns void ] delete" 4 -.IX Item "[ Member : returns void ] delete" -.PD -.Sh "\s-1SM\s0 \s-1INFO\s0 \s-1RECORD\s0" -.IX Subsection "SM INFO RECORD" -.RS 4 -Component mask bits: -.RE -.ie n .IP "[ Constant : char * ] $IB_SMR_COMPMASK_LID = 0x1" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SMR_COMPMASK_LID\fR = 0x1" 4 -.IX Item "[ Constant : char * ] $IB_SMR_COMPMASK_LID = 0x1" -.PD 0 -.ie n .IP "[ Constant : char * ] $IB_SMR_COMPMASK_GUID = 0x2" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SMR_COMPMASK_GUID\fR = 0x2" 4 -.IX Item "[ Constant : char * ] $IB_SMR_COMPMASK_GUID = 0x2" -.ie n .IP "[ Constant : char * ] $IB_SMR_COMPMASK_SM_KEY = 0x4" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SMR_COMPMASK_SM_KEY\fR = 0x4" 4 -.IX Item "[ Constant : char * ] $IB_SMR_COMPMASK_SM_KEY = 0x4" -.ie n .IP "[ Constant : char * ] $IB_SMR_COMPMASK_ACT_COUNT = 0x8" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SMR_COMPMASK_ACT_COUNT\fR = 0x8" 4 -.IX Item "[ Constant : char * ] $IB_SMR_COMPMASK_ACT_COUNT = 0x8" -.ie n .IP "[ Constant : int ] $IB_SMR_COMPMASK_STATE = 0x10" 4 -.el .IP "[ Constant : int ] \f(CW$IB_SMR_COMPMASK_STATE\fR = 0x10" 4 -.IX Item "[ Constant : int ] $IB_SMR_COMPMASK_STATE = 0x10" -.ie n .IP "[ Constant : int ] $IB_SMR_COMPMASK_PRI = 0x20" 4 -.el .IP "[ Constant : int ] \f(CW$IB_SMR_COMPMASK_PRI\fR = 0x20" 4 -.IX Item "[ Constant : int ] $IB_SMR_COMPMASK_PRI = 0x20" -.PD -\&\-\-\-\- -.Sp -\fIclass sacSmInfo\fR -.IX Subsection "class sacSmInfo" -.Sp -Fields: -.IP "[ Member data: returns ib_net64_t * ] \-guid" 4 -.IX Item "[ Member data: returns ib_net64_t * ] -guid" -.PD 0 -.IP "[ Member data: returns ib_net64_t * ] \-sm_key" 4 -.IX Item "[ Member data: returns ib_net64_t * ] -sm_key" -.IP "[ Member data: returns ib_net32_t * ] \-act_count" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -act_count" -.IP "[ Member data: returns uint8_t * ] \-pri_state" 4 -.IX Item "[ Member data: returns uint8_t * ] -pri_state" -.IP "[ Member : returns void ] delete" 4 -.IX Item "[ Member : returns void ] delete" -.PD -\&\-\-\-\- -.Sp -\fIclass sacSmRec\fR -.IX Subsection "class sacSmRec" -.Sp -\&\s-1RID\s0 Fields: -.IP "[ Member data: returns ib_net16_t * ] \-lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lid" -.PD 0 -.IP "[ Member data: returns sacSmInfo * ] \-sm_info" 4 -.IX Item "[ Member data: returns sacSmInfo * ] -sm_info" -.PD -Methods: -.IP "[ Member : returns char * ] get comp_mask" 4 -.IX Item "[ Member : returns char * ] get comp_mask" -.PD 0 -.IP "[ Member : returns char * ] getTable comp_mask" 4 -.IX Item "[ Member : returns char * ] getTable comp_mask" -.IP "[ Member : returns void ] delete" 4 -.IX Item "[ Member : returns void ] delete" -.PD -.Sh "\s-1SWITCH\s0 \s-1INFO\s0 \s-1RECORD\s0" -.IX Subsection "SWITCH INFO RECORD" -.RS 4 -Component mask bits: -.RE -.ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_LID = 0x1" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_LID\fR = 0x1" 4 -.IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_LID = 0x1" -.PD 0 -.ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_LIN_CAP = 0x2" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_LIN_CAP\fR = 0x2" 4 -.IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_LIN_CAP = 0x2" -.ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_RAND_CAP = 0x4" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_RAND_CAP\fR = 0x4" 4 -.IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_RAND_CAP = 0x4" -.ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_MCAST_CAP = 0x8" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_MCAST_CAP\fR = 0x8" 4 -.IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_MCAST_CAP = 0x8" -.ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_LIN_TOP = 0x10" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_LIN_TOP\fR = 0x10" 4 -.IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_LIN_TOP = 0x10" -.ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_DEF_PORT = 0x20" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_DEF_PORT\fR = 0x20" 4 -.IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_DEF_PORT = 0x20" -.ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_DEF_MCAST_PRI = 0x40" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_DEF_MCAST_PRI\fR = 0x40" 4 -.IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_DEF_MCAST_PRI = 0x40" -.ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_DEF_MCAST_NOT = 0x80" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_DEF_MCAST_NOT\fR = 0x80" 4 -.IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_DEF_MCAST_NOT = 0x80" -.ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_STATE = 0x100" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_STATE\fR = 0x100" 4 -.IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_STATE = 0x100" -.ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_LIFE = 0x200" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_LIFE\fR = 0x200" 4 -.IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_LIFE = 0x200" -.ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_LMC = 0x400" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_LMC\fR = 0x400" 4 -.IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_LMC = 0x400" -.ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_ENFORCE_CAP = 0x800" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_ENFORCE_CAP\fR = 0x800" 4 -.IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_ENFORCE_CAP = 0x800" -.ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_FLAGS = 0x1000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_FLAGS\fR = 0x1000" 4 -.IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_FLAGS = 0x1000" -.PD -\&\-\-\-\- -.Sp -\fIclass sacSwInfo\fR -.IX Subsection "class sacSwInfo" -.Sp -Fields: -.IP "[ Member data: returns ib_net16_t * ] \-lin_cap" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lin_cap" -.PD 0 -.IP "[ Member data: returns ib_net16_t * ] \-rand_cap" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -rand_cap" -.IP "[ Member data: returns ib_net16_t * ] \-mcast_cap" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -mcast_cap" -.IP "[ Member data: returns ib_net16_t * ] \-lin_top" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lin_top" -.IP "[ Member data: returns uint8_t * ] \-def_port" 4 -.IX Item "[ Member data: returns uint8_t * ] -def_port" -.IP "[ Member data: returns uint8_t * ] \-def_mcast_pri_port" 4 -.IX Item "[ Member data: returns uint8_t * ] -def_mcast_pri_port" -.IP "[ Member data: returns uint8_t * ] \-def_mcast_not_port" 4 -.IX Item "[ Member data: returns uint8_t * ] -def_mcast_not_port" -.IP "[ Member data: returns uint8_t * ] \-life_state" 4 -.IX Item "[ Member data: returns uint8_t * ] -life_state" -.IP "[ Member data: returns ib_net16_t * ] \-lids_per_port" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lids_per_port" -.IP "[ Member data: returns ib_net16_t * ] \-enforce_cap" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -enforce_cap" -.IP "[ Member data: returns uint8_t * ] \-flags" 4 -.IX Item "[ Member data: returns uint8_t * ] -flags" -.IP "[ Member : returns void ] delete" 4 -.IX Item "[ Member : returns void ] delete" -.PD -\&\-\-\-\- -.Sp -\fIclass sacSwRec\fR -.IX Subsection "class sacSwRec" -.Sp -\&\s-1RID\s0 Fields: -.IP "[ Member data: returns ib_net16_t * ] \-lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lid" -.PD 0 -.IP "[ Member data: returns sacSwInfo * ] \-switch_info" 4 -.IX Item "[ Member data: returns sacSwInfo * ] -switch_info" -.PD -Methods: -.IP "[ Member : returns char * ] get comp_mask" 4 -.IX Item "[ Member : returns char * ] get comp_mask" -.PD 0 -.IP "[ Member : returns char * ] getTable comp_mask" 4 -.IX Item "[ Member : returns char * ] getTable comp_mask" -.IP "[ Member : returns void ] delete" 4 -.IX Item "[ Member : returns void ] delete" -.PD -.Sh "\s-1LINK\s0 \s-1RECORD\s0" -.IX Subsection "LINK RECORD" -.RS 4 -Component mask bits: -.RE -.ie n .IP "[ Constant : int ] $IB_LR_COMPMASK_FROM_LID = 0x1" 4 -.el .IP "[ Constant : int ] \f(CW$IB_LR_COMPMASK_FROM_LID\fR = 0x1" 4 -.IX Item "[ Constant : int ] $IB_LR_COMPMASK_FROM_LID = 0x1" -.PD 0 -.ie n .IP "[ Constant : int ] $IB_LR_COMPMASK_FROM_PORT = 0x2" 4 -.el .IP "[ Constant : int ] \f(CW$IB_LR_COMPMASK_FROM_PORT\fR = 0x2" 4 -.IX Item "[ Constant : int ] $IB_LR_COMPMASK_FROM_PORT = 0x2" -.ie n .IP "[ Constant : int ] $IB_LR_COMPMASK_TO_PORT = 0x4" 4 -.el .IP "[ Constant : int ] \f(CW$IB_LR_COMPMASK_TO_PORT\fR = 0x4" 4 -.IX Item "[ Constant : int ] $IB_LR_COMPMASK_TO_PORT = 0x4" -.ie n .IP "[ Constant : int ] $IB_LR_COMPMASK_TO_LID = 0x8" 4 -.el .IP "[ Constant : int ] \f(CW$IB_LR_COMPMASK_TO_LID\fR = 0x8" 4 -.IX Item "[ Constant : int ] $IB_LR_COMPMASK_TO_LID = 0x8" -.PD -\&\-\-\-\- -.Sp -\fIclass sacLinkRec\fR -.IX Subsection "class sacLinkRec" -.Sp -Fields: -.IP "[ Member data: returns ib_net16_t * ] \-from_lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -from_lid" -.PD 0 -.IP "[ Member data: returns uint8_t * ] \-from_port_num" 4 -.IX Item "[ Member data: returns uint8_t * ] -from_port_num" -.IP "[ Member data: returns uint8_t * ] \-to_port_num" 4 -.IX Item "[ Member data: returns uint8_t * ] -to_port_num" -.IP "[ Member data: returns ib_net16_t * ] \-to_lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -to_lid" -.PD -Methods: -.IP "[ Member : returns char * ] get comp_mask" 4 -.IX Item "[ Member : returns char * ] get comp_mask" -.PD 0 -.IP "[ Member : returns char * ] getTable comp_mask" 4 -.IX Item "[ Member : returns char * ] getTable comp_mask" -.IP "[ Member : returns void ] delete" 4 -.IX Item "[ Member : returns void ] delete" -.PD -.Sh "\s-1PATH\s0 \s-1RECORD\s0" -.IX Subsection "PATH RECORD" -.RS 4 -Component mask bits: -.RE -.ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_DGID = 0x4" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_DGID\fR = 0x4" 4 -.IX Item "[ Constant : int ] $IB_PR_COMPMASK_DGID = 0x4" -.PD 0 -.ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_SGID = 0x8" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_SGID\fR = 0x8" 4 -.IX Item "[ Constant : int ] $IB_PR_COMPMASK_SGID = 0x8" -.ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_DLID = 0x10" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_DLID\fR = 0x10" 4 -.IX Item "[ Constant : int ] $IB_PR_COMPMASK_DLID = 0x10" -.ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_SLID = 0x20" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_SLID\fR = 0x20" 4 -.IX Item "[ Constant : int ] $IB_PR_COMPMASK_SLID = 0x20" -.ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_RAWTRAFIC = 0x40" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_RAWTRAFIC\fR = 0x40" 4 -.IX Item "[ Constant : int ] $IB_PR_COMPMASK_RAWTRAFIC = 0x40" -.ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_RESV0 = 0x80" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_RESV0\fR = 0x80" 4 -.IX Item "[ Constant : int ] $IB_PR_COMPMASK_RESV0 = 0x80" -.ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_FLOWLABEL = 0x100" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_FLOWLABEL\fR = 0x100" 4 -.IX Item "[ Constant : int ] $IB_PR_COMPMASK_FLOWLABEL = 0x100" -.ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_HOPLIMIT = 0x200" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_HOPLIMIT\fR = 0x200" 4 -.IX Item "[ Constant : int ] $IB_PR_COMPMASK_HOPLIMIT = 0x200" -.ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_TCLASS = 0x400" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_TCLASS\fR = 0x400" 4 -.IX Item "[ Constant : int ] $IB_PR_COMPMASK_TCLASS = 0x400" -.ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_REVERSIBLE = 0x800" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_REVERSIBLE\fR = 0x800" 4 -.IX Item "[ Constant : int ] $IB_PR_COMPMASK_REVERSIBLE = 0x800" -.ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_NUMBPATH = 0x1000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_NUMBPATH\fR = 0x1000" 4 -.IX Item "[ Constant : int ] $IB_PR_COMPMASK_NUMBPATH = 0x1000" -.ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_PKEY = 0x2000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_PKEY\fR = 0x2000" 4 -.IX Item "[ Constant : int ] $IB_PR_COMPMASK_PKEY = 0x2000" -.ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_RESV1 = 0x4000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_RESV1\fR = 0x4000" 4 -.IX Item "[ Constant : int ] $IB_PR_COMPMASK_RESV1 = 0x4000" -.ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_SL = 0x8000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_SL\fR = 0x8000" 4 -.IX Item "[ Constant : int ] $IB_PR_COMPMASK_SL = 0x8000" -.ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_MTUSELEC = 0x10000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_MTUSELEC\fR = 0x10000" 4 -.IX Item "[ Constant : int ] $IB_PR_COMPMASK_MTUSELEC = 0x10000" -.ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_MTU = 0x20000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_MTU\fR = 0x20000" 4 -.IX Item "[ Constant : int ] $IB_PR_COMPMASK_MTU = 0x20000" -.ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_RATESELEC = 0x40000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_RATESELEC\fR = 0x40000" 4 -.IX Item "[ Constant : int ] $IB_PR_COMPMASK_RATESELEC = 0x40000" -.ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_RATE = 0x80000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_RATE\fR = 0x80000" 4 -.IX Item "[ Constant : int ] $IB_PR_COMPMASK_RATE = 0x80000" -.ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_PKTLIFETIMESELEC = 0x100000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_PKTLIFETIMESELEC\fR = 0x100000" 4 -.IX Item "[ Constant : int ] $IB_PR_COMPMASK_PKTLIFETIMESELEC = 0x100000" -.ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_PFTLIFETIME = 0x200000" 4 -.el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_PFTLIFETIME\fR = 0x200000" 4 -.IX Item "[ Constant : int ] $IB_PR_COMPMASK_PFTLIFETIME = 0x200000" -.PD -\&\-\-\-\- -.Sp -\fIclass sacPathRec\fR -.IX Subsection "class sacPathRec" -.Sp -Fields: -.IP "[ Member data: returns ib_gid_t * ] \-dgid" 4 -.IX Item "[ Member data: returns ib_gid_t * ] -dgid" -.PD 0 -.IP "[ Member data: returns ib_gid_t * ] \-sgid" 4 -.IX Item "[ Member data: returns ib_gid_t * ] -sgid" -.IP "[ Member data: returns ib_net16_t * ] \-dlid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -dlid" -.IP "[ Member data: returns ib_net16_t * ] \-slid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -slid" -.IP "[ Member data: returns ib_net32_t * ] \-hop_flow_raw" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -hop_flow_raw" -.IP "[ Member data: returns uint8_t * ] \-tclass" 4 -.IX Item "[ Member data: returns uint8_t * ] -tclass" -.IP "[ Member data: returns uint8_t * ] \-num_path" 4 -.IX Item "[ Member data: returns uint8_t * ] -num_path" -.IP "[ Member data: returns ib_net16_t * ] \-pkey" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -pkey" -.IP "[ Member data: returns ib_net16_t * ] \-sl" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -sl" -.IP "[ Member data: returns uint8_t * ] \-mtu" 4 -.IX Item "[ Member data: returns uint8_t * ] -mtu" -.IP "[ Member data: returns uint8_t * ] \-rate" 4 -.IX Item "[ Member data: returns uint8_t * ] -rate" -.IP "[ Member data: returns uint8_t * ] \-pkt_life" 4 -.IX Item "[ Member data: returns uint8_t * ] -pkt_life" -.IP "[ Member data: returns uint8_t * ] \-preference" 4 -.IX Item "[ Member data: returns uint8_t * ] -preference" -.PD -Methds: -.IP "[ Member : returns char * ] get comp_mask" 4 -.IX Item "[ Member : returns char * ] get comp_mask" -.PD 0 -.IP "[ Member : returns char * ] getTable comp_mask" 4 -.IX Item "[ Member : returns char * ] getTable comp_mask" -.IP "[ Member : returns void ] delete" 4 -.IX Item "[ Member : returns void ] delete" -.PD -.Sh "\s-1LINEAR\s0 \s-1FORWARDING\s0 \s-1TABLE\s0" -.IX Subsection "LINEAR FORWARDING TABLE" -.RS 4 -Component mask bits: -.RE -.ie n .IP "[ Constant : char * ] $IB_LFT_COMPMASK_LID = 0x1" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_LFT_COMPMASK_LID\fR = 0x1" 4 -.IX Item "[ Constant : char * ] $IB_LFT_COMPMASK_LID = 0x1" -.PD 0 -.ie n .IP "[ Constant : char * ] $IB_LFT_COMPMASK_BLOCK = 0x2" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_LFT_COMPMASK_BLOCK\fR = 0x2" 4 -.IX Item "[ Constant : char * ] $IB_LFT_COMPMASK_BLOCK = 0x2" -.PD -\&\-\-\-\- -.Sp -\fIclass sacLFTRec\fR -.IX Subsection "class sacLFTRec" -.Sp -Fields: -.IP "[ Member data: returns ib_net16_t * ] \-lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lid" -.PD 0 -.IP "[ Member data: returns ib_net16_t * ] \-block_num" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -block_num" -.IP "[ Member data: returns ib_lft_t * ] \-lft" 4 -.IX Item "[ Member data: returns ib_lft_t * ] -lft" -.PD -Methods: -.IP "[ Member : returns char * ] get comp_mask" 4 -.IX Item "[ Member : returns char * ] get comp_mask" -.PD 0 -.IP "[ Member : returns char * ] getTable comp_mask" 4 -.IX Item "[ Member : returns char * ] getTable comp_mask" -.IP "[ Member : returns void ] delete" 4 -.IX Item "[ Member : returns void ] delete" -.PD -.Sh "\s-1MULTICAST\s0 \s-1MEMBER\s0 \s-1RECORD\s0" -.IX Subsection "MULTICAST MEMBER RECORD" -.RS 4 -Component mask bits: -.RE -.ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_GID = 0x1" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_GID\fR = 0x1" 4 -.IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_GID = 0x1" -.PD 0 -.ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_MGID = 0x1" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_MGID\fR = 0x1" 4 -.IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_MGID = 0x1" -.ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_PORT_GID = 0x2" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_PORT_GID\fR = 0x2" 4 -.IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_PORT_GID = 0x2" -.ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_QKEY = 0x4" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_QKEY\fR = 0x4" 4 -.IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_QKEY = 0x4" -.ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_MLID = 0x8" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_MLID\fR = 0x8" 4 -.IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_MLID = 0x8" -.ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_MTU_SEL = 0x10" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_MTU_SEL\fR = 0x10" 4 -.IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_MTU_SEL = 0x10" -.ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_MTU = 0x20" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_MTU\fR = 0x20" 4 -.IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_MTU = 0x20" -.ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_TCLASS = 0x40" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_TCLASS\fR = 0x40" 4 -.IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_TCLASS = 0x40" -.ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_PKEY = 0x80" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_PKEY\fR = 0x80" 4 -.IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_PKEY = 0x80" -.ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_RATE_SEL = 0x100" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_RATE_SEL\fR = 0x100" 4 -.IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_RATE_SEL = 0x100" -.ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_RATE = 0x200" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_RATE\fR = 0x200" 4 -.IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_RATE = 0x200" -.ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_LIFE_SEL = 0x400" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_LIFE_SEL\fR = 0x400" 4 -.IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_LIFE_SEL = 0x400" -.ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_LIFE = 0x800" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_LIFE\fR = 0x800" 4 -.IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_LIFE = 0x800" -.ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_SL = 0x1000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_SL\fR = 0x1000" 4 -.IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_SL = 0x1000" -.ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_FLOW = 0x2000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_FLOW\fR = 0x2000" 4 -.IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_FLOW = 0x2000" -.ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_HOP = 0x4000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_HOP\fR = 0x4000" 4 -.IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_HOP = 0x4000" -.ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_SCOPE = 0x8000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_SCOPE\fR = 0x8000" 4 -.IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_SCOPE = 0x8000" -.ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_JOIN_STATE = 0x10000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_JOIN_STATE\fR = 0x10000" 4 -.IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_JOIN_STATE = 0x10000" -.ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_PROXY = 0x20000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_PROXY\fR = 0x20000" 4 -.IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_PROXY = 0x20000" -.PD -\&\-\-\-\- -.Sp -\fIclass sacMCMRec\fR -.IX Subsection "class sacMCMRec" -.Sp -Fields: -.IP "[ Member data: returns ib_gid_t * ] \-mgid" 4 -.IX Item "[ Member data: returns ib_gid_t * ] -mgid" -.PD 0 -.IP "[ Member data: returns ib_gid_t * ] \-port_gid" 4 -.IX Item "[ Member data: returns ib_gid_t * ] -port_gid" -.IP "[ Member data: returns ib_net32_t * ] \-qkey" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -qkey" -.IP "[ Member data: returns ib_net16_t * ] \-mlid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -mlid" -.IP "[ Member data: returns uint8_t * ] \-mtu" 4 -.IX Item "[ Member data: returns uint8_t * ] -mtu" -.IP "[ Member data: returns uint8_t * ] \-tclass" 4 -.IX Item "[ Member data: returns uint8_t * ] -tclass" -.IP "[ Member data: returns ib_net16_t * ] \-pkey" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -pkey" -.IP "[ Member data: returns uint8_t * ] \-rate" 4 -.IX Item "[ Member data: returns uint8_t * ] -rate" -.IP "[ Member data: returns uint8_t * ] \-pkt_life" 4 -.IX Item "[ Member data: returns uint8_t * ] -pkt_life" -.IP "[ Member data: returns ib_net32_t * ] \-sl_flow_hop" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -sl_flow_hop" -.IP "[ Member data: returns uint8_t * ] \-scope_state" 4 -.IX Item "[ Member data: returns uint8_t * ] -scope_state" -.PD -Methods: -.IP "[ Member : returns char * ] get comp_mask" 4 -.IX Item "[ Member : returns char * ] get comp_mask" -.PD 0 -.IP "[ Member : returns char * ] getTable comp_mask" 4 -.IX Item "[ Member : returns char * ] getTable comp_mask" -.IP "[ Member : returns char * ] set comp_mask" 4 -.IX Item "[ Member : returns char * ] set comp_mask" -.IP "[ Member : returns char * ] del comp_mask" 4 -.IX Item "[ Member : returns char * ] del comp_mask" -.IP "[ Member : returns int ] proxy_join_get" 4 -.IX Item "[ Member : returns int ] proxy_join_get" -.PD -Instead of simple field cget -.IP "[ Member : returns void ] proxy_join_set proxy_join" 4 -.IX Item "[ Member : returns void ] proxy_join_set proxy_join" -Instead of simple field configure -.IP "[ Member : returns void ] obj_delete" 4 -.IX Item "[ Member : returns void ] obj_delete" -Delete the object -.Sh "\s-1SA\s0 \s-1CLASS\s0 \s-1PORT\s0 \s-1INFO\s0" -.IX Subsection "SA CLASS PORT INFO" -.RS 4 -\&\-\-\-\- -.Sp -\fIclass sacClassPortInfo\fR -.IX Subsection "class sacClassPortInfo" -.Sp -Fields: -.RE -.IP "[ Member data: returns uint8_t * ] \-base_ver" 4 -.IX Item "[ Member data: returns uint8_t * ] -base_ver" -.PD 0 -.IP "[ Member data: returns uint8_t * ] \-class_ver" 4 -.IX Item "[ Member data: returns uint8_t * ] -class_ver" -.IP "[ Member data: returns ib_net16_t * ] \-cap_mask" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -cap_mask" -.IP "[ Member data: returns ib_net32_t * ] \-resp_time_val" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -resp_time_val" -.IP "[ Member data: returns ib_gid_t * ] \-redir_gid" 4 -.IX Item "[ Member data: returns ib_gid_t * ] -redir_gid" -.IP "[ Member data: returns ib_net32_t * ] \-redir_tc_sl_fl" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -redir_tc_sl_fl" -.IP "[ Member data: returns ib_net16_t * ] \-redir_lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -redir_lid" -.IP "[ Member data: returns ib_net16_t * ] \-redir_pkey" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -redir_pkey" -.IP "[ Member data: returns ib_net32_t * ] \-redir_qp" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -redir_qp" -.IP "[ Member data: returns ib_net32_t * ] \-redir_qkey" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -redir_qkey" -.IP "[ Member data: returns ib_gid_t * ] \-trap_gid" 4 -.IX Item "[ Member data: returns ib_gid_t * ] -trap_gid" -.IP "[ Member data: returns ib_net32_t * ] \-trap_tc_sl_fl" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -trap_tc_sl_fl" -.IP "[ Member data: returns ib_net16_t * ] \-trap_lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -trap_lid" -.IP "[ Member data: returns ib_net16_t * ] \-trap_pkey" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -trap_pkey" -.IP "[ Member data: returns ib_net32_t * ] \-trap_hop_qp" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -trap_hop_qp" -.IP "[ Member data: returns ib_net32_t * ] \-trap_qkey" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -trap_qkey" -.PD -Methods: -.IP "[ Member : returns char * ] get" 4 -.IX Item "[ Member : returns char * ] get" -.PD 0 -.IP "[ Member : returns void ] delete" 4 -.IX Item "[ Member : returns void ] delete" -.PD -.Sh "\s-1INFORM\s0 \s-1INFO\s0 \s-1RECORD\s0" -.IX Subsection "INFORM INFO RECORD" -.RS 4 -The inform Info is built with heirarchy of objects. So several classes are defined. -.Sp -\&\-\-\-\- -.Sp -\fIclass sacInformInfo\fR -.IX Subsection "class sacInformInfo" -.Sp -Fields: -.RE -.IP "[ Member data: returns ib_gid_t * ] \-gid" 4 -.IX Item "[ Member data: returns ib_gid_t * ] -gid" -.PD 0 -.IP "[ Member data: returns ib_net16_t * ] \-lid_range_begin" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lid_range_begin" -.IP "[ Member data: returns ib_net16_t * ] \-lid_range_end" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lid_range_end" -.IP "[ Member data: returns ib_net16_t * ] \-reserved1" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -reserved1" -.IP "[ Member data: returns uint8_t * ] \-is_generic" 4 -.IX Item "[ Member data: returns uint8_t * ] -is_generic" -.IP "[ Member data: returns uint8_t * ] \-subscribe" 4 -.IX Item "[ Member data: returns uint8_t * ] -subscribe" -.IP "[ Member data: returns ib_net16_t * ] \-trap_type" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -trap_type" -.IP "[ Member data: returns sacInformInfo_g_or_v * ] \-g_or_v" 4 -.IX Item "[ Member data: returns sacInformInfo_g_or_v * ] -g_or_v" -.PD -Methods: -.IP "[ Member : returns char * ] set" 4 -.IX Item "[ Member : returns char * ] set" -.PD 0 -.IP "[ Member : returns void ] delete" 4 -.IX Item "[ Member : returns void ] delete" -.PD -\&\-\-\-\- -.Sp -\fIclass sacInformInfo_g_or_v\fR -.IX Subsection "class sacInformInfo_g_or_v" -.Sp -Fields: -.IP "[ Member data: returns sacInformInfo_g_or_v_generic * ] \-generic" 4 -.IX Item "[ Member data: returns sacInformInfo_g_or_v_generic * ] -generic" -.PD 0 -.IP "[ Member data: returns sacInformInfo_g_or_v_vend * ] \-vend" 4 -.IX Item "[ Member data: returns sacInformInfo_g_or_v_vend * ] -vend" -.PD -\&\-\-\-\- -.Sp -\fIclass sacInformInfo_g_or_v_generic\fR -.IX Subsection "class sacInformInfo_g_or_v_generic" -.Sp -Fields: -.IP "[ Member data: returns ib_net16_t * ] \-trap_num" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -trap_num" -.PD 0 -.IP "[ Member data: returns ib_net32_t * ] \-qpn_resp_time_val" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -qpn_resp_time_val" -.IP "[ Member data: returns uint8_t * ] \-reserved2" 4 -.IX Item "[ Member data: returns uint8_t * ] -reserved2" -.IP "[ Member data: returns uint8_t * ] \-node_type_msb" 4 -.IX Item "[ Member data: returns uint8_t * ] -node_type_msb" -.IP "[ Member data: returns ib_net16_t * ] \-node_type_lsb" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -node_type_lsb" -.PD -\&\-\-\-\- -.Sp -\fIclass sacInformInfo_g_or_v_vend\fR -.IX Subsection "class sacInformInfo_g_or_v_vend" -.Sp -Fields: -.IP "[ Member data: returns ib_net16_t * ] \-dev_id" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -dev_id" -.PD 0 -.IP "[ Member data: returns ib_net32_t * ] \-qpn_resp_time_val" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -qpn_resp_time_val" -.IP "[ Member data: returns uint8_t * ] \-reserved2" 4 -.IX Item "[ Member data: returns uint8_t * ] -reserved2" -.IP "[ Member data: returns uint8_t * ] \-vendor_id_msb" 4 -.IX Item "[ Member data: returns uint8_t * ] -vendor_id_msb" -.IP "[ Member data: returns ib_net16_t * ] \-vendor_id_lsb" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -vendor_id_lsb" -.PD -.Sh "\s-1SERVICE\s0 \s-1RECORD\s0" -.IX Subsection "SERVICE RECORD" -.RS 4 -Component mask bits: -.RE -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SID = 0x1" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SID\fR = 0x1" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SID = 0x1" -.PD 0 -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SGID = 0x1" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SGID\fR = 0x1" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SGID = 0x1" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SPKEY = 0x2" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SPKEY\fR = 0x2" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SPKEY = 0x2" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_RES1 = 0x4" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_RES1\fR = 0x4" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_RES1 = 0x4" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SLEASE = 0x8" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SLEASE\fR = 0x8" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SLEASE = 0x8" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SKEY = 0x10" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SKEY\fR = 0x10" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SKEY = 0x10" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SNAME = 0x20" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SNAME\fR = 0x20" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SNAME = 0x20" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_0 = 0x40" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_0\fR = 0x40" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_0 = 0x40" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_1 = 0x80" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_1\fR = 0x80" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_1 = 0x80" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_2 = 0x100" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_2\fR = 0x100" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_2 = 0x100" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_3 = 0x200" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_3\fR = 0x200" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_3 = 0x200" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_4 = 0x400" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_4\fR = 0x400" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_4 = 0x400" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_5 = 0x800" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_5\fR = 0x800" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_5 = 0x800" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_6 = 0x1000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_6\fR = 0x1000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_6 = 0x1000" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_7 = 0x2000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_7\fR = 0x2000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_7 = 0x2000" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_8 = 0x4000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_8\fR = 0x4000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_8 = 0x4000" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_9 = 0x8000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_9\fR = 0x8000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_9 = 0x8000" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_10 = 0x10000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_10\fR = 0x10000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_10 = 0x10000" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_11 = 0x20000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_11\fR = 0x20000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_11 = 0x20000" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_12 = 0x40000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_12\fR = 0x40000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_12 = 0x40000" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_13 = 0x80000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_13\fR = 0x80000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_13 = 0x80000" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_14 = 0x100000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_14\fR = 0x100000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_14 = 0x100000" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_15 = 0x200000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_15\fR = 0x200000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_15 = 0x200000" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_0 = 0x400000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA16_0\fR = 0x400000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_0 = 0x400000" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_1 = 0x800000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA16_1\fR = 0x800000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_1 = 0x800000" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_2 = 0x1000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA16_2\fR = 0x1000000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_2 = 0x1000000" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_3 = 0x2000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA16_3\fR = 0x2000000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_3 = 0x2000000" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_4 = 0x4000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA16_4\fR = 0x4000000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_4 = 0x4000000" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_5 = 0x8000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA16_5\fR = 0x8000000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_5 = 0x8000000" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_6 = 0x10000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA16_6\fR = 0x10000000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_6 = 0x10000000" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_7 = 0x20000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA16_7\fR = 0x20000000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_7 = 0x20000000" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA32_0 = 0x40000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA32_0\fR = 0x40000000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA32_0 = 0x40000000" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA32_1 = 0x80000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA32_1\fR = 0x80000000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA32_1 = 0x80000000" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA32_2 = 0x100000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA32_2\fR = 0x100000000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA32_2 = 0x100000000" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA32_3 = 0x200000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA32_3\fR = 0x200000000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA32_3 = 0x200000000" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA64_0 = 0x400000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA64_0\fR = 0x400000000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA64_0 = 0x400000000" -.ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA64_1 = 0x800000000" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA64_1\fR = 0x800000000" 4 -.IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA64_1 = 0x800000000" -.PD -\&\-\-\-\- -.Sp -\fIclass sacServiceRec\fR -.IX Subsection "class sacServiceRec" -.Sp -Fields: -.IP "[ Member data: returns ib_net64_t * ] \-service_id" 4 -.IX Item "[ Member data: returns ib_net64_t * ] -service_id" -.PD 0 -.IP "[ Member data: returns ib_gid_t * ] \-service_gid" 4 -.IX Item "[ Member data: returns ib_gid_t * ] -service_gid" -.IP "[ Member data: returns ib_net16_t * ] \-service_pkey" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -service_pkey" -.IP "[ Member data: returns ib_net16_t * ] \-resv" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -resv" -.IP "[ Member data: returns ib_net32_t * ] \-service_lease" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -service_lease" -.IP "[ Member data: returns uint8_array_t * ] \-service_key" 4 -.IX Item "[ Member data: returns uint8_array_t * ] -service_key" -.IP "[ Member data: returns ib_svc_name_t * ] \-service_name" 4 -.IX Item "[ Member data: returns ib_svc_name_t * ] -service_name" -.IP "[ Member data: returns uint8_array_t * ] \-service_data8" 4 -.IX Item "[ Member data: returns uint8_array_t * ] -service_data8" -.IP "[ Member data: returns ib_net16_array_t * ] \-service_data16" 4 -.IX Item "[ Member data: returns ib_net16_array_t * ] -service_data16" -.IP "[ Member data: returns ib_net32_array_t * ] \-service_data32" 4 -.IX Item "[ Member data: returns ib_net32_array_t * ] -service_data32" -.IP "[ Member data: returns ib_net64_array_t * ] \-service_data64" 4 -.IX Item "[ Member data: returns ib_net64_array_t * ] -service_data64" -.PD -Methods: -.IP "[ Member : returns char * ] get comp_mask" 4 -.IX Item "[ Member : returns char * ] get comp_mask" -.PD 0 -.IP "[ Member : returns char * ] set comp_mask" 4 -.IX Item "[ Member : returns char * ] set comp_mask" -.IP "[ Member : returns char * ] getTable comp_mask" 4 -.IX Item "[ Member : returns char * ] getTable comp_mask" -.IP "[ Member : returns char * ] delete comp_mask" 4 -.IX Item "[ Member : returns char * ] delete comp_mask" -.IP "[ Member : returns void ] obj_delete" 4 -.IX Item "[ Member : returns void ] obj_delete" -.PD -.Sh "\s-1SL\s0 to \s-1VL\s0 \s-1TABLE\s0 \s-1RECORD\s0" -.IX Subsection "SL to VL TABLE RECORD" -.RS 4 -Component mask bits: -.RE -.ie n .IP "[ Constant : char * ] $IB_SLVL_COMPMASK_LID = 0x1" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SLVL_COMPMASK_LID\fR = 0x1" 4 -.IX Item "[ Constant : char * ] $IB_SLVL_COMPMASK_LID = 0x1" -.PD 0 -.ie n .IP "[ Constant : char * ] $IB_SLVL_COMPMASK_IN_PORT = 0x2" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SLVL_COMPMASK_IN_PORT\fR = 0x2" 4 -.IX Item "[ Constant : char * ] $IB_SLVL_COMPMASK_IN_PORT = 0x2" -.ie n .IP "[ Constant : char * ] $IB_SLVL_COMPMASK_OUT_PORT = 0x4" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_SLVL_COMPMASK_OUT_PORT\fR = 0x4" 4 -.IX Item "[ Constant : char * ] $IB_SLVL_COMPMASK_OUT_PORT = 0x4" -.PD -\&\-\-\-\- -.Sp -\fIclass sacSlVlTbl\fR -.IX Subsection "class sacSlVlTbl" -.IP "[ Member data: returns uint8_array_t * ] \-raw_vl_by_sl" 4 -.IX Item "[ Member data: returns uint8_array_t * ] -raw_vl_by_sl" -\&\-\-\-\- -.Sp -\fIclass sacSlVlRec\fR -.IX Subsection "class sacSlVlRec" -.Sp -\&\s-1RID\s0 Fields: -.IP "[ Member data: returns ib_net16_t * ] \-lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lid" -for \s-1CA:\s0 lid of port, for switch lid of port 0 -.IP "[ Member data: returns uint8_t * ] \-in_port_num" 4 -.IX Item "[ Member data: returns uint8_t * ] -in_port_num" -reserved for \s-1CA\s0's -.IP "[ Member data: returns uint8_t * ] \-out_port_num" 4 -.IX Item "[ Member data: returns uint8_t * ] -out_port_num" -reserved for \s-1CA\s0's -.IP "[ Member data: returns uint32_t * ] \-resv" 4 -.IX Item "[ Member data: returns uint32_t * ] -resv" -.PD 0 -.IP "[ Member data: returns sacSlVlTbl * ] \-slvl_tbl" 4 -.IX Item "[ Member data: returns sacSlVlTbl * ] -slvl_tbl" -.PD -Methods: -.IP "[ Member : returns char * ] get comp_mask" 4 -.IX Item "[ Member : returns char * ] get comp_mask" -.PD 0 -.IP "[ Member : returns char * ] getTable comp_mask" 4 -.IX Item "[ Member : returns char * ] getTable comp_mask" -.IP "[ Member : returns void ] delete" 4 -.IX Item "[ Member : returns void ] delete" -.PD -.Sh "\s-1VL\s0 \s-1ARBITRATION\s0 \s-1TABLE\s0 \s-1RECORD\s0" -.IX Subsection "VL ARBITRATION TABLE RECORD" -.RS 4 -Component mask bits: -.RE -.ie n .IP "[ Constant : char * ] $IB_VLA_COMPMASK_LID = 0x1" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_VLA_COMPMASK_LID\fR = 0x1" 4 -.IX Item "[ Constant : char * ] $IB_VLA_COMPMASK_LID = 0x1" -.PD 0 -.ie n .IP "[ Constant : char * ] $IB_VLA_COMPMASK_OUT_PORT = 0x2" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_VLA_COMPMASK_OUT_PORT\fR = 0x2" 4 -.IX Item "[ Constant : char * ] $IB_VLA_COMPMASK_OUT_PORT = 0x2" -.ie n .IP "[ Constant : char * ] $IB_VLA_COMPMASK_BLOCK = 0x4" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_VLA_COMPMASK_BLOCK\fR = 0x4" 4 -.IX Item "[ Constant : char * ] $IB_VLA_COMPMASK_BLOCK = 0x4" -.PD -\&\-\-\-\- -.Sp -\fIclass sacVlArbRec\fR -.IX Subsection "class sacVlArbRec" -.Sp -Fields: -.IP "[ Member data: returns ib_net16_t * ] \-lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lid" -for \s-1CA:\s0 lid of port, for switch lid of port 0 -.IP "[ Member data: returns uint8_t * ] \-port_num" 4 -.IX Item "[ Member data: returns uint8_t * ] -port_num" -.PD 0 -.IP "[ Member data: returns uint8_t * ] \-block_num" 4 -.IX Item "[ Member data: returns uint8_t * ] -block_num" -.IP "[ Member data: returns uint32_t * ] \-reserved" 4 -.IX Item "[ Member data: returns uint32_t * ] -reserved" -.IP "[ Member data: returns sac_vl_arb_tbl_t * ] \-vl_arb_tbl" 4 -.IX Item "[ Member data: returns sac_vl_arb_tbl_t * ] -vl_arb_tbl" -.PD -Methods: -.IP "[ Member : returns char * ] get comp_mask" 4 -.IX Item "[ Member : returns char * ] get comp_mask" -.PD 0 -.IP "[ Member : returns char * ] getTable comp_mask" 4 -.IX Item "[ Member : returns char * ] getTable comp_mask" -.IP "[ Member : returns void ] delete" 4 -.IX Item "[ Member : returns void ] delete" -.PD -.Sh "\s-1PKEY\s0 \s-1TABLE\s0 \s-1RECORD\s0" -.IX Subsection "PKEY TABLE RECORD" -.RS 4 -Component mask bits: -.RE -.ie n .IP "[ Constant : char * ] $IB_PKEY_COMPMASK_LID = 0x1" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PKEY_COMPMASK_LID\fR = 0x1" 4 -.IX Item "[ Constant : char * ] $IB_PKEY_COMPMASK_LID = 0x1" -.PD 0 -.ie n .IP "[ Constant : char * ] $IB_PKEY_COMPMASK_BLOCK = 0x2" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PKEY_COMPMASK_BLOCK\fR = 0x2" 4 -.IX Item "[ Constant : char * ] $IB_PKEY_COMPMASK_BLOCK = 0x2" -.ie n .IP "[ Constant : char * ] $IB_PKEY_COMPMASK_PORT = 0x4" 4 -.el .IP "[ Constant : char * ] \f(CW$IB_PKEY_COMPMASK_PORT\fR = 0x4" 4 -.IX Item "[ Constant : char * ] $IB_PKEY_COMPMASK_PORT = 0x4" -.PD -\&\-\-\-\- -.Sp -\fIclass sacPKeyTbl\fR -.IX Subsection "class sacPKeyTbl" -.Sp -Fields: -.IP "[ Member data: returns ib_net16_array_t * ] \-pkey_entry" 4 -.IX Item "[ Member data: returns ib_net16_array_t * ] -pkey_entry" -\&\-\-\-\- -.Sp -\fIclass sacPKeyRec\fR -.IX Subsection "class sacPKeyRec" -.Sp -\&\s-1RID\s0 Fields: -.IP "[ Member data: returns ib_net16_t * ] \-lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lid" -for \s-1CA:\s0 lid of port, for switch lid of port 0 -.IP "[ Member data: returns uint16_t * ] \-block_num" 4 -.IX Item "[ Member data: returns uint16_t * ] -block_num" -.PD 0 -.IP "[ Member data: returns uint8_t * ] \-port_num" 4 -.IX Item "[ Member data: returns uint8_t * ] -port_num" -.PD -for switch: port number, for \s-1CA:\s0 reserved -.IP "[ Member data: returns uint8_t * ] \-reserved1" 4 -.IX Item "[ Member data: returns uint8_t * ] -reserved1" -.PD 0 -.IP "[ Member data: returns uint16_t * ] \-reserved2" 4 -.IX Item "[ Member data: returns uint16_t * ] -reserved2" -.IP "[ Member data: returns sacPKeyTbl * ] \-pkey_tbl" 4 -.IX Item "[ Member data: returns sacPKeyTbl * ] -pkey_tbl" -.PD -Methods: -.IP "[ Member : returns char * ] get comp_mask" 4 -.IX Item "[ Member : returns char * ] get comp_mask" -.PD 0 -.IP "[ Member : returns char * ] getTable comp_mask" 4 -.IX Item "[ Member : returns char * ] getTable comp_mask" -.IP "[ Member : returns void ] delete" 4 -.IX Item "[ Member : returns void ] delete" -.PD -.SH "Subnet Management MADs (SMPs)" -.IX Header "Subnet Management MADs (SMPs)" -The \s-1SM\s0 interface supports sending Subnet Management Packets to the fabric devices. The specific attributes that can be access is provided in detail in each sub section below. -.Sp -A set of object types is defined. The user can allocate a new attribute object. Then the object can be set using configure or the direct manipulation methods. -Extra methods are provided for each object: -=item setByDr -.Sp -Set the attribute on the object accessible by the given directed route. A directed route is a list of port numbers to go out from. -.IP "getByDr " 4 -.IX Item "getByDr " -Get the attribute value by traversing a directed route. -.Sp -setByLid -.Sp -Set the attribute on the object accessible by the given \s-1LID\s0 -.Sp -getByLid -.Sp -get the attribute on the object accessible by the given \s-1LID\s0 -.Sh "class smNodeInfo" -.IX Subsection "class smNodeInfo" -.RS 4 -Fields: -.RE -.IP "[ Member data: returns uint8_t * ] \-base_version" 4 -.IX Item "[ Member data: returns uint8_t * ] -base_version" -.PD 0 -.IP "[ Member data: returns uint8_t * ] \-class_version" 4 -.IX Item "[ Member data: returns uint8_t * ] -class_version" -.IP "[ Member data: returns uint8_t * ] \-node_type" 4 -.IX Item "[ Member data: returns uint8_t * ] -node_type" -.IP "[ Member data: returns uint8_t * ] \-num_ports" 4 -.IX Item "[ Member data: returns uint8_t * ] -num_ports" -.IP "[ Member data: returns ib_net64_t * ] \-sys_guid" 4 -.IX Item "[ Member data: returns ib_net64_t * ] -sys_guid" -.IP "[ Member data: returns ib_net64_t * ] \-node_guid" 4 -.IX Item "[ Member data: returns ib_net64_t * ] -node_guid" -.IP "[ Member data: returns ib_net64_t * ] \-port_guid" 4 -.IX Item "[ Member data: returns ib_net64_t * ] -port_guid" -.IP "[ Member data: returns ib_net16_t * ] \-partition_cap" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -partition_cap" -.IP "[ Member data: returns ib_net16_t * ] \-device_id" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -device_id" -.IP "[ Member data: returns ib_net32_t * ] \-revision" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -revision" -.IP "[ Member data: returns ib_net32_t * ] \-port_num_vendor_id" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -port_num_vendor_id" -.PD -Methods: -.IP "[ Member : returns int ] getByDr dr" 4 -.IX Item "[ Member : returns int ] getByDr dr" -.PD 0 -.IP "[ Member : returns int ] setByDr dr" 4 -.IX Item "[ Member : returns int ] setByDr dr" -.IP "[ Member : returns int ] getByLid lid" 4 -.IX Item "[ Member : returns int ] getByLid lid" -.IP "[ Member : returns int ] setByLid lid" 4 -.IX Item "[ Member : returns int ] setByLid lid" -.PD -.SH "class smPortInfo" -.IX Header "class smPortInfo" -Fields: -.IP "[ Member data: returns ib_net64_t * ] \-m_key" 4 -.IX Item "[ Member data: returns ib_net64_t * ] -m_key" -.PD 0 -.IP "[ Member data: returns ib_net64_t * ] \-subnet_prefix" 4 -.IX Item "[ Member data: returns ib_net64_t * ] -subnet_prefix" -.IP "[ Member data: returns ib_net16_t * ] \-base_lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -base_lid" -.IP "[ Member data: returns ib_net16_t * ] \-master_sm_base_lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -master_sm_base_lid" -.IP "[ Member data: returns ib_net32_t * ] \-capability_mask" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -capability_mask" -.IP "[ Member data: returns ib_net16_t * ] \-diag_code" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -diag_code" -.IP "[ Member data: returns ib_net16_t * ] \-m_key_lease_period" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -m_key_lease_period" -.IP "[ Member data: returns uint8_t * ] \-local_port_num" 4 -.IX Item "[ Member data: returns uint8_t * ] -local_port_num" -.IP "[ Member data: returns uint8_t * ] \-link_width_enabled" 4 -.IX Item "[ Member data: returns uint8_t * ] -link_width_enabled" -.IP "[ Member data: returns uint8_t * ] \-link_width_supported" 4 -.IX Item "[ Member data: returns uint8_t * ] -link_width_supported" -.IP "[ Member data: returns uint8_t * ] \-link_width_active" 4 -.IX Item "[ Member data: returns uint8_t * ] -link_width_active" -.IP "[ Member data: returns uint8_t * ] \-state_info1" 4 -.IX Item "[ Member data: returns uint8_t * ] -state_info1" -.PD -LinkSpeedSupported and PortState -.IP "[ Member data: returns uint8_t * ] \-state_info2" 4 -.IX Item "[ Member data: returns uint8_t * ] -state_info2" -PortPhysState and LinkDownDefaultState -.IP "[ Member data: returns uint8_t * ] \-mkey_lmc" 4 -.IX Item "[ Member data: returns uint8_t * ] -mkey_lmc" -.PD 0 -.IP "[ Member data: returns uint8_t * ] \-link_speed" 4 -.IX Item "[ Member data: returns uint8_t * ] -link_speed" -.PD -LinkSpeedEnabled and LinkSpeedActive -.IP "[ Member data: returns uint8_t * ] \-mtu_smsl" 4 -.IX Item "[ Member data: returns uint8_t * ] -mtu_smsl" -.PD 0 -.IP "[ Member data: returns uint8_t * ] \-vl_cap" 4 -.IX Item "[ Member data: returns uint8_t * ] -vl_cap" -.PD -VlCap and InitType -.IP "[ Member data: returns uint8_t * ] \-vl_high_limit" 4 -.IX Item "[ Member data: returns uint8_t * ] -vl_high_limit" -.PD 0 -.IP "[ Member data: returns uint8_t * ] \-vl_arb_high_cap" 4 -.IX Item "[ Member data: returns uint8_t * ] -vl_arb_high_cap" -.IP "[ Member data: returns uint8_t * ] \-vl_arb_low_cap" 4 -.IX Item "[ Member data: returns uint8_t * ] -vl_arb_low_cap" -.IP "[ Member data: returns uint8_t * ] \-mtu_cap" 4 -.IX Item "[ Member data: returns uint8_t * ] -mtu_cap" -.IP "[ Member data: returns uint8_t * ] \-vl_stall_life" 4 -.IX Item "[ Member data: returns uint8_t * ] -vl_stall_life" -.IP "[ Member data: returns uint8_t * ] \-vl_enforce" 4 -.IX Item "[ Member data: returns uint8_t * ] -vl_enforce" -.IP "[ Member data: returns ib_net16_t * ] \-m_key_violations" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -m_key_violations" -.IP "[ Member data: returns ib_net16_t * ] \-p_key_violations" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -p_key_violations" -.IP "[ Member data: returns ib_net16_t * ] \-q_key_violations" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -q_key_violations" -.IP "[ Member data: returns uint8_t * ] \-guid_cap" 4 -.IX Item "[ Member data: returns uint8_t * ] -guid_cap" -.IP "[ Member data: returns uint8_t * ] \-subnet_timeout" 4 -.IX Item "[ Member data: returns uint8_t * ] -subnet_timeout" -.IP "[ Member data: returns uint8_t * ] \-resp_time_value" 4 -.IX Item "[ Member data: returns uint8_t * ] -resp_time_value" -.IP "[ Member data: returns uint8_t * ] \-error_threshold" 4 -.IX Item "[ Member data: returns uint8_t * ] -error_threshold" -.PD -Methods: -.IP "[ Member : returns int ] getByDr dr portNum" 4 -.IX Item "[ Member : returns int ] getByDr dr portNum" -.PD 0 -.IP "[ Member : returns int ] setByDr dr portNum" 4 -.IX Item "[ Member : returns int ] setByDr dr portNum" -.IP "[ Member : returns int ] getByLid lid portNum" 4 -.IX Item "[ Member : returns int ] getByLid lid portNum" -.IP "[ Member : returns int ] setByLid lid portNum" 4 -.IX Item "[ Member : returns int ] setByLid lid portNum" -.PD -.Sh "class smSwInfo" -.IX Subsection "class smSwInfo" -.IP "[ Member data: returns ib_net16_t * ] \-lin_cap" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lin_cap" -.PD 0 -.IP "[ Member data: returns ib_net16_t * ] \-rand_cap" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -rand_cap" -.IP "[ Member data: returns ib_net16_t * ] \-mcast_cap" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -mcast_cap" -.IP "[ Member data: returns ib_net16_t * ] \-lin_top" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lin_top" -.IP "[ Member data: returns uint8_t * ] \-def_port" 4 -.IX Item "[ Member data: returns uint8_t * ] -def_port" -.IP "[ Member data: returns uint8_t * ] \-def_mcast_pri_port" 4 -.IX Item "[ Member data: returns uint8_t * ] -def_mcast_pri_port" -.IP "[ Member data: returns uint8_t * ] \-def_mcast_not_port" 4 -.IX Item "[ Member data: returns uint8_t * ] -def_mcast_not_port" -.IP "[ Member data: returns uint8_t * ] \-life_state" 4 -.IX Item "[ Member data: returns uint8_t * ] -life_state" -.IP "[ Member data: returns ib_net16_t * ] \-lids_per_port" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lids_per_port" -.IP "[ Member data: returns ib_net16_t * ] \-enforce_cap" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -enforce_cap" -.IP "[ Member data: returns uint8_t * ] \-flags" 4 -.IX Item "[ Member data: returns uint8_t * ] -flags" -.IP "[ Member : returns int ] getByDr dr" 4 -.IX Item "[ Member : returns int ] getByDr dr" -.IP "[ Member : returns int ] setByDr dr" 4 -.IX Item "[ Member : returns int ] setByDr dr" -.IP "[ Member : returns int ] getByLid lid" 4 -.IX Item "[ Member : returns int ] getByLid lid" -.IP "[ Member : returns int ] setByLid lid" 4 -.IX Item "[ Member : returns int ] setByLid lid" -.PD -.Sh "class smLftBlock" -.IX Subsection "class smLftBlock" -.IP "[ Member data: returns uint8_array_t * ] \-lft" 4 -.IX Item "[ Member data: returns uint8_array_t * ] -lft" -.PD 0 -.IP "[ Member : returns int ] getByDr dr blockNum" 4 -.IX Item "[ Member : returns int ] getByDr dr blockNum" -.IP "[ Member : returns int ] setByDr dr blockNum" 4 -.IX Item "[ Member : returns int ] setByDr dr blockNum" -.IP "[ Member : returns int ] getByLid lid blockNum" 4 -.IX Item "[ Member : returns int ] getByLid lid blockNum" -.IP "[ Member : returns int ] setByLid lid blockNum" 4 -.IX Item "[ Member : returns int ] setByLid lid blockNum" -.PD -.Sh "class smMftBlock" -.IX Subsection "class smMftBlock" -.IP "[ Member data: returns ib_net16_array_t * ] \-mft" 4 -.IX Item "[ Member data: returns ib_net16_array_t * ] -mft" -.PD 0 -.IP "[ Member : returns int ] getByDr dr startLid startPort" 4 -.IX Item "[ Member : returns int ] getByDr dr startLid startPort" -.IP "[ Member : returns int ] setByDr dr startLid startPort" 4 -.IX Item "[ Member : returns int ] setByDr dr startLid startPort" -.IP "[ Member : returns int ] getByLid lid startLid startPort" 4 -.IX Item "[ Member : returns int ] getByLid lid startLid startPort" -.IP "[ Member : returns int ] setByLid lid startLid startPort" 4 -.IX Item "[ Member : returns int ] setByLid lid startLid startPort" -.PD -.Sh "class smGuidInfo" -.IX Subsection "class smGuidInfo" -.IP "[ Member data: returns ib_net64_array_t * ] \-guid" 4 -.IX Item "[ Member data: returns ib_net64_array_t * ] -guid" -.PD 0 -.IP "[ Member : returns int ] getByDr dr blockNum" 4 -.IX Item "[ Member : returns int ] getByDr dr blockNum" -.IP "[ Member : returns int ] setByDr dr blockNum" 4 -.IX Item "[ Member : returns int ] setByDr dr blockNum" -.IP "[ Member : returns int ] getByLid lid blockNum" 4 -.IX Item "[ Member : returns int ] getByLid lid blockNum" -.IP "[ Member : returns int ] setByLid lid blockNum" 4 -.IX Item "[ Member : returns int ] setByLid lid blockNum" -.PD -.Sh "class smPkeyTable" -.IX Subsection "class smPkeyTable" -.IP "[ Member data: returns ib_net16_array_t * ] \-pkey_entry" 4 -.IX Item "[ Member data: returns ib_net16_array_t * ] -pkey_entry" -.PD 0 -.IP "[ Member : returns int ] getByDr dr portNum blockNum" 4 -.IX Item "[ Member : returns int ] getByDr dr portNum blockNum" -.IP "[ Member : returns int ] setByDr dr portNum blockNum" 4 -.IX Item "[ Member : returns int ] setByDr dr portNum blockNum" -.IP "[ Member : returns int ] getByLid lid portNum blockNum" 4 -.IX Item "[ Member : returns int ] getByLid lid portNum blockNum" -.IP "[ Member : returns int ] setByLid lid portNum blockNum" 4 -.IX Item "[ Member : returns int ] setByLid lid portNum blockNum" -.PD -.Sh "class smSlVlTable" -.IX Subsection "class smSlVlTable" -.IP "[ Member data: returns uint8_array_t * ] \-raw_vl_by_sl" 4 -.IX Item "[ Member data: returns uint8_array_t * ] -raw_vl_by_sl" -.PD 0 -.IP "[ Member : returns int ] getByDr dr inPortNum outPortNum" 4 -.IX Item "[ Member : returns int ] getByDr dr inPortNum outPortNum" -.IP "[ Member : returns int ] setByDr dr inPortNum outPortNum" 4 -.IX Item "[ Member : returns int ] setByDr dr inPortNum outPortNum" -.IP "[ Member : returns int ] getByLid lid inPortNum outPortNum" 4 -.IX Item "[ Member : returns int ] getByLid lid inPortNum outPortNum" -.IP "[ Member : returns int ] setByLid lid inPortNum outPortNum" 4 -.IX Item "[ Member : returns int ] setByLid lid inPortNum outPortNum" -.PD -.Sh "class smVlArbTable" -.IX Subsection "class smVlArbTable" -.IP "[ Member data: returns ib_vl_arb_element_t * ] \-vl_entry" 4 -.IX Item "[ Member data: returns ib_vl_arb_element_t * ] -vl_entry" -.PD 0 -.IP "[ Member : returns int ] getByDr dr portNum block" 4 -.IX Item "[ Member : returns int ] getByDr dr portNum block" -.IP "[ Member : returns int ] setByDr dr portNum block" 4 -.IX Item "[ Member : returns int ] setByDr dr portNum block" -.IP "[ Member : returns int ] getByLid lid portNum block" 4 -.IX Item "[ Member : returns int ] getByLid lid portNum block" -.IP "[ Member : returns int ] setByLid lid portNum block" 4 -.IX Item "[ Member : returns int ] setByLid lid portNum block" -.PD -.Sh "class smNodeDesc" -.IX Subsection "class smNodeDesc" -.IP "[ Member data: returns ibsm_node_desc_str_t * ] \-description" 4 -.IX Item "[ Member data: returns ibsm_node_desc_str_t * ] -description" -.PD 0 -.IP "[ Member : returns int ] getByDr dr" 4 -.IX Item "[ Member : returns int ] getByDr dr" -.IP "[ Member : returns int ] setByDr dr" 4 -.IX Item "[ Member : returns int ] setByDr dr" -.IP "[ Member : returns int ] getByLid lid" 4 -.IX Item "[ Member : returns int ] getByLid lid" -.IP "[ Member : returns int ] setByLid lid" 4 -.IX Item "[ Member : returns int ] setByLid lid" -.PD -.Sh "class smSMInfo" -.IX Subsection "class smSMInfo" -.IP "[ Member data: returns ib_net64_t * ] \-guid" 4 -.IX Item "[ Member data: returns ib_net64_t * ] -guid" -.PD 0 -.IP "[ Member data: returns ib_net64_t * ] \-sm_key" 4 -.IX Item "[ Member data: returns ib_net64_t * ] -sm_key" -.IP "[ Member data: returns ib_net32_t * ] \-act_count" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -act_count" -.IP "[ Member data: returns uint8_t * ] \-pri_state" 4 -.IX Item "[ Member data: returns uint8_t * ] -pri_state" -.IP "[ Member : returns int ] getByDr dr" 4 -.IX Item "[ Member : returns int ] getByDr dr" -.IP "[ Member : returns int ] setByDr dr" 4 -.IX Item "[ Member : returns int ] setByDr dr" -.IP "[ Member : returns int ] getByLid lid" 4 -.IX Item "[ Member : returns int ] getByLid lid" -.IP "[ Member : returns int ] setByLid lid" 4 -.IX Item "[ Member : returns int ] setByLid lid" -.PD -.Sh "class smNotice" -.IX Subsection "class smNotice" -.RS 4 -The \s-1NOTICE\s0 attribute is built out of several sub objects -.RE -.IP "[ Member data: returns uint8_t * ] \-generic_type" 4 -.IX Item "[ Member data: returns uint8_t * ] -generic_type" -.PD 0 -.IP "[ Member data: returns ib_net16_t * ] \-issuer_lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -issuer_lid" -.IP "[ Member data: returns ib_net16_t * ] \-toggle_count" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -toggle_count" -.IP "[ Member data: returns ib_gid_t * ] \-issuer_gid" 4 -.IX Item "[ Member data: returns ib_gid_t * ] -issuer_gid" -.IP "[ Member data: returns smNotice_g_or_v * ] \-g_or_v" 4 -.IX Item "[ Member data: returns smNotice_g_or_v * ] -g_or_v" -.IP "[ Member data: returns smNotice_data_details * ] \-data_details" 4 -.IX Item "[ Member data: returns smNotice_data_details * ] -data_details" -.IP "[ Member : returns int ] trapByDr dr" 4 -.IX Item "[ Member : returns int ] trapByDr dr" -.IP "[ Member : returns int ] trapByLid lid" 4 -.IX Item "[ Member : returns int ] trapByLid lid" -.PD -\&\-\-\-\- -.Sp -\fIclass smNotice_g_or_v\fR -.IX Subsection "class smNotice_g_or_v" -.IP "[ Member data: returns smNotice_g_or_v_generic * ] \-generic" 4 -.IX Item "[ Member data: returns smNotice_g_or_v_generic * ] -generic" -.PD 0 -.IP "[ Member data: returns smNotice_g_or_v_vend * ] \-vend" 4 -.IX Item "[ Member data: returns smNotice_g_or_v_vend * ] -vend" -.PD -\&\-\-\-\- -.Sp -\fIclass smNotice_data_details\fR -.IX Subsection "class smNotice_data_details" -.IP "[ Member data: returns smNotice_data_details_raw_data * ] \-raw_data" 4 -.IX Item "[ Member data: returns smNotice_data_details_raw_data * ] -raw_data" -.PD 0 -.IP "[ Member data: returns smNotice_data_details_ntc_64_67 * ] \-ntc_64_67" 4 -.IX Item "[ Member data: returns smNotice_data_details_ntc_64_67 * ] -ntc_64_67" -.IP "[ Member data: returns smNotice_data_details_ntc_128 * ] \-ntc_128" 4 -.IX Item "[ Member data: returns smNotice_data_details_ntc_128 * ] -ntc_128" -.IP "[ Member data: returns smNotice_data_details_ntc_129_131 * ] \-ntc_129_131" 4 -.IX Item "[ Member data: returns smNotice_data_details_ntc_129_131 * ] -ntc_129_131" -.IP "[ Member data: returns smNotice_data_details_ntc_144 * ] \-ntc_144" 4 -.IX Item "[ Member data: returns smNotice_data_details_ntc_144 * ] -ntc_144" -.IP "[ Member data: returns smNotice_data_details_ntc_145 * ] \-ntc_145" 4 -.IX Item "[ Member data: returns smNotice_data_details_ntc_145 * ] -ntc_145" -.IP "[ Member data: returns smNotice_data_details_ntc_256 * ] \-ntc_256" 4 -.IX Item "[ Member data: returns smNotice_data_details_ntc_256 * ] -ntc_256" -.IP "[ Member data: returns smNotice_data_details_ntc_257_258 * ] \-ntc_257_258" 4 -.IX Item "[ Member data: returns smNotice_data_details_ntc_257_258 * ] -ntc_257_258" -.IP "[ Member data: returns smNotice_data_details_ntc_259 * ] \-ntc_259" 4 -.IX Item "[ Member data: returns smNotice_data_details_ntc_259 * ] -ntc_259" -.PD -\&\-\-\-\- -.Sp -\fIclass smNotice_g_or_v_generic\fR -.IX Subsection "class smNotice_g_or_v_generic" -.IP "[ Member data: returns uint8_t * ] \-prod_type_msb" 4 -.IX Item "[ Member data: returns uint8_t * ] -prod_type_msb" -.PD 0 -.IP "[ Member data: returns ib_net16_t * ] \-prod_type_lsb" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -prod_type_lsb" -.IP "[ Member data: returns ib_net16_t * ] \-trap_num" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -trap_num" -.PD -\&\-\-\-\- -.Sp -\fIclass smNotice_g_or_v_vend\fR -.IX Subsection "class smNotice_g_or_v_vend" -.IP "[ Member data: returns uint8_t * ] \-vend_id_msb" 4 -.IX Item "[ Member data: returns uint8_t * ] -vend_id_msb" -.PD 0 -.IP "[ Member data: returns ib_net16_t * ] \-vend_id_lsb" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -vend_id_lsb" -.IP "[ Member data: returns ib_net16_t * ] \-dev_id" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -dev_id" -.PD -\&\-\-\-\- -.Sp -\fIclass smNotice_data_details_raw_data\fR -.IX Subsection "class smNotice_data_details_raw_data" -.IP "[ Member data: returns uint8_array_t * ] \-details" 4 -.IX Item "[ Member data: returns uint8_array_t * ] -details" -\&\-\-\-\- -.Sp -\fIclass smNotice_data_details_ntc_64_67\fR -.IX Subsection "class smNotice_data_details_ntc_64_67" -.IP "[ Member data: returns uint8_array_t * ] \-res" 4 -.IX Item "[ Member data: returns uint8_array_t * ] -res" -.PD 0 -.IP "[ Member data: returns ib_gid_t * ] \-gid" 4 -.IX Item "[ Member data: returns ib_gid_t * ] -gid" -.PD -the Node or Multicast Group that came in/out -.Sp -\&\-\-\-\- -.Sp -\fIclass smNotice_data_details_ntc_128\fR -.IX Subsection "class smNotice_data_details_ntc_128" -.IP "[ Member data: returns ib_net16_t * ] \-sw_lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -sw_lid" -the sw lid of which link state changed -.Sp -\&\-\-\-\- -.Sp -\fIclass smNotice_data_details_ntc_129_131\fR -.IX Subsection "class smNotice_data_details_ntc_129_131" -.IP "[ Member data: returns ib_net16_t * ] \-pad" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -pad" -.PD 0 -.IP "[ Member data: returns ib_net16_t * ] \-lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lid" -.PD -lid and port number of the violation -.IP "[ Member data: returns uint8_t * ] \-port_num" 4 -.IX Item "[ Member data: returns uint8_t * ] -port_num" -\&\-\-\-\- -.Sp -\fIclass smNotice_data_details_ntc_144\fR -.IX Subsection "class smNotice_data_details_ntc_144" -.IP "[ Member data: returns ib_net16_t * ] \-pad1" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -pad1" -.PD 0 -.IP "[ Member data: returns ib_net16_t * ] \-lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lid" -.PD -lid where capability mask changed -.IP "[ Member data: returns ib_net16_t * ] \-pad2" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -pad2" -.PD 0 -.IP "[ Member data: returns ib_net32_t * ] \-new_cap_mask" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -new_cap_mask" -.PD -new capability mask -.Sp -\&\-\-\-\- -.Sp -\fIclass smNotice_data_details_ntc_145\fR -.IX Subsection "class smNotice_data_details_ntc_145" -.IP "[ Member data: returns ib_net16_t * ] \-pad1" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -pad1" -.PD 0 -.IP "[ Member data: returns ib_net16_t * ] \-lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lid" -.PD -lid where sys guid changed -.IP "[ Member data: returns ib_net16_t * ] \-pad2" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -pad2" -.PD 0 -.IP "[ Member data: returns ib_net64_t * ] \-new_sys_guid" 4 -.IX Item "[ Member data: returns ib_net64_t * ] -new_sys_guid" -.PD -new system image guid -.Sp -\&\-\-\-\- -.Sp -\fIclass smNotice_data_details_ntc_256\fR -.IX Subsection "class smNotice_data_details_ntc_256" -.IP "[ Member data: returns ib_net16_t * ] \-pad1" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -pad1" -.PD 0 -.IP "[ Member data: returns ib_net16_t * ] \-lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lid" -.IP "[ Member data: returns ib_net16_t * ] \-pad2" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -pad2" -.IP "[ Member data: returns uint8_t * ] \-method" 4 -.IX Item "[ Member data: returns uint8_t * ] -method" -.IP "[ Member data: returns uint8_t * ] \-pad3" 4 -.IX Item "[ Member data: returns uint8_t * ] -pad3" -.IP "[ Member data: returns ib_net16_t * ] \-attr_id" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -attr_id" -.IP "[ Member data: returns ib_net32_t * ] \-attr_mod" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -attr_mod" -.IP "[ Member data: returns ib_net64_t * ] \-mkey" 4 -.IX Item "[ Member data: returns ib_net64_t * ] -mkey" -.IP "[ Member data: returns uint8_t * ] \-dr_slid" 4 -.IX Item "[ Member data: returns uint8_t * ] -dr_slid" -.IP "[ Member data: returns uint8_t * ] \-dr_trunc_hop" 4 -.IX Item "[ Member data: returns uint8_t * ] -dr_trunc_hop" -.IP "[ Member data: returns uint8_array_t * ] \-dr_rtn_path" 4 -.IX Item "[ Member data: returns uint8_array_t * ] -dr_rtn_path" -.PD -\&\-\-\-\- -.Sp -\fIclass smNotice_data_details_ntc_257_258\fR -.IX Subsection "class smNotice_data_details_ntc_257_258" -.IP "[ Member data: returns ib_net16_t * ] \-pad1" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -pad1" -.PD 0 -.IP "[ Member data: returns ib_net16_t * ] \-lid1" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lid1" -.IP "[ Member data: returns ib_net16_t * ] \-lid2" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lid2" -.IP "[ Member data: returns ib_net32_t * ] \-key" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -key" -.IP "[ Member data: returns uint8_t * ] \-sl" 4 -.IX Item "[ Member data: returns uint8_t * ] -sl" -.IP "[ Member data: returns ib_net32_t * ] \-qp1" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -qp1" -.IP "[ Member data: returns ib_net32_t * ] \-qp2" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -qp2" -.IP "[ Member data: returns ib_gid_t * ] \-gid1" 4 -.IX Item "[ Member data: returns ib_gid_t * ] -gid1" -.IP "[ Member data: returns ib_gid_t * ] \-gid2" 4 -.IX Item "[ Member data: returns ib_gid_t * ] -gid2" -.PD -\&\-\-\-\- -.Sp -\fIclass smNotice_data_details_ntc_259\fR -.IX Subsection "class smNotice_data_details_ntc_259" -.IP "[ Member data: returns ib_net16_t * ] \-data_valid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -data_valid" -.PD 0 -.IP "[ Member data: returns ib_net16_t * ] \-lid1" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lid1" -.IP "[ Member data: returns ib_net16_t * ] \-lid2" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lid2" -.IP "[ Member data: returns ib_net32_t * ] \-key" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -key" -.IP "[ Member data: returns uint8_t * ] \-sl" 4 -.IX Item "[ Member data: returns uint8_t * ] -sl" -.IP "[ Member data: returns ib_net32_t * ] \-qp1" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -qp1" -.IP "[ Member data: returns uint8_t * ] \-qp2_msb" 4 -.IX Item "[ Member data: returns uint8_t * ] -qp2_msb" -.IP "[ Member data: returns ib_net16_t * ] \-qp2_lsb" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -qp2_lsb" -.IP "[ Member data: returns ib_gid_t * ] \-gid1" 4 -.IX Item "[ Member data: returns ib_gid_t * ] -gid1" -.IP "[ Member data: returns ib_gid_t * ] \-gid2" 4 -.IX Item "[ Member data: returns ib_gid_t * ] -gid2" -.IP "[ Member data: returns ib_net16_t * ] \-sw_lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -sw_lid" -.IP "[ Member data: returns uint8_t * ] \-port_no" 4 -.IX Item "[ Member data: returns uint8_t * ] -port_no" -.PD -.SH "IBCR Functions" -.IX Header "IBCR Functions" -Provides vendor specific access to the device internal coniguration space -.Sp -This section provide the details about the functions \s-1IBCR\s0 exposes. -They all return 0 on succes. -.IP "[ returns int ] crMultiMaxGet" 4 -.IX Item "[ returns int ] crMultiMaxGet" -.PD 0 -.IP "[ returns int ] crRead lid address" 4 -.IX Item "[ returns int ] crRead lid address" -.IP "[ returns int ] crWrite lid data address" 4 -.IX Item "[ returns int ] crWrite lid data address" -.IP "[ returns int ] crReadMulti num lid_list address" 4 -.IX Item "[ returns int ] crReadMulti num lid_list address" -.IP "[ returns int ] crWriteMulti num lid_list data address" 4 -.IX Item "[ returns int ] crWriteMulti num lid_list data address" -.PD -.SH "IB Vendor Specific Functions" -.IX Header "IB Vendor Specific Functions" -\&\s-1IBVS\s0 stands for Vendor Specific MADs. -.Sp -This section provide the details about the functions \s-1IBVS\s0 exposes. -They all return 0 on succes. -.IP "[ returns int ] vsMultiMaxGet" 4 -.IX Item "[ returns int ] vsMultiMaxGet" -.PD 0 -.IP "[ returns int ] vsCpuRead lid size cpu_traget_size address" 4 -.IX Item "[ returns int ] vsCpuRead lid size cpu_traget_size address" -.IP "[ returns int ] vsCpuWrite lid size cpu_traget_size data address" 4 -.IX Item "[ returns int ] vsCpuWrite lid size cpu_traget_size data address" -.IP "[ returns int ] vsI2cRead lid port_num device_id size address" 4 -.IX Item "[ returns int ] vsI2cRead lid port_num device_id size address" -.IP "[ returns int ] vsI2cWrite lid port_num device_id size address data" 4 -.IX Item "[ returns int ] vsI2cWrite lid port_num device_id size address data" -.IP "[ returns int ] vsI2cReadMulti num lid_list port_num device_id size address" 4 -.IX Item "[ returns int ] vsI2cReadMulti num lid_list port_num device_id size address" -.IP "[ returns int ] vsI2cWriteMulti num lid_list port_num device_id size address data" 4 -.IX Item "[ returns int ] vsI2cWriteMulti num lid_list port_num device_id size address data" -.IP "[ returns int ] vsGpioRead lid" 4 -.IX Item "[ returns int ] vsGpioRead lid" -.IP "[ returns int ] vsGpioWrite lid gpio_mask gpio_data" 4 -.IX Item "[ returns int ] vsGpioWrite lid gpio_mask gpio_data" -.IP "[ returns int ] vsSWReset num lid_list" 4 -.IX Item "[ returns int ] vsSWReset num lid_list" -.IP "[ returns int ] vsFlashStartMulti num lid_list last size address data" 4 -.IX Item "[ returns int ] vsFlashStartMulti num lid_list last size address data" -.IP "[ returns int ] vsFlashStopMulti num lid_list force" 4 -.IX Item "[ returns int ] vsFlashStopMulti num lid_list force" -.IP "[ returns int ] vsFlashSetBankMulti num lid_list address" 4 -.IX Item "[ returns int ] vsFlashSetBankMulti num lid_list address" -.IP "[ returns int ] vsFlashEraseSectorMulti num lid_list address" 4 -.IX Item "[ returns int ] vsFlashEraseSectorMulti num lid_list address" -.IP "[ returns int ] vsFlashReadSectorMulti num lid_list size address" 4 -.IX Item "[ returns int ] vsFlashReadSectorMulti num lid_list size address" -.IP "[ returns int ] vsFlashWriteSectorMulti num lid_list size address data" 4 -.IX Item "[ returns int ] vsFlashWriteSectorMulti num lid_list size address data" -.IP "[ returns int ] vsMirrorRead lid" 4 -.IX Item "[ returns int ] vsMirrorRead lid" -.IP "[ returns int ] vsMirrorWrite lid rx_mirror tx_mirror" 4 -.IX Item "[ returns int ] vsMirrorWrite lid rx_mirror tx_mirror" -.PD -.SH "IBBBM Functions" -.IX Header "IBBBM Functions" -This section provide the details about the functions \s-1IBBBM\s0 exposes. -They all return 0 on succes. -.IP "[ returns int ] bbmVpdRead lid vpd_device_selector bytes_num offset" 4 -.IX Item "[ returns int ] bbmVpdRead lid vpd_device_selector bytes_num offset" -.PD 0 -.IP "[ returns int ] bbmVpdWrite lid vpd_device_selector bytes_num offset p_data" 4 -.IX Item "[ returns int ] bbmVpdWrite lid vpd_device_selector bytes_num offset p_data" -.IP "[ returns int ] bbmVSDRead lid" 4 -.IX Item "[ returns int ] bbmVSDRead lid" -.IP "[ returns int ] bbmBSNRead lid" 4 -.IX Item "[ returns int ] bbmBSNRead lid" -.IP "[ returns int ] bbmModRead lid" 4 -.IX Item "[ returns int ] bbmModRead lid" -.IP "[ returns int ] bbmChaRead lid" 4 -.IX Item "[ returns int ] bbmChaRead lid" -.IP "[ returns int ] bbmFWVerRead lid" 4 -.IX Item "[ returns int ] bbmFWVerRead lid" -.PD -.SH "AUTHOR" -.IX Header "AUTHOR" -Eitan Zahavi, Mellanox Technologies \s-1LTD\s0, eitan@mellanox.co.il diff --git a/ibmgtsim/doc/IBMgtSim.1 b/ibmgtsim/doc/IBMgtSim.1 deleted file mode 100644 index e8ac646..0000000 --- a/ibmgtsim/doc/IBMgtSim.1 +++ /dev/null @@ -1,216 +0,0 @@ -.\" 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 "IBMGTSIM 1" -.TH IBMGTSIM 1 "2008-06-16" "IBMGTSIM 1.0" "IB MANAGEMENT SIMULATOR" -.SH "NAME" -\&\fBIBMgtSim\fR \- Infiniband Management Simulator -.SH "SYNOPSYS" -.IX Header "SYNOPSYS" -IBMgtSim [\-h] [\-V mod\-verb\-pair\-list] [\-l log\-file] [\-p server\-port] - [\-w num\-threads] [\-f flow\-tcl\-file] [\-s seed] \-t topology -.SH "DESCRIPTION" -.IX Header "DESCRIPTION" -Simulates the Fabric as defined by the given topology file and start a server to handle \s-1MAD\s0 requests from clients like OpenSM. -.SH "ARGUMENTS" -.IX Header "ARGUMENTS" -.RE -.IP "\-t topology" -.IX Item "-t topology" -A topology file describing the fabric to be simulated (see \fBibdm-topo-file\fR) -.SH "OPTIONS" -.IX Header "OPTIONS" -.RE -.IP "\-s seed" -.IX Item "-s seed" -The seed to be used for random number generation. -.RE -.IP "\-f flow-tcl-file" -.IX Item "-f flow-tcl-file" -A tcl file to be sourced after the fabric is setup. -.RE -.IP "\-l log-file" -.IX Item "-l log-file" -Set the log file of the simulator (default is /tmp/ibsim.log) -.RE -.IP "\-p server-port" -.IX Item "-p server-port" -Set the port number the server attaches to (default 46517) -.RE -.IP "\-w num-threads" -.IX Item "-w num-threads" -The number of threads processing the mads -.RE -.IP "\-V " -.IX Item "-V " -Provides a fine grain control over the log file verbosity. Given list of pairs of simulator software module names and their verbosity levels \- every module is separatly controlled. The first value (missing module name) is controlling the default verbosity for all un-explicitly set modules. -.Sp -.RS 4 -Current Verbosity Levels: -.Sp -.Vb 13 -\& MsgShowFatal = 0x01; -\& MsgShowError = 0x02; -\& MsgShowWarning= 0x04; -\& MsgShowInfo = 0x08; -\& MsgShowVerbose= 0x10; -\& MsgShowContext= 0x20; -\& MsgShowSource = 0x40; -\& MsgShowTime = 0x80; -\& MsgShowModule = 0x100; -\& MsgShowMads = 0x200; -\& MsgShowFrames = 0x400; -\& MsgShowAll = 0xffff; -\& MsgDefault = 0x62f; -.Ve -.Sp -Software Modules: -.Sp -client, server, dispatcher, node, sma, lftMad, mftMad, vlArbMad, pKeyMad, portInfoMad -.Sp -Examples \-V flag values might be: -.Sp -.Vb 1 -\& -V 0xffff = Full verbosity on all modules -.Ve -.Sp -.Vb 3 -\& -V '0x3 server 0x6f2 sma 0xffff' = Only fatal and error for all modules -\& full verbosity for the SMA module and default verbosity for the -\& Server module. -.Ve -.RE -.RE -.IP "\-h" -.IX Item "-h" -This help message -.SH "AUTHOR" -.IX Header "AUTHOR" -Eitan Zahavi, Mellanox Technologies \s-1LTD\s0, eitan@mellanox.co.il diff --git a/ibmgtsim/doc/RunSimTest.1 b/ibmgtsim/doc/RunSimTest.1 deleted file mode 100644 index 97db302..0000000 --- a/ibmgtsim/doc/RunSimTest.1 +++ /dev/null @@ -1,185 +0,0 @@ -.\" 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 "RUNSIMTEST 1" -.TH RUNSIMTEST 1 "2008-06-16" "IBMGTSIM 1.0" "IB MANAGEMENT SIMULATOR" -.SH "NAME" -\&\fBRunSimTest\fR \- Run a test over the IB management simulator -.SH "SYNOPSYS" -.IX Header "SYNOPSYS" -RunSimTest [\-h] [\-o osm\-path][\-f flow\-file][\-c checker\-file] - \-t topology [\-n osm\-node\-name][\-p osm\-port\-num][\-s seed][\-V verbosity\-list] -.PP -This command starts the simulator and runs the the given test flow -on top of it. Then it runs the checker flow. The default test flow starts -OpenSM and wait for Subnet-Up event. User given flow can make use of the -provided facilities for starting OpenSM and tracking it events. -.SH "ARGUMENTS" -.IX Header "ARGUMENTS" -.IP "\-t topology" 4 -.IX Item "-t topology" -A topology file describing the fabric (see \fBibdm-topo-file\fR) -.SH "OPTIONS" -.IX Header "OPTIONS" -.IP "\-f flow-file" 4 -.IX Item "-f flow-file" -A tcl file sourced by the sim after the fabric is setup. See following discussion about the provided \s-1API\s0 and global variables that are available for the flow. -.IP "\-c checker-file" 4 -.IX Item "-c checker-file" -A tcl file defining when osm completed and what checks are requierd to validate it's outputs. The procedure named 'checker' is invoked by the test flow to start the checking flow. The default flow waits for OpenSM to complete setup the fabric and run ibdmchk. -.IP "\-o osm-path" 4 -.IX Item "-o osm-path" -Full path to OpenSM (/usr/local/ofed/osm\-sim/bin/opensm). \s-1NOTE\s0 OpenSM should be compiled with \-\-with\-osmv=sim to be able to connect to the simulator. -.IP "\-n osm-node" 4 -.IX Item "-n osm-node" -Topology file node name the \s-1SM\s0 runs on (default H\-1/U1) -.IP "\-p port-num" 4 -.IX Item "-p port-num" -Port number the \s-1SM\s0 attaches to (default 1). -.IP "\-s seed" 4 -.IX Item "-s seed" -Random seed to be used. -.IP "\-V verbosity-list" 4 -.IX Item "-V verbosity-list" -Module verbosity list. The first should be the global verbosity. See IBMgtSim for full list of modules. -Examples: -.Sp -.Vb 4 -\& -V 0xffff = Full verbosity on all modules -\& -V '"0x3 server 0x6f2 sma 0xffff"' = Only fatal and error -\& for all modules full verbosity for the SMA module and default -\& verbosity for the Server module. -.Ve -.IP "\-h" 4 -.IX Item "-h" -This help message -.SH "AUTHOR" -.IX Header "AUTHOR" -Eitan Zahavi, Mellanox Technologies \s-1LTD\s0, eitan@mellanox.co.il diff --git a/ibmgtsim/doc/ibmsquit.1 b/ibmgtsim/doc/ibmsquit.1 deleted file mode 100644 index 2107568..0000000 --- a/ibmgtsim/doc/ibmsquit.1 +++ /dev/null @@ -1,151 +0,0 @@ -.\" 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 "IBMSQUIT 1" -.TH IBMSQUIT 1 "2008-06-16" "IBMGTSIM 1.0" "IB MANAGEMENT SIMULATOR" -.SH "NAME" -\&\fBibmsquit\fR \- Quit the management simulator -.SH "SYNOPSYS" -.IX Header "SYNOPSYS" -ibmsquit -.SH "DESCRIPTION" -.IX Header "DESCRIPTION" -Causes the \s-1IB\s0 management simulator at the given host and port to quit -.SH "ARGUMENTS" -.IX Header "ARGUMENTS" -.IP "" 4 -.IX Item "" -Host name or \s-1IP\s0 where the simulator is being run. -.IP "" 4 -.IX Item "" -The \s-1TCP/IP\s0 port number the simulator is listening on -.SH "AUTHOR" -.IX Header "AUTHOR" -Eitan Zahavi, Mellanox Technologies \s-1LTD\s0, eitan@mellanox.co.il diff --git a/ibmgtsim/doc/ibmssh.1 b/ibmgtsim/doc/ibmssh.1 deleted file mode 100644 index 1663514..0000000 --- a/ibmgtsim/doc/ibmssh.1 +++ /dev/null @@ -1,696 +0,0 @@ -.\" 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 "IBMSSH 1" -.TH IBMSSH 1 "2008-06-16" "IBMGTSIM 1.0" "IB MANAGEMENT SIMULATOR" -.SH "NAME" -\&\fBibmssh\fR IB MANAGEMENT SIMULATOR \- Extentended TCL shell -.SH "DESCRIPTION" -.IX Header "DESCRIPTION" -\&\fBibmssh\fR is a \s-1TCL\s0 shell extended with interface for the \s-1IB\s0 Management Simulator facilities. -Normally you will not run this shell directly \- but instead it will be invoked by the \fBIBMgtSim\fR utility. -However, in order to write simulation flows that interacts closely with the simulated model, a simulation flow should be provided. This flow is loaded by IBMgtSim and excersize the \s-1API\s0 provided by this shell. -.PP -The following sub sections provide detailed definition for those objects and \s-1API\s0. -.SH "IBMgtSim Constants" -.IX Header "IBMgtSim Constants" -These constants are provided by IBMgtSim -.Sh "Massage Manager Log Verbosity Flags" -.IX Subsection "Massage Manager Log Verbosity Flags" -.ie n .IP "[ Constant : int ] $MsgShowFatal = 0x01" 4 -.el .IP "[ Constant : int ] \f(CW$MsgShowFatal\fR = 0x01" 4 -.IX Item "[ Constant : int ] $MsgShowFatal = 0x01" -.PD 0 -.ie n .IP "[ Constant : int ] $MsgShowError = 0x02" 4 -.el .IP "[ Constant : int ] \f(CW$MsgShowError\fR = 0x02" 4 -.IX Item "[ Constant : int ] $MsgShowError = 0x02" -.ie n .IP "[ Constant : int ] $MsgShowWarning = 0x04" 4 -.el .IP "[ Constant : int ] \f(CW$MsgShowWarning\fR = 0x04" 4 -.IX Item "[ Constant : int ] $MsgShowWarning = 0x04" -.ie n .IP "[ Constant : int ] $MsgShowInfo = 0x08" 4 -.el .IP "[ Constant : int ] \f(CW$MsgShowInfo\fR = 0x08" 4 -.IX Item "[ Constant : int ] $MsgShowInfo = 0x08" -.ie n .IP "[ Constant : int ] $MsgShowVerbose = 0x10" 4 -.el .IP "[ Constant : int ] \f(CW$MsgShowVerbose\fR = 0x10" 4 -.IX Item "[ Constant : int ] $MsgShowVerbose = 0x10" -.ie n .IP "[ Constant : int ] $MsgShowContext = 0x20" 4 -.el .IP "[ Constant : int ] \f(CW$MsgShowContext\fR = 0x20" 4 -.IX Item "[ Constant : int ] $MsgShowContext = 0x20" -.ie n .IP "[ Constant : int ] $MsgShowSource = 0x40" 4 -.el .IP "[ Constant : int ] \f(CW$MsgShowSource\fR = 0x40" 4 -.IX Item "[ Constant : int ] $MsgShowSource = 0x40" -.ie n .IP "[ Constant : int ] $MsgShowTime = 0x80" 4 -.el .IP "[ Constant : int ] \f(CW$MsgShowTime\fR = 0x80" 4 -.IX Item "[ Constant : int ] $MsgShowTime = 0x80" -.ie n .IP "[ Constant : int ] $MsgShowModule = 0x100" 4 -.el .IP "[ Constant : int ] \f(CW$MsgShowModule\fR = 0x100" 4 -.IX Item "[ Constant : int ] $MsgShowModule = 0x100" -.ie n .IP "[ Constant : int ] $MsgShowMads = 0x200" 4 -.el .IP "[ Constant : int ] \f(CW$MsgShowMads\fR = 0x200" 4 -.IX Item "[ Constant : int ] $MsgShowMads = 0x200" -.ie n .IP "[ Constant : int ] $MsgShowFrames = 0x400" 4 -.el .IP "[ Constant : int ] \f(CW$MsgShowFrames\fR = 0x400" 4 -.IX Item "[ Constant : int ] $MsgShowFrames = 0x400" -.ie n .IP "[ Constant : int ] $MsgShowAll = 0xffff" 4 -.el .IP "[ Constant : int ] \f(CW$MsgShowAll\fR = 0xffff" 4 -.IX Item "[ Constant : int ] $MsgShowAll = 0xffff" -.ie n .IP "[ Constant : int ] $MsgDefault = 0x62f" 4 -.el .IP "[ Constant : int ] \f(CW$MsgDefault\fR = 0x62f" 4 -.IX Item "[ Constant : int ] $MsgDefault = 0x62f" -.PD -.SH "Message Manager Objects" -.IX Header "Message Manager Objects" -.Sh "class msgManager" -.IX Subsection "class msgManager" -.RS 4 -This is the Message Manager class -.RE -.IP "[ Member : returns int ] getVerbLevel ?module?" 4 -.IX Item "[ Member : returns int ] getVerbLevel ?module?" -.PD 0 -.IP "[ Member : returns int ] clrVerbLevel ?module?" 4 -.IX Item "[ Member : returns int ] clrVerbLevel ?module?" -.IP "[ Member : returns void ] setVerbLevel vl ?module?" 4 -.IX Item "[ Member : returns void ] setVerbLevel vl ?module?" -.IP "[ Member : returns int ] outstandingMsgCount ?vl?" 4 -.IX Item "[ Member : returns int ] outstandingMsgCount ?vl?" -.IP "[ Member : returns string ] outstandingMsgs ?vl?" 4 -.IX Item "[ Member : returns string ] outstandingMsgs ?vl?" -.IP "[ Member : returns string ] getNextMessage" 4 -.IX Item "[ Member : returns string ] getNextMessage" -.IP "[ Member : returns void ] nullOutstandingMsgs" 4 -.IX Item "[ Member : returns void ] nullOutstandingMsgs" -.IP "[ Member : returns int ] setLogFile fileName" 4 -.IX Item "[ Member : returns int ] setLogFile fileName" -.PD -.SH "Random Manager Functions" -.IX Header "Random Manager Functions" -.RE -.IP "[ returns float ] rmRand" -.IX Item "[ returns float ] rmRand" -obtain a random number in the range 0.0 \- 1.0 -.RE -.IP "[ returns int ] rmSeed seed" -.IX Item "[ returns int ] rmSeed seed" -initialize the seed for the random manager -.Sh "class ib_node_info_t" -.IX Subsection "class ib_node_info_t" -.IP "[ Member data: returns uint8_t * ] \-base_version" 4 -.IX Item "[ Member data: returns uint8_t * ] -base_version" -.PD 0 -.IP "[ Member data: returns uint8_t * ] \-class_version" 4 -.IX Item "[ Member data: returns uint8_t * ] -class_version" -.IP "[ Member data: returns uint8_t * ] \-node_type" 4 -.IX Item "[ Member data: returns uint8_t * ] -node_type" -.IP "[ Member data: returns uint8_t * ] \-num_ports" 4 -.IX Item "[ Member data: returns uint8_t * ] -num_ports" -.IP "[ Member data: returns ib_net64_t * ] \-sys_guid" 4 -.IX Item "[ Member data: returns ib_net64_t * ] -sys_guid" -.IP "[ Member data: returns ib_net64_t * ] \-node_guid" 4 -.IX Item "[ Member data: returns ib_net64_t * ] -node_guid" -.IP "[ Member data: returns ib_net64_t * ] \-port_guid" 4 -.IX Item "[ Member data: returns ib_net64_t * ] -port_guid" -.IP "[ Member data: returns ib_net16_t * ] \-partition_cap" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -partition_cap" -.IP "[ Member data: returns ib_net16_t * ] \-device_id" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -device_id" -.IP "[ Member data: returns ib_net32_t * ] \-revision" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -revision" -.IP "[ Member data: returns ib_net32_t * ] \-port_num_vendor_id" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -port_num_vendor_id" -.PD -.Sh "class ib_switch_info_t" -.IX Subsection "class ib_switch_info_t" -.IP "[ Member data: returns ib_net16_t * ] \-lin_cap" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lin_cap" -.PD 0 -.IP "[ Member data: returns ib_net16_t * ] \-rand_cap" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -rand_cap" -.IP "[ Member data: returns ib_net16_t * ] \-mcast_cap" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -mcast_cap" -.IP "[ Member data: returns ib_net16_t * ] \-lin_top" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lin_top" -.IP "[ Member data: returns uint8_t * ] \-def_port" 4 -.IX Item "[ Member data: returns uint8_t * ] -def_port" -.IP "[ Member data: returns uint8_t * ] \-def_mcast_pri_port" 4 -.IX Item "[ Member data: returns uint8_t * ] -def_mcast_pri_port" -.IP "[ Member data: returns uint8_t * ] \-def_mcast_not_port" 4 -.IX Item "[ Member data: returns uint8_t * ] -def_mcast_not_port" -.IP "[ Member data: returns uint8_t * ] \-life_state" 4 -.IX Item "[ Member data: returns uint8_t * ] -life_state" -.IP "[ Member data: returns ib_net16_t * ] \-lids_per_port" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lids_per_port" -.IP "[ Member data: returns ib_net16_t * ] \-enforce_cap" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -enforce_cap" -.IP "[ Member data: returns uint8_t * ] \-flags" 4 -.IX Item "[ Member data: returns uint8_t * ] -flags" -.PD -.Sh "class ib_port_info_t" -.IX Subsection "class ib_port_info_t" -.IP "[ Member data: returns ib_net64_t * ] \-m_key" 4 -.IX Item "[ Member data: returns ib_net64_t * ] -m_key" -.PD 0 -.IP "[ Member data: returns ib_net64_t * ] \-subnet_prefix" 4 -.IX Item "[ Member data: returns ib_net64_t * ] -subnet_prefix" -.IP "[ Member data: returns ib_net16_t * ] \-base_lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -base_lid" -.IP "[ Member data: returns ib_net16_t * ] \-master_sm_base_lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -master_sm_base_lid" -.IP "[ Member data: returns ib_net32_t * ] \-capability_mask" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -capability_mask" -.IP "[ Member data: returns ib_net16_t * ] \-diag_code" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -diag_code" -.IP "[ Member data: returns ib_net16_t * ] \-m_key_lease_period" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -m_key_lease_period" -.IP "[ Member data: returns uint8_t * ] \-local_port_num" 4 -.IX Item "[ Member data: returns uint8_t * ] -local_port_num" -.IP "[ Member data: returns uint8_t * ] \-link_width_enabled" 4 -.IX Item "[ Member data: returns uint8_t * ] -link_width_enabled" -.IP "[ Member data: returns uint8_t * ] \-link_width_supported" 4 -.IX Item "[ Member data: returns uint8_t * ] -link_width_supported" -.IP "[ Member data: returns uint8_t * ] \-link_width_active" 4 -.IX Item "[ Member data: returns uint8_t * ] -link_width_active" -.IP "[ Member data: returns uint8_t * ] \-state_info1" 4 -.IX Item "[ Member data: returns uint8_t * ] -state_info1" -.IP "[ Member data: returns uint8_t * ] \-state_info2" 4 -.IX Item "[ Member data: returns uint8_t * ] -state_info2" -.PD -LinkSpeedSupported and PortState -.IP "[ Member data: returns uint8_t * ] \-mkey_lmc" 4 -.IX Item "[ Member data: returns uint8_t * ] -mkey_lmc" -PortPhysState and LinkDownDefaultState -.IP "[ Member data: returns uint8_t * ] \-link_speed" 4 -.IX Item "[ Member data: returns uint8_t * ] -link_speed" -.PD 0 -.IP "[ Member data: returns uint8_t * ] \-mtu_smsl" 4 -.IX Item "[ Member data: returns uint8_t * ] -mtu_smsl" -.PD -LinkSpeedEnabled and LinkSpeedActive -.IP "[ Member data: returns uint8_t * ] \-vl_cap" 4 -.IX Item "[ Member data: returns uint8_t * ] -vl_cap" -.PD 0 -.IP "[ Member data: returns uint8_t * ] \-vl_high_limit" 4 -.IX Item "[ Member data: returns uint8_t * ] -vl_high_limit" -.PD -VlCap and InitType -.IP "[ Member data: returns uint8_t * ] \-vl_arb_high_cap" 4 -.IX Item "[ Member data: returns uint8_t * ] -vl_arb_high_cap" -.PD 0 -.IP "[ Member data: returns uint8_t * ] \-vl_arb_low_cap" 4 -.IX Item "[ Member data: returns uint8_t * ] -vl_arb_low_cap" -.IP "[ Member data: returns uint8_t * ] \-mtu_cap" 4 -.IX Item "[ Member data: returns uint8_t * ] -mtu_cap" -.IP "[ Member data: returns uint8_t * ] \-vl_stall_life" 4 -.IX Item "[ Member data: returns uint8_t * ] -vl_stall_life" -.IP "[ Member data: returns uint8_t * ] \-vl_enforce" 4 -.IX Item "[ Member data: returns uint8_t * ] -vl_enforce" -.IP "[ Member data: returns ib_net16_t * ] \-m_key_violations" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -m_key_violations" -.IP "[ Member data: returns ib_net16_t * ] \-p_key_violations" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -p_key_violations" -.IP "[ Member data: returns ib_net16_t * ] \-q_key_violations" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -q_key_violations" -.IP "[ Member data: returns uint8_t * ] \-guid_cap" 4 -.IX Item "[ Member data: returns uint8_t * ] -guid_cap" -.IP "[ Member data: returns uint8_t * ] \-subnet_timeout" 4 -.IX Item "[ Member data: returns uint8_t * ] -subnet_timeout" -.IP "[ Member data: returns uint8_t * ] \-resp_time_value" 4 -.IX Item "[ Member data: returns uint8_t * ] -resp_time_value" -.IP "[ Member data: returns uint8_t * ] \-error_threshold" 4 -.IX Item "[ Member data: returns uint8_t * ] -error_threshold" -.PD -.Sh "class ib_node_desc_t" -.IX Subsection "class ib_node_desc_t" -.IP "[ Member data: returns uint8_array_t * ] \-description" 4 -.IX Item "[ Member data: returns uint8_array_t * ] -description" -Node String is an array of \s-1UTF\-8\s0 character that describes the node in text format -Note that this string is \s-1NOT\s0 \s-1NULL\s0 \s-1TERMINATED\s0! -.Sh "class ib_lft_record_t" -.IX Subsection "class ib_lft_record_t" -.IP "[ Member data: returns ib_net16_t * ] \-lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lid" -.PD 0 -.IP "[ Member data: returns ib_net16_t * ] \-block_num" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -block_num" -.IP "[ Member data: returns uint32_t * ] \-resv0" 4 -.IX Item "[ Member data: returns uint32_t * ] -resv0" -.IP "[ Member data: returns uint8_array_t * ] \-lft" 4 -.IX Item "[ Member data: returns uint8_array_t * ] -lft" -.PD -.Sh "class ib_pm_counters_t" -.IX Subsection "class ib_pm_counters_t" -.IP "[ Member data: returns ib_mad_t * ] \-mad_header" 4 -.IX Item "[ Member data: returns ib_mad_t * ] -mad_header" -.PD 0 -.IP "[ Member data: returns uint32_array_t * ] \-reserved0" 4 -.IX Item "[ Member data: returns uint32_array_t * ] -reserved0" -.IP "[ Member data: returns uint8_t * ] \-reserved1" 4 -.IX Item "[ Member data: returns uint8_t * ] -reserved1" -.IP "[ Member data: returns uint8_t * ] \-port_select" 4 -.IX Item "[ Member data: returns uint8_t * ] -port_select" -.IP "[ Member data: returns ib_net16_t * ] \-counter_select" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -counter_select" -.IP "[ Member data: returns ib_net16_t * ] \-symbol_error_counter" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -symbol_error_counter" -.IP "[ Member data: returns uint8_t * ] \-link_error_recovery_counter" 4 -.IX Item "[ Member data: returns uint8_t * ] -link_error_recovery_counter" -.IP "[ Member data: returns uint8_t * ] \-link_down_counter" 4 -.IX Item "[ Member data: returns uint8_t * ] -link_down_counter" -.IP "[ Member data: returns ib_net16_t * ] \-port_rcv_errors" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -port_rcv_errors" -.IP "[ Member data: returns ib_net16_t * ] \-port_rcv_remote_physical_errors" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -port_rcv_remote_physical_errors" -.IP "[ Member data: returns ib_net16_t * ] \-port_rcv_switch_relay_errors" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -port_rcv_switch_relay_errors" -.IP "[ Member data: returns ib_net16_t * ] \-port_xmit_discard" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -port_xmit_discard" -.IP "[ Member data: returns uint8_t * ] \-port_xmit_constraint_errors" 4 -.IX Item "[ Member data: returns uint8_t * ] -port_xmit_constraint_errors" -.IP "[ Member data: returns uint8_t * ] \-port_rcv_constraint_errors" 4 -.IX Item "[ Member data: returns uint8_t * ] -port_rcv_constraint_errors" -.IP "[ Member data: returns uint8_t * ] \-reserved2" 4 -.IX Item "[ Member data: returns uint8_t * ] -reserved2" -.IP "[ Member data: returns uint8_t * ] \-lli_errors_exc_buf_errors" 4 -.IX Item "[ Member data: returns uint8_t * ] -lli_errors_exc_buf_errors" -.IP "[ Member data: returns ib_net16_t * ] \-reserved3" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -reserved3" -.IP "[ Member data: returns ib_net16_t * ] \-vl15_dropped" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -vl15_dropped" -.IP "[ Member data: returns ib_net32_t * ] \-port_xmit_data" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -port_xmit_data" -.IP "[ Member data: returns ib_net32_t * ] \-port_rcv_data" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -port_rcv_data" -.IP "[ Member data: returns ib_net32_t * ] \-port_xmit_pkts" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -port_xmit_pkts" -.IP "[ Member data: returns ib_net32_t * ] \-port_rcv_pkts" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -port_rcv_pkts" -.IP "[ Member data: returns uint32_array_t * ] \-reserved5" 4 -.IX Item "[ Member data: returns uint32_array_t * ] -reserved5" -.PD -.SH "IBMgtSim Simulator Objects" -.IX Header "IBMgtSim Simulator Objects" -.Sh "class IBMgtSim" -.IX Subsection "class IBMgtSim" -.IP "[ Member : returns IBFabric * ] getFabric" 4 -.IX Item "[ Member : returns IBFabric * ] getFabric" -.PD 0 -.IP "[ Member : returns IBMSServer * ] getServer" 4 -.IX Item "[ Member : returns IBMSServer * ] getServer" -.IP "[ Member : returns IBMSDispatcher * ] getDispatcher" 4 -.IX Item "[ Member : returns IBMSDispatcher * ] getDispatcher" -.IP "[ Member : returns int ] init topoFileName serverPortNum numWorkers" 4 -.IX Item "[ Member : returns int ] init topoFileName serverPortNum numWorkers" -.PD -.Sh "class IBMSNode" -.IX Subsection "class IBMSNode" -.IP "[ Member : returns IBNode * ] getIBNode" 4 -.IX Item "[ Member : returns IBNode * ] getIBNode" -get the IBNode of the IBMSNode -.IP "[ Member : returns int ] getLinkStatus outPortNum" 4 -.IX Item "[ Member : returns int ] getLinkStatus outPortNum" -get the link status of the given port -.IP "[ Member : returns int ] setPhyPortErrProfile portNum errProfileIn" 4 -.IX Item "[ Member : returns int ] setPhyPortErrProfile portNum errProfileIn" -set a particular port err profile -.IP "[ Member : returns int ] getPhyPortErrProfile portNum" 4 -.IX Item "[ Member : returns int ] getPhyPortErrProfile portNum" -get a particular port err profile -.IP "[ Member : returns int ] setPhyPortPMCounter portNum counterSelect countersVal" 4 -.IX Item "[ Member : returns int ] setPhyPortPMCounter portNum counterSelect countersVal" -set a specific port counter -.IP "[ Member : returns ib_pm_counters_t * ] getPhyPortPMCounter portNum counterSelect get a specific port counter" 4 -.IX Item "[ Member : returns ib_pm_counters_t * ] getPhyPortPMCounter portNum counterSelect get a specific port counter" -.PD 0 -.IP "[ Member : returns ib_port_info_t * ] getPortInfo portNum" 4 -.IX Item "[ Member : returns ib_port_info_t * ] getPortInfo portNum" -.PD -get a specific port info -.IP "[ Member : returns int ] setLinkStatus portNum newState" 4 -.IX Item "[ Member : returns int ] setLinkStatus portNum newState" -set the Link status including sending trap128 -.IP "[ Member : returns ib_node_info_t * ] getNodeInfo" 4 -.IX Item "[ Member : returns ib_node_info_t * ] getNodeInfo" -get the node info -.IP "[ Member : returns ib_switch_info_t * ] getSwitchInfo" 4 -.IX Item "[ Member : returns ib_switch_info_t * ] getSwitchInfo" -get the switch info -.IP "[ Member : returns ib_pkey_table_t * ] getPKeyTblBlock portNum blockNum" 4 -.IX Item "[ Member : returns ib_pkey_table_t * ] getPKeyTblBlock portNum blockNum" -get pkey table block -.IP "[ Member : returns int ] setPKeyTblBlock portNum blockNum tbl" 4 -.IX Item "[ Member : returns int ] setPKeyTblBlock portNum blockNum tbl" -set pkey table block -.IP "[ Member : returns int ] setCrSpace startAddr length data" 4 -.IX Item "[ Member : returns int ] setCrSpace startAddr length data" -set \s-1CR\s0 Space Value -.IP "[ Member : returns int ] getCrSpace startAddr length data" 4 -.IX Item "[ Member : returns int ] getCrSpace startAddr length data" -get \s-1CR\s0 Space Value -.IP "[ Member : returns int ] getMFTBlock blockIdx portIdx" 4 -.IX Item "[ Member : returns int ] getMFTBlock blockIdx portIdx" -get \s-1MFT\s0 block -.IP "[ Member : returns int ] setMFTBlock blockIdx portIdx inMftBlock" 4 -.IX Item "[ Member : returns int ] setMFTBlock blockIdx portIdx inMftBlock" -set \s-1MFT\s0 block -.Sh "class madMcMemberRec" -.IX Subsection "class madMcMemberRec" -.IP "[ Constructor: returns madMcMemberRec * ] madMcMemberRec name" 4 -.IX Item "[ Constructor: returns madMcMemberRec * ] madMcMemberRec name" -.PD 0 -.IP "[ Destructor: returns void ] rename obj {}" 4 -.IX Item "[ Destructor: returns void ] rename obj {}" -.IP "[ Member data: returns ib_gid_t * ] \-mgid" 4 -.IX Item "[ Member data: returns ib_gid_t * ] -mgid" -.IP "[ Member data: returns ib_gid_t * ] \-port_gid" 4 -.IX Item "[ Member data: returns ib_gid_t * ] -port_gid" -.IP "[ Member data: returns ib_net32_t * ] \-qkey" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -qkey" -.IP "[ Member data: returns ib_net16_t * ] \-mlid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -mlid" -.IP "[ Member data: returns uint8_t * ] \-mtu" 4 -.IX Item "[ Member data: returns uint8_t * ] -mtu" -.IP "[ Member data: returns uint8_t * ] \-tclass" 4 -.IX Item "[ Member data: returns uint8_t * ] -tclass" -.IP "[ Member data: returns ib_net16_t * ] \-pkey" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -pkey" -.IP "[ Member data: returns uint8_t * ] \-rate" 4 -.IX Item "[ Member data: returns uint8_t * ] -rate" -.IP "[ Member data: returns uint8_t * ] \-pkt_life" 4 -.IX Item "[ Member data: returns uint8_t * ] -pkt_life" -.IP "[ Member data: returns ib_net32_t * ] \-sl_flow_hop" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -sl_flow_hop" -.IP "[ Member data: returns uint8_t * ] \-scope_state" 4 -.IX Item "[ Member data: returns uint8_t * ] -scope_state" -.IP "[ Member : returns int ] send_set pFromNode fromPort destLid comp_mask" 4 -.IX Item "[ Member : returns int ] send_set pFromNode fromPort destLid comp_mask" -.IP "[ Member : returns int ] send_get pFromNode fromPort destLid comp_mask" 4 -.IX Item "[ Member : returns int ] send_get pFromNode fromPort destLid comp_mask" -.IP "[ Member : returns int ] send_del pFromNode fromPort destLid comp_mask" 4 -.IX Item "[ Member : returns int ] send_del pFromNode fromPort destLid comp_mask" -.PD -.Sh "class madPathRec" -.IX Subsection "class madPathRec" -.IP "[ Constructor: returns madPathRec * ] madPathRec name" 4 -.IX Item "[ Constructor: returns madPathRec * ] madPathRec name" -.PD 0 -.IP "[ Destructor: returns void ] rename obj {}" 4 -.IX Item "[ Destructor: returns void ] rename obj {}" -.IP "[ Member data: returns uint8_array_t * ] \-resv0" 4 -.IX Item "[ Member data: returns uint8_array_t * ] -resv0" -.IP "[ Member data: returns ib_gid_t * ] \-dgid" 4 -.IX Item "[ Member data: returns ib_gid_t * ] -dgid" -.IP "[ Member data: returns ib_gid_t * ] \-sgid" 4 -.IX Item "[ Member data: returns ib_gid_t * ] -sgid" -.IP "[ Member data: returns ib_net16_t * ] \-dlid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -dlid" -.IP "[ Member data: returns ib_net16_t * ] \-slid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -slid" -.IP "[ Member data: returns ib_net32_t * ] \-hop_flow_raw" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -hop_flow_raw" -.IP "[ Member data: returns uint8_t * ] \-tclass" 4 -.IX Item "[ Member data: returns uint8_t * ] -tclass" -.IP "[ Member data: returns uint8_t * ] \-num_path" 4 -.IX Item "[ Member data: returns uint8_t * ] -num_path" -.IP "[ Member data: returns ib_net16_t * ] \-pkey" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -pkey" -.IP "[ Member data: returns ib_net16_t * ] \-sl" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -sl" -.IP "[ Member data: returns uint8_t * ] \-mtu" 4 -.IX Item "[ Member data: returns uint8_t * ] -mtu" -.IP "[ Member data: returns uint8_t * ] \-rate" 4 -.IX Item "[ Member data: returns uint8_t * ] -rate" -.IP "[ Member data: returns uint8_t * ] \-pkt_life" 4 -.IX Item "[ Member data: returns uint8_t * ] -pkt_life" -.IP "[ Member data: returns uint8_t * ] \-preference" 4 -.IX Item "[ Member data: returns uint8_t * ] -preference" -.IP "[ Member data: returns uint8_array_t * ] \-resv2" 4 -.IX Item "[ Member data: returns uint8_array_t * ] -resv2" -.IP "[ Member : returns int ] send_get pFromNode fromPort destLid comp_mask" 4 -.IX Item "[ Member : returns int ] send_get pFromNode fromPort destLid comp_mask" -.PD -.Sh "class madServiceRec" -.IX Subsection "class madServiceRec" -.IP "[ Constructor: returns madServiceRec * ] madServiceRec name" 4 -.IX Item "[ Constructor: returns madServiceRec * ] madServiceRec name" -.PD 0 -.IP "[ Destructor: returns void ] rename obj {}" 4 -.IX Item "[ Destructor: returns void ] rename obj {}" -.IP "[ Member data: returns ib_net64_t * ] \-service_id" 4 -.IX Item "[ Member data: returns ib_net64_t * ] -service_id" -.IP "[ Member data: returns ib_gid_t * ] \-service_gid" 4 -.IX Item "[ Member data: returns ib_gid_t * ] -service_gid" -.IP "[ Member data: returns ib_net16_t * ] \-service_pkey" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -service_pkey" -.IP "[ Member data: returns ib_net16_t * ] \-resv" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -resv" -.IP "[ Member data: returns ib_net32_t * ] \-service_lease" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -service_lease" -.IP "[ Member data: returns uint8_array_t * ] \-service_key" 4 -.IX Item "[ Member data: returns uint8_array_t * ] -service_key" -.IP "[ Member data: returns uint8_array_t * ] \-service_name" 4 -.IX Item "[ Member data: returns uint8_array_t * ] -service_name" -.IP "[ Member data: returns uint8_array_t * ] \-service_data8" 4 -.IX Item "[ Member data: returns uint8_array_t * ] -service_data8" -.IP "[ Member data: returns uint16_array_t * ] \-service_data16" 4 -.IX Item "[ Member data: returns uint16_array_t * ] -service_data16" -.IP "[ Member data: returns uint32_array_t * ] \-service_data32" 4 -.IX Item "[ Member data: returns uint32_array_t * ] -service_data32" -.IP "[ Member data: returns uint64_array_t * ] \-service_data64" 4 -.IX Item "[ Member data: returns uint64_array_t * ] -service_data64" -.IP "[ Member : returns int ] send_set pFromNode fromPort destLid comp_mask" 4 -.IX Item "[ Member : returns int ] send_set pFromNode fromPort destLid comp_mask" -.IP "[ Member : returns int ] send_get pFromNode fromPort destLid comp_mask" 4 -.IX Item "[ Member : returns int ] send_get pFromNode fromPort destLid comp_mask" -.IP "[ Member : returns int ] send_del pFromNode fromPort destLid comp_mask" 4 -.IX Item "[ Member : returns int ] send_del pFromNode fromPort destLid comp_mask" -.PD -.Sh "class madNotice128" -.IX Subsection "class madNotice128" -.IP "[ Constructor: returns madNotice128 * ] madNotice128 name" 4 -.IX Item "[ Constructor: returns madNotice128 * ] madNotice128 name" -.PD 0 -.IP "[ Destructor: returns void ] rename obj {}" 4 -.IX Item "[ Destructor: returns void ] rename obj {}" -.IP "[ Member data: returns uint8_t * ] \-generic_type" 4 -.IX Item "[ Member data: returns uint8_t * ] -generic_type" -.IP "[ Member data: returns uint8_t * ] \-prod_type_msb" 4 -.IX Item "[ Member data: returns uint8_t * ] -prod_type_msb" -.IP "[ Member data: returns ib_net16_t * ] \-prod_type_lsb" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -prod_type_lsb" -.IP "[ Member data: returns ib_net16_t * ] \-trap_num" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -trap_num" -.IP "[ Member data: returns ib_net16_t * ] \-issuer_lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -issuer_lid" -.IP "[ Member data: returns ib_net16_t * ] \-toggle_count" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -toggle_count" -.IP "[ Member data: returns ib_net16_t * ] \-sw_lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -sw_lid" -.PD -the sw lid of which link state changed \- for 128 only -.IP "[ Member data: returns ib_gid_t * ] \-issuer_gid" 4 -.IX Item "[ Member data: returns ib_gid_t * ] -issuer_gid" -.PD 0 -.IP "[ Member : returns int ] send_trap pFromNode fromPort destLid" 4 -.IX Item "[ Member : returns int ] send_trap pFromNode fromPort destLid" -.PD -.Sh "class madNotice129" -.IX Subsection "class madNotice129" -.IP "[ Constructor: returns madNotice129 * ] madNotice129 name" 4 -.IX Item "[ Constructor: returns madNotice129 * ] madNotice129 name" -.PD 0 -.IP "[ Destructor: returns void ] rename obj {}" 4 -.IX Item "[ Destructor: returns void ] rename obj {}" -.IP "[ Member data: returns uint8_t * ] \-generic_type" 4 -.IX Item "[ Member data: returns uint8_t * ] -generic_type" -.IP "[ Member data: returns uint8_t * ] \-prod_type_msb" 4 -.IX Item "[ Member data: returns uint8_t * ] -prod_type_msb" -.IP "[ Member data: returns ib_net16_t * ] \-prod_type_lsb" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -prod_type_lsb" -.IP "[ Member data: returns ib_net16_t * ] \-trap_num" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -trap_num" -.IP "[ Member data: returns ib_net16_t * ] \-issuer_lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -issuer_lid" -.IP "[ Member data: returns ib_net16_t * ] \-toggle_count" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -toggle_count" -.IP "[ Member data: returns ib_net16_t * ] \-pad" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -pad" -.IP "[ Member data: returns ib_net16_t * ] \-lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lid" -.PD -lid and port number of the violation -.IP "[ Member data: returns uint8_t * ] \-port_num" 4 -.IX Item "[ Member data: returns uint8_t * ] -port_num" -.PD 0 -.IP "[ Member data: returns ib_gid_t * ] \-issuer_gid" 4 -.IX Item "[ Member data: returns ib_gid_t * ] -issuer_gid" -.IP "[ Member : returns int ] send_trap pFromNode fromPort destLid" 4 -.IX Item "[ Member : returns int ] send_trap pFromNode fromPort destLid" -.PD -.Sh "class madNotice144" -.IX Subsection "class madNotice144" -.IP "[ Constructor: returns madNotice144 * ] madNotice144 name" 4 -.IX Item "[ Constructor: returns madNotice144 * ] madNotice144 name" -.PD 0 -.IP "[ Destructor: returns void ] rename obj {}" 4 -.IX Item "[ Destructor: returns void ] rename obj {}" -.IP "[ Member data: returns uint8_t * ] \-generic_type" 4 -.IX Item "[ Member data: returns uint8_t * ] -generic_type" -.IP "[ Member data: returns uint8_t * ] \-prod_type_msb" 4 -.IX Item "[ Member data: returns uint8_t * ] -prod_type_msb" -.IP "[ Member data: returns ib_net16_t * ] \-prod_type_lsb" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -prod_type_lsb" -.IP "[ Member data: returns ib_net16_t * ] \-trap_num" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -trap_num" -.IP "[ Member data: returns ib_net16_t * ] \-issuer_lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -issuer_lid" -.IP "[ Member data: returns ib_net16_t * ] \-toggle_count" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -toggle_count" -.IP "[ Member data: returns ib_net16_t * ] \-pad1" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -pad1" -.IP "[ Member data: returns ib_net16_t * ] \-lid" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -lid" -.PD -lid where capability mask changed -.IP "[ Member data: returns ib_net16_t * ] \-pad2" 4 -.IX Item "[ Member data: returns ib_net16_t * ] -pad2" -.PD 0 -.IP "[ Member data: returns ib_net32_t * ] \-new_cap_mask" 4 -.IX Item "[ Member data: returns ib_net32_t * ] -new_cap_mask" -.PD -new capability mask -.IP "[ Member data: returns ib_gid_t * ] \-issuer_gid" 4 -.IX Item "[ Member data: returns ib_gid_t * ] -issuer_gid" -.PD 0 -.IP "[ Member : returns int ] send_trap pFromNode fromPort destLid" 4 -.IX Item "[ Member : returns int ] send_trap pFromNode fromPort destLid" -.PD -.SH "AUTHOR" -.IX Header "AUTHOR" -Eitan Zahavi, Mellanox Technologies \s-1LTD\s0, eitan@mellanox.co.il diff --git a/ibmgtsim/doc/mkSimNodeDir.1 b/ibmgtsim/doc/mkSimNodeDir.1 deleted file mode 100644 index d680021..0000000 --- a/ibmgtsim/doc/mkSimNodeDir.1 +++ /dev/null @@ -1,157 +0,0 @@ -.\" 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 "MKSIMNODEDIR 1" -.TH MKSIMNODEDIR 1 "2008-06-16" "IBMGTSIM 1.0" "IB MANAGEMENT SIMULATOR" -.SH "NAME" -\&\fBmkSimNodeDir\fR \- Create a /proc like files for a simulated node -.SH "SYNOPSYS" -.IX Header "SYNOPSYS" -mkSimNodeDir \-n node-name [\-g sim\-guids\-file] -.SH "DESCRIPTION" -.IX Header "DESCRIPTION" -This utility build the /proc like file tree for the given node -based on the guids dump file produced by the simulator. -.SH "ARGUMENTS" -.IX Header "ARGUMENTS" -.IP "\-n node-name" 4 -.IX Item "-n node-name" -The node name to create the files for. -.IP "\-g sim-guids-file" 4 -.IX Item "-g sim-guids-file" -Dump file to use. default is ./ibmgtsim.guids.txt -.SH "LIMITATIONS" -.IX Header "LIMITATIONS" -Only HCAs are supported. -.PP -Single \s-1HCA\s0 per guid. -.SH "AUTHOR" -.IX Header "AUTHOR" -Eitan Zahavi, Mellanox Technologies \s-1LTD\s0, eitan@mellanox.co.il