Package list ibutils / 1c15f7e
Remove generated man pages Benjamin Drung 10 months ago
13 changed file(s) with 0 addition(s) and 5763 deletion(s). Raw diff Collapse all Expand all
+0
-159
ibdiag/doc/ibdiagui.1 less more
0 .\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
1 .\"
2 .\" Standard preamble:
3 .\" ========================================================================
4 .de Sh \" Subsection heading
5 .br
6 .if t .Sp
7 .ne 5
8 .PP
9 \fB\\$1\fR
10 .PP
11 ..
12 .de Sp \" Vertical space (when we can't use .PP)
13 .if t .sp .5v
14 .if n .sp
15 ..
16 .de Vb \" Begin verbatim text
17 .ft CW
18 .nf
19 .ne \\$1
20 ..
21 .de Ve \" End verbatim text
22 .ft R
23 .fi
24 ..
25 .\" Set up some character translations and predefined strings. \*(-- will
26 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
27 .\" double quote, and \*(R" will give a right double quote. | will give a
28 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
29 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
30 .\" expand to `' in nroff, nothing in troff, for use with C<>.
31 .tr \(*W-|\(bv\*(Tr
32 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
33 .ie n \{\
34 . ds -- \(*W-
35 . ds PI pi
36 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
37 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
38 . ds L" ""
39 . ds R" ""
40 . ds C` ""
41 . ds C' ""
42 'br\}
43 .el\{\
44 . ds -- \|\(em\|
45 . ds PI \(*p
46 . ds L" ``
47 . ds R" ''
48 'br\}
49 .\"
50 .\" If the F register is turned on, we'll generate index entries on stderr for
51 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
52 .\" entries marked with X<> in POD. Of course, you'll have to process the
53 .\" output yourself in some meaningful fashion.
54 .if \nF \{\
55 . de IX
56 . tm Index:\\$1\t\\n%\t"\\$2"
57 ..
58 . nr % 0
59 . rr F
60 .\}
61 .\"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .hy 0
65 .if n .na
66 .\"
67 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
68 .\" Fear. Run. Save yourself. No user-serviceable parts.
69 . \" fudge factors for nroff and troff
70 .if n \{\
71 . ds #H 0
72 . ds #V .8m
73 . ds #F .3m
74 . ds #[ \f1
75 . ds #] \fP
76 .\}
77 .if t \{\
78 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
79 . ds #V .6m
80 . ds #F 0
81 . ds #[ \&
82 . ds #] \&
83 .\}
84 . \" simple accents for nroff and troff
85 .if n \{\
86 . ds ' \&
87 . ds ` \&
88 . ds ^ \&
89 . ds , \&
90 . ds ~ ~
91 . ds /
92 .\}
93 .if t \{\
94 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
95 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
96 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
97 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
98 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
99 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
100 .\}
101 . \" troff and (daisy-wheel) nroff accents
102 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
103 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
104 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
105 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
106 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
107 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
108 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
109 .ds ae a\h'-(\w'a'u*4/10)'e
110 .ds Ae A\h'-(\w'A'u*4/10)'E
111 . \" corrections for vroff
112 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
113 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
114 . \" for low resolution devices (crt and lpr)
115 .if \n(.H>23 .if \n(.V>19 \
116 \{\
117 . ds : e
118 . ds 8 ss
119 . ds o a
120 . ds d- d\h'-1'\(ga
121 . ds D- D\h'-1'\(hy
122 . ds th \o'bp'
123 . ds Th \o'LP'
124 . ds ae ae
125 . ds Ae AE
126 .\}
127 .rm #[ #] #H #V #F C
128 .\" ========================================================================
129 .\"
130 .IX Title "IBDIAGUI 1"
131 .TH IBDIAGUI 1 "2006-11-17" "IBDIAG 1.0" "IB DIAGNOSTIC PACKAGE"
132 .SH "NAME"
133 \&\fBibdiagui \- IB Diagnostic GUI\fR
134 .SH "SYNOPSYS"
135 .IX Header "SYNOPSYS"
136 ibdiagui [\-c <count>] [\-v] [\-r] [\-o <out\-dir>]
137 [\-t <topo\-file>] [\-s <sys\-name>] [\-i <dev\-index>] [\-p <port\-num>]
138 [\-pm] [\-pc] [\-P <\s-1PM\s0 counter>=<Trash Limit>]
139 [\-lw <1x|4x|12x>] [\-ls <2.5|5|10>]
140 .SH "DESCRIPTION"
141 .IX Header "DESCRIPTION"
142 .Vb 2
143 \& ibdiagui is a GUI wrapper for ibdiagnet.
144 \& Its main features:
145 .Ve
146 .IP "1. Display a graph of the discovered fabric (with optional names annotattion)" 4
147 .IX Item "1. Display a graph of the discovered fabric (with optional names annotattion)"
148 .PD 0
149 .IP "2. Hyperlink the ibdiagnet log to the graph objects" 4
150 .IX Item "2. Hyperlink the ibdiagnet log to the graph objects"
151 .IP "3. Show each object properties and object type specific actions on a properties pannel." 4
152 .IX Item "3. Show each object properties and object type specific actions on a properties pannel."
153 .PD
154 .SH "OPTIONS"
155 .IX Header "OPTIONS"
156 .RE
157 .IP "ibdiagui simply passes its options to ibdiagnet. Please see ibdiagnet man page for the complete list."
158 .IX Item "ibdiagui simply passes its options to ibdiagnet. Please see ibdiagnet man page for the complete list."
+0
-363
ibdm/doc/ibdm-ibnl-file.1 less more
0 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
1 .\"
2 .\" Standard preamble:
3 .\" ========================================================================
4 .de Sh \" Subsection heading
5 .br
6 .if t .Sp
7 .ne 5
8 .PP
9 \fB\\$1\fR
10 .PP
11 ..
12 .de Sp \" Vertical space (when we can't use .PP)
13 .if t .sp .5v
14 .if n .sp
15 ..
16 .de Vb \" Begin verbatim text
17 .ft CW
18 .nf
19 .ne \\$1
20 ..
21 .de Ve \" End verbatim text
22 .ft R
23 .fi
24 ..
25 .\" Set up some character translations and predefined strings. \*(-- will
26 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
27 .\" double quote, and \*(R" will give a right double quote. | will give a
28 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
29 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
30 .\" expand to `' in nroff, nothing in troff, for use with C<>.
31 .tr \(*W-|\(bv\*(Tr
32 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
33 .ie n \{\
34 . ds -- \(*W-
35 . ds PI pi
36 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
37 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
38 . ds L" ""
39 . ds R" ""
40 . ds C` ""
41 . ds C' ""
42 'br\}
43 .el\{\
44 . ds -- \|\(em\|
45 . ds PI \(*p
46 . ds L" ``
47 . ds R" ''
48 'br\}
49 .\"
50 .\" If the F register is turned on, we'll generate index entries on stderr for
51 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
52 .\" entries marked with X<> in POD. Of course, you'll have to process the
53 .\" output yourself in some meaningful fashion.
54 .if \nF \{\
55 . de IX
56 . tm Index:\\$1\t\\n%\t"\\$2"
57 ..
58 . nr % 0
59 . rr F
60 .\}
61 .\"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .hy 0
65 .if n .na
66 .\"
67 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
68 .\" Fear. Run. Save yourself. No user-serviceable parts.
69 . \" fudge factors for nroff and troff
70 .if n \{\
71 . ds #H 0
72 . ds #V .8m
73 . ds #F .3m
74 . ds #[ \f1
75 . ds #] \fP
76 .\}
77 .if t \{\
78 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
79 . ds #V .6m
80 . ds #F 0
81 . ds #[ \&
82 . ds #] \&
83 .\}
84 . \" simple accents for nroff and troff
85 .if n \{\
86 . ds ' \&
87 . ds ` \&
88 . ds ^ \&
89 . ds , \&
90 . ds ~ ~
91 . ds /
92 .\}
93 .if t \{\
94 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
95 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
96 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
97 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
98 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
99 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
100 .\}
101 . \" troff and (daisy-wheel) nroff accents
102 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
103 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
104 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
105 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
106 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
107 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
108 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
109 .ds ae a\h'-(\w'a'u*4/10)'e
110 .ds Ae A\h'-(\w'A'u*4/10)'E
111 . \" corrections for vroff
112 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
113 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
114 . \" for low resolution devices (crt and lpr)
115 .if \n(.H>23 .if \n(.V>19 \
116 \{\
117 . ds : e
118 . ds 8 ss
119 . ds o a
120 . ds d- d\h'-1'\(ga
121 . ds D- D\h'-1'\(hy
122 . ds th \o'bp'
123 . ds Th \o'LP'
124 . ds ae ae
125 . ds Ae AE
126 .\}
127 .rm #[ #] #H #V #F C
128 .\" ========================================================================
129 .\"
130 .IX Title "IBDM-IBNL-FILE 1"
131 .TH IBDM-IBNL-FILE 1 "2008-06-16" "IBDM 1.0" "IB DATA MODEL PACKAGE"
132 .SH "NAME"
133 \&\fBibnl\fR \- a generic IB netlist format
134 .SH "DESCRIPTION"
135 .IX Header "DESCRIPTION"
136 \&\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: <prefix>/lib/ibdm1.0/ibnl.
137 .PP
138 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).
139 .SH "1. Main Concepts"
140 .IX Header "1. Main Concepts"
141 The described file format for defining generic system \s-1IB\s0 connectivity uses the following terminology:
142 .IP "\s-1NODE\s0" 4
143 .IX Item "NODE"
144 The instantiation of an \s-1IB\s0 device may it be a switch or a channel adapter
145 .IP "SUB-SYSTEM" 4
146 .IX Item "SUB-SYSTEM"
147 The instantiation of a board or module in a system
148 .IP "\s-1SYSTEM\s0" 4
149 .IX Item "SYSTEM"
150 A definition of a board or a module
151 .IP "\s-1TOPSYSTEM\s0" 4
152 .IX Item "TOPSYSTEM"
153 The top most system defined in the given file
154 .IP "SUB-SYSTEM \s-1MODIFIER\s0" 4
155 .IX Item "SUB-SYSTEM MODIFIER"
156 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.
157 .SH "2. File Format"
158 .IX Header "2. File Format"
159 The exact file format is provided in section 4. This section only provides extra information regarding the specific semantics of various sections.
160 .PP
161 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.
162 .PP
163 Connections are defined inside the \s-1SYSTEM/TOPSYSTEM\s0 section only and thus might be of two types:
164 .IP "1. Between any node or sub-system to other node or sub-system" 4
165 .IX Item "1. Between any node or sub-system to other node or sub-system"
166 .PD 0
167 .IP "2. From any node or sub-system to a connector of the system." 4
168 .IX Item "2. From any node or sub-system to a connector of the system."
169 .PD
170 .PP
171 \&\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.
172 .PP
173 \&\s-1NOTE\-2:\s0 Port width and speed provided at the lowest level have precedence over definitions provided at upper levels of the hierarchy.
174 .SH "3. Guidelines for writing a System IBNL File"
175 .IX Header "3. Guidelines for writing a System IBNL File"
176 The following procedure should be followed in order to provide a new system \s-1IBNL:\s0
177 .IP "a)" 4
178 Name the file after the system name: <any sys name (no spaces)>.ibnl
179 .IP "b)" 4
180 Define a \s-1SYSTEM\s0 section for each board included in the system
181 .IP "c)" 4
182 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.
183 .IP "d)" 4
184 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
185 .RS 4
186 .Sp
187 .RS 4
188 \&\s-1SYSTEM\s0 \s-1LEAF\s0,LEAF:4x,LEAF:4X
189 .Sp
190 \&...
191 .Sp
192 \&\s-1SYSTEM\s0 LEAF:12x,LEAF:12X
193 .Sp
194 \&...
195 .Sp
196 \&\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:
197 .Sp
198 .RS 4
199 \&\s-1TOPSYSTEM\s0 MyIbSystem
200 .Sp
201 \&\s-1LEAF\s0 leaf1
202 .Sp
203 \&...
204 .Sp
205 \&\s-1LEAF\s0 leaf2
206 .Sp
207 \&...
208 .RE
209 .RE
210 .RS 4
211 .Sp
212 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:
213 .Sp
214 .RS 4
215 MyIbSystem N001 \s-1CFG:\s0 leaf2=12x
216 .Sp
217 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.
218 .RE
219 .IP "e)" 4
220 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:
221 .RS 4
222 .Sp
223 .RS 4
224 \&\s-1SYSTEM\s0 LEAF:4x
225 .Sp
226 \&\s-1NODE\s0 U1
227 .Sp
228 1 \-4x\-> 4XP1
229 .Sp
230 2 \-4x\-> 4XP2
231 .Sp
232 3 \-4x\-> 4XP3
233 .Sp
234 \&...
235 .Sp
236 \&\s-1SYSTEM\s0 LEAF:12x
237 .Sp
238 \&\s-1NODE\s0 U1
239 .Sp
240 1 \-12x\-> 12XP1
241 .Sp
242 \&...
243 .Sp
244 \&\s-1TOPSYSTEM\s0 myIbSystem
245 .Sp
246 \&\s-1SUBSYSTEM\s0 \s-1LEAF\s0 leaf1
247 .Sp
248 4XP1 \-> L1/P1
249 .Sp
250 4XP2 \-> L1/P2
251 .Sp
252 4XP3 \-> L1/P3
253 .Sp
254 12XP1 \-> L1/P1\-12x
255 .RE
256 .RE
257 .RS 4
258 .IP "f)" 4
259 Place the file in the <prefix>/lib/IBDM/ibdm1.0/ibnl directory
260 .IP "g)" 4
261 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.
262 .SH "4. Formal definition in YACC Syntax:"
263 .IX Header "4. Formal definition in YACC Syntax:"
264 \&\s-1INT\s0 ::= ([1\-9][0\-9]*|0) ;
265 .Sp
266 \&\s-1WIDTH\s0 ::= (4x|8x|12x) ;
267 .Sp
268 \&\s-1SPEED\s0 ::= (2.5G|5G|10G) ;
269 .Sp
270 \&\s-1NODETYPE\s0 ::= (SW|CA|HCA) ;
271 .Sp
272 \&\s-1NAME\s0 ::= ([\e[\e]\e\e\e*/A\-Za\-z0\-9_.:%@~]+) ;
273 .Sp
274 \&\s-1NL:\s0
275 \&\s-1LINE\s0
276 | \s-1NL\s0 \s-1LINE\s0;
277 .Sp
278 \&\s-1ONL:\s0
279 | \s-1NL\s0;
280 .Sp
281 ibnl: \s-1ONL\s0 systems topsystem;
282 .Sp
283 systems:
284 | systems system ;
285 .Sp
286 sub_inst_attributes:
287 | sub_inst_attributes sub_inst_attribute \s-1NL\s0;
288 .Sp
289 sub_inst_attribute:
290 \&\s-1NAME\s0 '=' \s-1NAME\s0 '=' \s-1NAME\s0
291 | \s-1NAME\s0 '=' \s-1NAME\s0 '=' \s-1INT\s0
292 | \s-1NAME\s0 '=' \s-1NAME\s0 ;
293 .Sp
294 topsystem:
295 \&\s-1TOPSYSTEM\s0 system_names \s-1NL\s0 sub_inst_attributes insts ;
296 .Sp
297 system:
298 \&\s-1SYSTEM\s0 system_names \s-1NL\s0 insts ;
299 .Sp
300 system_names:
301 system_name
302 | system_names ',' system_name ;
303 .Sp
304 system_name:
305 \&\s-1NAME\s0 ;
306 .Sp
307 insts:
308 | insts node
309 | insts subsystem ;
310 .Sp
311 node:
312 node_header \s-1NL\s0 node_connections ;
313 .Sp
314 node_header:
315 \&\s-1NODE\s0 \s-1NODETYPE\s0 \s-1INT\s0 \s-1NAME\s0 \s-1NAME\s0 ;
316 .Sp
317 node_connections:
318 | node_connections node_connection \s-1NL\s0 ;
319 .Sp
320 node_connection:
321 node_to_node_link
322 | node_to_port_link ;
323 .Sp
324 node_to_node_link:
325 \&\s-1INT\s0 '\-' \s-1WIDTH\s0 '\-' \s-1SPEED\s0 '\-' '>' \s-1NAME\s0
326 | \s-1INT\s0 '\-' \s-1WIDTH\s0 '\-' '>' \s-1NAME\s0 \s-1INT\s0
327 | \s-1INT\s0 '\-' \s-1SPEED\s0 '\-' '>' \s-1NAME\s0 \s-1INT\s0
328 | \s-1INT\s0 '\-' '>' \s-1NAME\s0 \s-1INT\s0 ;
329 .Sp
330 node_to_port_link:
331 \&\s-1INT\s0 '\-' \s-1WIDTH\s0 '\-' \s-1SPEED\s0 '\-' '>' \s-1NAME\s0
332 | \s-1INT\s0 '\-' \s-1WIDTH\s0 '\-' '>' \s-1NAME\s0
333 | \s-1INT\s0 '\-' \s-1SPEED\s0 '\-' '>' \s-1NAME\s0
334 | \s-1INT\s0 '\-' '>' \s-1NAME\s0 ;
335 .Sp
336 subsystem:
337 subsystem_header \s-1NL\s0 subsystem_connections ;
338 .Sp
339 subsystem_header:
340 \&\s-1SUBSYSTEM\s0 \s-1NAME\s0 \s-1NAME\s0 ;
341 .Sp
342 subsystem_connections:
343 | subsystem_connections subsystem_connection \s-1NL\s0 ;
344 .Sp
345 subsystem_connection:
346 subsystem_to_subsystem_link
347 | subsystem_to_port_link ;
348 .Sp
349 subsystem_to_subsystem_link:
350 \&\s-1NAME\s0 '\-' \s-1WIDTH\s0 '\-' \s-1SPEED\s0 '\-' '>' \s-1NAME\s0 \s-1NAME\s0
351 | \s-1NAME\s0 '\-' \s-1WIDTH\s0 '\-' '>' \s-1NAME\s0 \s-1NAME\s0
352 | \s-1NAME\s0 '\-' \s-1SPEED\s0 '\-' '>' \s-1NAME\s0 \s-1NAME\s0
353 | \s-1NAME\s0 '\-' '>' \s-1NAME\s0 \s-1NAME\s0 ;
354 .Sp
355 subsystem_to_port_link:
356 \&\s-1NAME\s0 '\-' \s-1WIDTH\s0 '\-' \s-1SPEED\s0 '\-' '>' \s-1NAME\s0
357 | \s-1NAME\s0 '\-' \s-1WIDTH\s0 '\-' '>' \s-1NAME\s0
358 | \s-1NAME\s0 '\-' \s-1SPEED\s0 '\-' '>' \s-1NAME\s0
359 | \s-1NAME\s0 '\-' '>' \s-1NAME\s0 ;
360 .SH "AUTHOR"
361 .IX Header "AUTHOR"
362 Eitan Zahavi, Mellanox Technologies \s-1LTD\s0, eitan@mellanox.co.il
+0
-219
ibdm/doc/ibdm-topo-file.1 less more
0 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
1 .\"
2 .\" Standard preamble:
3 .\" ========================================================================
4 .de Sh \" Subsection heading
5 .br
6 .if t .Sp
7 .ne 5
8 .PP
9 \fB\\$1\fR
10 .PP
11 ..
12 .de Sp \" Vertical space (when we can't use .PP)
13 .if t .sp .5v
14 .if n .sp
15 ..
16 .de Vb \" Begin verbatim text
17 .ft CW
18 .nf
19 .ne \\$1
20 ..
21 .de Ve \" End verbatim text
22 .ft R
23 .fi
24 ..
25 .\" Set up some character translations and predefined strings. \*(-- will
26 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
27 .\" double quote, and \*(R" will give a right double quote. | will give a
28 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
29 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
30 .\" expand to `' in nroff, nothing in troff, for use with C<>.
31 .tr \(*W-|\(bv\*(Tr
32 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
33 .ie n \{\
34 . ds -- \(*W-
35 . ds PI pi
36 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
37 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
38 . ds L" ""
39 . ds R" ""
40 . ds C` ""
41 . ds C' ""
42 'br\}
43 .el\{\
44 . ds -- \|\(em\|
45 . ds PI \(*p
46 . ds L" ``
47 . ds R" ''
48 'br\}
49 .\"
50 .\" If the F register is turned on, we'll generate index entries on stderr for
51 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
52 .\" entries marked with X<> in POD. Of course, you'll have to process the
53 .\" output yourself in some meaningful fashion.
54 .if \nF \{\
55 . de IX
56 . tm Index:\\$1\t\\n%\t"\\$2"
57 ..
58 . nr % 0
59 . rr F
60 .\}
61 .\"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .hy 0
65 .if n .na
66 .\"
67 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
68 .\" Fear. Run. Save yourself. No user-serviceable parts.
69 . \" fudge factors for nroff and troff
70 .if n \{\
71 . ds #H 0
72 . ds #V .8m
73 . ds #F .3m
74 . ds #[ \f1
75 . ds #] \fP
76 .\}
77 .if t \{\
78 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
79 . ds #V .6m
80 . ds #F 0
81 . ds #[ \&
82 . ds #] \&
83 .\}
84 . \" simple accents for nroff and troff
85 .if n \{\
86 . ds ' \&
87 . ds ` \&
88 . ds ^ \&
89 . ds , \&
90 . ds ~ ~
91 . ds /
92 .\}
93 .if t \{\
94 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
95 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
96 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
97 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
98 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
99 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
100 .\}
101 . \" troff and (daisy-wheel) nroff accents
102 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
103 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
104 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
105 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
106 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
107 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
108 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
109 .ds ae a\h'-(\w'a'u*4/10)'e
110 .ds Ae A\h'-(\w'A'u*4/10)'E
111 . \" corrections for vroff
112 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
113 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
114 . \" for low resolution devices (crt and lpr)
115 .if \n(.H>23 .if \n(.V>19 \
116 \{\
117 . ds : e
118 . ds 8 ss
119 . ds o a
120 . ds d- d\h'-1'\(ga
121 . ds D- D\h'-1'\(hy
122 . ds th \o'bp'
123 . ds Th \o'LP'
124 . ds ae ae
125 . ds Ae AE
126 .\}
127 .rm #[ #] #H #V #F C
128 .\" ========================================================================
129 .\"
130 .IX Title "IBDM-TOPO-FILE 1"
131 .TH IBDM-TOPO-FILE 1 "2008-06-16" "IBDM 1.0" "IB DATA MODEL PACKAGE"
132 .SH "NAME"
133 \&\fBIBDM Topology File\fR
134 .PP
135 The topology file describes the IB connectivity and systems included in the network.
136 It serves two purposes:
137 .IP "1. Support for arbitrary system names to be later used in every report that IBDM generates." 4
138 .IX Item "1. Support for arbitrary system names to be later used in every report that IBDM generates."
139 .PD 0
140 .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
141 .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."
142 .PD
143 .PP
144 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.
145 .PP
146 An example is listed afterwards.
147 .PP
148 SYSTEM\-TYPE SYSTEM\-NAME [CFG: <b1>=<modifier>, [<b2>=<modifier>]...]
149 .PP
150 .Vb 1
151 \& LOCAL-PORT-PANEL-NAME -> REM-SYS-TYPE REM-SYS-NAME REM-PORT-PANEL-NAME
152 .Ve
153 .PP
154 .Vb 1
155 \& LOCAL-PORT-PANEL-NAME -> REM-SYS-TYPE REM-SYS-NAME REM-PORT-PANEL-NAME
156 .Ve
157 .PP
158 .Vb 1
159 \& LOCAL-PORT-PANEL-NAME -> REM-SYS-TYPE REM-SYS-NAME REM-PORT-PANEL-NAME
160 .Ve
161 .PP
162 .Vb 1
163 \& . . .
164 .Ve
165 .PP
166 SYSTEM\-TYPE SYSTEM\-NAME [CFG: <b1>=<modifier>, [<b2>=<modifier>]...]
167 .PP
168 .Vb 1
169 \& LOCAL-PORT-PANEL-NAME -> REM-SYS-TYPE REM-SYS-NAME REM-PORT-PANEL-NAME
170 .Ve
171 .PP
172 .Vb 1
173 \& LOCAL-PORT-PANEL-NAME -> REM-SYS-TYPE REM-SYS-NAME REM-PORT-PANEL-NAME
174 .Ve
175 .PP
176 .Vb 1
177 \& . . .
178 .Ve
179 .PP
180 \&. . .
181 .PP
182 Where:
183 .IP "\fBSYSTEM\-TYPE\fR and \fBREM\-SYS\-TYPE\fR" 4
184 .IX Item "SYSTEM-TYPE and REM-SYS-TYPE"
185 Any system that has a corresponding IBNL definition. See man \fBibdm\-ibnl\-file\fR
186 .IP "\fBSYSTEM\-NAME\fR" 4
187 .IX Item "SYSTEM-NAME"
188 The name of the system described in this topology file section.
189 .IP "\fBLOCAL\-PORT\-PANEL\-NAME\fR" 4
190 .IX Item "LOCAL-PORT-PANEL-NAME"
191 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.
192 .IP "\fBREM\-SYS\-NAME\fR" 4
193 .IX Item "REM-SYS-NAME"
194 The name of the system connected to the local port.
195 .IP "\fBREM\-PORT\-PANEL\-NAME\fR" 4
196 .IX Item "REM-PORT-PANEL-NAME"
197 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.
198 .SH "EXAMPLE"
199 .IX Header "EXAMPLE"
200 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
201 .PP
202 \&\s-1MTS2400\s0 S\-1
203 P1 \-> \s-1MT23108\s0 H\-1 P1
204 P2 \-> \s-1MT23108\s0 H\-1 P2
205 P24 \-> \s-1MT23108\s0 H\-2 P1
206 .SH "OPTIONAL CFG SECTION"
207 .IX Header "OPTIONAL CFG SECTION"
208 This section in the system declaration line describes the special customization of each board of the system.
209 .PP
210 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.
211 .SH "EXAMPLE"
212 .IX Header "EXAMPLE"
213 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.
214 .PP
215 \&\s-1MTS9600\s0 PartialGz1 \s-1CFG:\s0 leaf3=R,leaf5=R,leaf7=R,spine1=R
216 .SH "AUTHOR"
217 .IX Header "AUTHOR"
218 Eitan Zahavi, Mellanox Technologies \s-1LTD\s0, eitan@mellanox.co.il
+0
-251
ibdm/doc/ibdmchk.1 less more
0 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
1 .\"
2 .\" Standard preamble:
3 .\" ========================================================================
4 .de Sh \" Subsection heading
5 .br
6 .if t .Sp
7 .ne 5
8 .PP
9 \fB\\$1\fR
10 .PP
11 ..
12 .de Sp \" Vertical space (when we can't use .PP)
13 .if t .sp .5v
14 .if n .sp
15 ..
16 .de Vb \" Begin verbatim text
17 .ft CW
18 .nf
19 .ne \\$1
20 ..
21 .de Ve \" End verbatim text
22 .ft R
23 .fi
24 ..
25 .\" Set up some character translations and predefined strings. \*(-- will
26 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
27 .\" double quote, and \*(R" will give a right double quote. | will give a
28 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
29 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
30 .\" expand to `' in nroff, nothing in troff, for use with C<>.
31 .tr \(*W-|\(bv\*(Tr
32 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
33 .ie n \{\
34 . ds -- \(*W-
35 . ds PI pi
36 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
37 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
38 . ds L" ""
39 . ds R" ""
40 . ds C` ""
41 . ds C' ""
42 'br\}
43 .el\{\
44 . ds -- \|\(em\|
45 . ds PI \(*p
46 . ds L" ``
47 . ds R" ''
48 'br\}
49 .\"
50 .\" If the F register is turned on, we'll generate index entries on stderr for
51 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
52 .\" entries marked with X<> in POD. Of course, you'll have to process the
53 .\" output yourself in some meaningful fashion.
54 .if \nF \{\
55 . de IX
56 . tm Index:\\$1\t\\n%\t"\\$2"
57 ..
58 . nr % 0
59 . rr F
60 .\}
61 .\"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .hy 0
65 .if n .na
66 .\"
67 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
68 .\" Fear. Run. Save yourself. No user-serviceable parts.
69 . \" fudge factors for nroff and troff
70 .if n \{\
71 . ds #H 0
72 . ds #V .8m
73 . ds #F .3m
74 . ds #[ \f1
75 . ds #] \fP
76 .\}
77 .if t \{\
78 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
79 . ds #V .6m
80 . ds #F 0
81 . ds #[ \&
82 . ds #] \&
83 .\}
84 . \" simple accents for nroff and troff
85 .if n \{\
86 . ds ' \&
87 . ds ` \&
88 . ds ^ \&
89 . ds , \&
90 . ds ~ ~
91 . ds /
92 .\}
93 .if t \{\
94 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
95 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
96 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
97 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
98 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
99 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
100 .\}
101 . \" troff and (daisy-wheel) nroff accents
102 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
103 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
104 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
105 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
106 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
107 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
108 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
109 .ds ae a\h'-(\w'a'u*4/10)'e
110 .ds Ae A\h'-(\w'A'u*4/10)'E
111 . \" corrections for vroff
112 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
113 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
114 . \" for low resolution devices (crt and lpr)
115 .if \n(.H>23 .if \n(.V>19 \
116 \{\
117 . ds : e
118 . ds 8 ss
119 . ds o a
120 . ds d- d\h'-1'\(ga
121 . ds D- D\h'-1'\(hy
122 . ds th \o'bp'
123 . ds Th \o'LP'
124 . ds ae ae
125 . ds Ae AE
126 .\}
127 .rm #[ #] #H #V #F C
128 .\" ========================================================================
129 .\"
130 .IX Title "IBDMCHK 1"
131 .TH IBDMCHK 1 "2009-03-17" "IBDM 1.0" "IB DATA MODEL PACKAGE"
132 .SH "NAME"
133 \&\fBIBDM \- Network Checker and Attributes Analyzer\fR
134 .SH "SYNOPSYS"
135 .IX Header "SYNOPSYS"
136 ibdmchk has two operation modes: design and verification.
137 .PP
138 \&\s-1DESIGN:\s0
139 .PP
140 ibdmchk [\-v][\-h][\-u][\-r <roots file>] \-t <topology file> \-n <\s-1SM\s0 Node>
141 \-p <\s-1SM\s0 Port> [\-e] [\-l <lmc>]
142 .PP
143 \&\s-1VERIFICATION:\s0
144 .PP
145 ibdmchk [\-v][\-h][\-r <roots file>] [\-s <subnet file>] [\-f <fdb file>]
146 [\-m <mcfdbs file> [\-l <lmc>] [\-u] [\-M] [\-a]
147 [\-c <path sl file>] [\-d <sl2vl tables file>]
148 .SH "DESIGN MODE DESCRIPTION"
149 .IX Header "DESIGN MODE DESCRIPTION"
150 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.
151 .SH "ARGUMENTS:"
152 .IX Header "ARGUMENTS:"
153 .RE
154 .IP "\-t|\-\-topo <topo file>"
155 .IX Item "-t|--topo <topo file>"
156 The \fBtopology file\fR specifying the network. See man \fBibdm-topology-file\fR
157 .RE
158 .IP "\-n|\-\-node <\s-1SM\s0 Node>"
159 .IX Item "-n|--node <SM Node>"
160 The name of the Subnet Manager node (syntax: <Topo\-File\-System>/U1)
161 .RE
162 .IP "\-p|\-\-port <\s-1SM\s0 Port>"
163 .IX Item "-p|--port <SM Port>"
164 The port number by which the \s-1SM\s0 nodes is attached to the fabric.
165 .SH "OPTIONS"
166 .IX Header "OPTIONS"
167 .RE
168 .IP "\-v|\-\-verbose"
169 .IX Item "-v|--verbose"
170 Verbsoe mode
171 .RE
172 .IP "\-h|\-\-help"
173 .IX Item "-h|--help"
174 Provides this help message
175 .RE
176 .IP "\-l|\-\-lmc <lmc>"
177 .IX Item "-l|--lmc <lmc>"
178 \&\s-1LMC\s0 value > 0 means assigning 2^lmc lids to each port.
179 .RE
180 .IP "\-e|\-\-enh"
181 .IX Item "-e|--enh"
182 Use enhanced routing algorithm when \s-1LMC\s0 > 0 and report the resulting paths correlation (using same system/node) histogram
183 .RE
184 .IP "\-r|\-\-roots <roots file> A file with all the roots node names (one on each line)."
185 .IX Item "-r|--roots <roots file> A file with all the roots node names (one on each line)."
186 .SH "VERIFICATION MODE DESCRIPTION"
187 .IX Header "VERIFICATION MODE DESCRIPTION"
188 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.
189 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.
190 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.
191 .SH "ARGUMENTS"
192 .IX Header "ARGUMENTS"
193 .RE
194 .IP "\-l|\-\-lmc <lmc>"
195 .IX Item "-l|--lmc <lmc>"
196 The \s-1LMC\s0 value used while running OpenSM. Mandatory if not the default 0.
197 .SH "OPTIONS"
198 .IX Header "OPTIONS"
199 .RE
200 .IP "\-v|\-\-verbose"
201 .IX Item "-v|--verbose"
202 Verbsoe mode
203 .RE
204 .IP "\-h|\-\-help"
205 .IX Item "-h|--help"
206 Provides this help message
207 .RE
208 .IP "\-s|\-\-subnet <file>"
209 .IX Item "-s|--subnet <file>"
210 OpenSM subnet.lst file (default is /var/log/osm\-subnet.lst or /tmp/subnet.lst)
211 .RE
212 .IP "\-f|\-\-fdb <file>"
213 .IX Item "-f|--fdb <file>"
214 OpenSM dump of Ucast \s-1LFDB\s0. Use \-D 0x41 to generate it (default is /var/log/osm.fdbs or /tmp/osm.fdbs).
215 .RE
216 .IP "\-m|\-\-mcfdb <file>"
217 .IX Item "-m|--mcfdb <file>"
218 OpenSM dump of Multicast \s-1LFDB\s0. Use \-D 0x41 to generate it (default is /var/log/osm.mcfdbs or /tmp/osm.mcfdbs).
219 .RE
220 .IP "\-c|\-\-psl <file>"
221 .IX Item "-c|--psl <file>"
222 Source Guid to \s-1DLID\s0 \-> Path \s-1SL\s0 mapping.
223 Each line holds: src_node_guid dlid sl.
224 Used by the credit loop check to accuartly model \s-1SL/VL\s0 based routing.
225 .RE
226 .IP "\-d|\-\-slvl <file>"
227 .IX Item "-d|--slvl <file>"
228 \&\s-1SL2VL\s0 mapping of all switces.
229 Each line holds: swguid iport oport 0x(sl0)(sl1) 0x(sl2)(sl3)...
230 Used by the credit loop check to accuartly model \s-1SL/VL\s0 based routing.
231 .RE
232 .IP "\-r|\-\-roots <roots file>"
233 .IX Item "-r|--roots <roots file>"
234 A file holding all root nodes guids (one per line).
235 .RE
236 .IP "\-u|\-\-updn"
237 .IX Item "-u|--updn"
238 Use Up/Down based credit loop check algorithm instead of the generic one.
239 .RE
240 .IP "\-M|\-\-MFT"
241 .IX Item "-M|--MFT"
242 Include multicast routing in credit loops analysis.
243 .RE
244 .IP "\-a|\-\-all"
245 .IX Item "-a|--all"
246 Verify not only CA-CA paths but also \s-1SW\-SW\s0, CA-SW and \s-1SW\-CA\s0.
247 Both check for \s-1FDB\s0 path connectivity and also for credit loops.
248 .SH "AUTHOR"
249 .IX Header "AUTHOR"
250 Eitan Zahavi, Mellanox Technologies \s-1LTD\s0, eitan@mellanox.co.il
+0
-725
ibdm/doc/ibdmsh.1 less more
0 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
1 .\"
2 .\" Standard preamble:
3 .\" ========================================================================
4 .de Sh \" Subsection heading
5 .br
6 .if t .Sp
7 .ne 5
8 .PP
9 \fB\\$1\fR
10 .PP
11 ..
12 .de Sp \" Vertical space (when we can't use .PP)
13 .if t .sp .5v
14 .if n .sp
15 ..
16 .de Vb \" Begin verbatim text
17 .ft CW
18 .nf
19 .ne \\$1
20 ..
21 .de Ve \" End verbatim text
22 .ft R
23 .fi
24 ..
25 .\" Set up some character translations and predefined strings. \*(-- will
26 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
27 .\" double quote, and \*(R" will give a right double quote. | will give a
28 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
29 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
30 .\" expand to `' in nroff, nothing in troff, for use with C<>.
31 .tr \(*W-|\(bv\*(Tr
32 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
33 .ie n \{\
34 . ds -- \(*W-
35 . ds PI pi
36 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
37 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
38 . ds L" ""
39 . ds R" ""
40 . ds C` ""
41 . ds C' ""
42 'br\}
43 .el\{\
44 . ds -- \|\(em\|
45 . ds PI \(*p
46 . ds L" ``
47 . ds R" ''
48 'br\}
49 .\"
50 .\" If the F register is turned on, we'll generate index entries on stderr for
51 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
52 .\" entries marked with X<> in POD. Of course, you'll have to process the
53 .\" output yourself in some meaningful fashion.
54 .if \nF \{\
55 . de IX
56 . tm Index:\\$1\t\\n%\t"\\$2"
57 ..
58 . nr % 0
59 . rr F
60 .\}
61 .\"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .hy 0
65 .if n .na
66 .\"
67 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
68 .\" Fear. Run. Save yourself. No user-serviceable parts.
69 . \" fudge factors for nroff and troff
70 .if n \{\
71 . ds #H 0
72 . ds #V .8m
73 . ds #F .3m
74 . ds #[ \f1
75 . ds #] \fP
76 .\}
77 .if t \{\
78 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
79 . ds #V .6m
80 . ds #F 0
81 . ds #[ \&
82 . ds #] \&
83 .\}
84 . \" simple accents for nroff and troff
85 .if n \{\
86 . ds ' \&
87 . ds ` \&
88 . ds ^ \&
89 . ds , \&
90 . ds ~ ~
91 . ds /
92 .\}
93 .if t \{\
94 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
95 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
96 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
97 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
98 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
99 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
100 .\}
101 . \" troff and (daisy-wheel) nroff accents
102 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
103 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
104 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
105 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
106 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
107 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
108 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
109 .ds ae a\h'-(\w'a'u*4/10)'e
110 .ds Ae A\h'-(\w'A'u*4/10)'E
111 . \" corrections for vroff
112 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
113 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
114 . \" for low resolution devices (crt and lpr)
115 .if \n(.H>23 .if \n(.V>19 \
116 \{\
117 . ds : e
118 . ds 8 ss
119 . ds o a
120 . ds d- d\h'-1'\(ga
121 . ds D- D\h'-1'\(hy
122 . ds th \o'bp'
123 . ds Th \o'LP'
124 . ds ae ae
125 . ds Ae AE
126 .\}
127 .rm #[ #] #H #V #F C
128 .\" ========================================================================
129 .\"
130 .IX Title "IBDMSH 1"
131 .TH IBDMSH 1 "2009-03-16" "IBDM 1.0" "IB DATA MODEL PACKAGE"
132 .SH "NAME"
133 \&\fBibdmsh\fR IB DATA MODEL \- Extentended TCL shell
134 .SH "DESCRIPTION"
135 .IX Header "DESCRIPTION"
136 \&\fBibdmsh\fR is a \s-1TCL\s0 shell extended with interface for the \s-1IB\s0 data model.
137 To use this shell you will write \s-1TCL\s0 code that directly access the \s-1IB\s0 data model objects and functions.
138 .PP
139 The following sub sections provide detailed definition for those objects and \s-1API\s0.
140 .SH "IBDM Constants"
141 .IX Header "IBDM Constants"
142 .Sh "Node Types"
143 .IX Subsection "Node Types"
144 The following constants are used by the node object type field
145 .Sp
146 .RS 4
147 [ Constant : int ] \f(CW$IB_UNKNOWN_NODE_TYPE\fR = \s-1IB_UNKNOWN_NODE_TYPE\s0
148 .Sp
149 [ Constant : int ] \f(CW$IB_SW_NODE\fR = \s-1IB_SW_NODE\s0
150 .Sp
151 [ Constant : int ] \f(CW$IB_CA_NODE\fR = \s-1IB_CA_NODE\s0
152 .RE
153 .Sh "Log Verbosity Flags"
154 .IX Subsection "Log Verbosity Flags"
155 The following constants are used as argument bits for the global variable \f(CW$FabricUtilsVerboseLevel\fR
156 .Sp
157 .RS 4
158 [ Constant : int ] \f(CW$FABU_LOG_NONE\fR = 0x0
159 .Sp
160 [ Constant : int ] \f(CW$FABU_LOG_ERROR\fR = 0x1
161 .Sp
162 [ Constant : int ] \f(CW$FABU_LOG_INFO\fR = 0x2
163 .Sp
164 [ Constant : int ] \f(CW$FABU_LOG_VERBOSE\fR = 0x4
165 .RE
166 .SH "IBDM Globals"
167 .IX Header "IBDM Globals"
168 Log level: set to FABU_LOG* values
169 .Sp
170 .RS 4
171 [ Global : int ] \f(CW$FabricUtilsVerboseLevel\fR
172 .RE
173 .SH "IBDM Objects"
174 .IX Header "IBDM Objects"
175 This section decribes the various object types exposed by \s-1IBDM\s0.
176 .PP
177 \&\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:
178 .PP
179 Fabric: fabric:<idx>
180 .PP
181 System: system:<fab idx>:<sys name>
182 .PP
183 SysPort: sysport:<fab idx>:<sys name>:<port name>
184 .PP
185 Node: node:<fab idx>:<node name>
186 .PP
187 Port: port:<fab idx>:<node name>/<port num>
188 .PP
189 \&\s-1IBDM\s0 Objects are standard Swig-Tcl objects. As such they have two flavors for their usage: Variables, Objects.
190 .PP
191 \&\fBVariables/Pointers:\fR
192 For each object attribute a \*(L"get\*(R" and \*(L"set\*(R" methods are provided.
193 The format of the methods is: <class>_<attribute>_<get|set>.
194 The \*(L"set\*(R" method is only available for read/write attributes.
195 .PP
196 .Vb 4
197 \& Example:
198 \& set nodes [ibdm_get_nodes]
199 \& set node [lindex $nodes 0]
200 \& IBNode_numPorts_get $node
201 .Ve
202 .PP
203 \&\fBObjects:\fR
204 Given an object pointer one can convert it to a Tcl \*(L"Object\*(R"
205 using the following command:
206 <class> <obj_name> \-this <obj pointer>
207 .PP
208 .Vb 2
209 \& Once declared the <obj-name> can be used in conjunction to
210 \& with the standard "configure" and "cget" commands.
211 .Ve
212 .PP
213 .Vb 3
214 \& Example (following the previous one):
215 \& IBFabric VaTech -this $fabric
216 \& VaTech cget -NodeByName
217 .Ve
218 .PP
219 .Vb 5
220 \& To delete an object symbol (and enable its mapping to another
221 \& pointer) use:
222 \& rename <obj name> ""
223 \& for example:
224 \& rename VaTech ""
225 .Ve
226 .Sh "class IBPort"
227 .IX Subsection "class IBPort"
228 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.
229 .RE
230 .IP "[ Member data: returns IBPort * ] \-p_remotePort"
231 .IX Item "[ Member data: returns IBPort * ] -p_remotePort"
232 Port connected on the other side of link
233 .RE
234 .IP "[ Member data: returns IBSysPort * ] \-p_sysPort"
235 .IX Item "[ Member data: returns IBSysPort * ] -p_sysPort"
236 The system port (if any) connected to
237 .RE
238 .IP "[ Member data: returns IBNode * ] \-p_node"
239 .IX Item "[ Member data: returns IBNode * ] -p_node"
240 The node the port is part of.
241 .RE
242 .IP "[ Member data: returns int ] \-num"
243 .IX Item "[ Member data: returns int ] -num"
244 Physical ports are identified by number.
245 .RE
246 .IP "[ Member data: returns unsigned int ] \-base_lid"
247 .IX Item "[ Member data: returns unsigned int ] -base_lid"
248 The base lid assigned to the port.
249 .RE
250 .IP "[ Member data: returns IBLinkWidth * ] \-width"
251 .IX Item "[ Member data: returns IBLinkWidth * ] -width"
252 The link width of the port
253 .RE
254 .IP "[ Member data: returns IBLinkSpeed * ] \-speed"
255 .IX Item "[ Member data: returns IBLinkSpeed * ] -speed"
256 The link speed of the port
257 .RE
258 .IP "[ Member data: returns unsigned int ] \-counter1"
259 .IX Item "[ Member data: returns unsigned int ] -counter1"
260 A generic value to be used by various algorithms
261 .RE
262 .IP "[ Constructor: returns IBPort * ] IBPort name p_nodePtr number"
263 .IX Item "[ Constructor: returns IBPort * ] IBPort name p_nodePtr number"
264 IBPort constructor
265 .RE
266 .IP "[ Member : returns new_uint64_t ] guid_get"
267 .IX Item "[ Member : returns new_uint64_t ] guid_get"
268 Obtain the guid of the port
269 .RE
270 .IP "[ Member : returns void ] guid_set guid"
271 .IX Item "[ Member : returns void ] guid_set guid"
272 Modify the guid of the port
273 .RE
274 .IP "[ Member : returns new_string ] getName"
275 .IX Item "[ Member : returns new_string ] getName"
276 Get the port name: A device port connected to system port (front pannel) returns the front pannel port name.
277 .RE
278 .IP "[ Member : returns void ] connect p_otherPort ?width? ?speed?"
279 .IX Item "[ Member : returns void ] connect p_otherPort ?width? ?speed?"
280 Connect the port to another node port with optional width and speed parameters
281 .RE
282 .IP "[ Member : returns int ] disconnect"
283 .IX Item "[ Member : returns int ] disconnect"
284 Disconnect the port. Return 0 if successful
285 .Sh "class IBNode"
286 .IX Subsection "class IBNode"
287 The \s-1IB\s0 Node class represents a single \s-1IB\s0 Device (chip)
288 .RE
289 .IP "[ Member data: returns string * ] \-name"
290 .IX Item "[ Member data: returns string * ] -name"
291 Name of the node (instance name of the chip)
292 .RE
293 .IP "[ Member data: returns IBNodeType ] \-type"
294 .IX Item "[ Member data: returns IBNodeType ] -type"
295 Either a \f(CW$IB_SW_NODE\fR or \f(CW$IB_CA_NODE\fR
296 .RE
297 .IP "[ Member data: returns uint16_t * ] \-devId"
298 .IX Item "[ Member data: returns uint16_t * ] -devId"
299 The device \s-1ID\s0 of the node
300 .RE
301 .IP "[ Member data: returns uint16_t * ] \-revId"
302 .IX Item "[ Member data: returns uint16_t * ] -revId"
303 The device revision Id.
304 .RE
305 .IP "[ Member data: returns uint16_t * ] \-vendId"
306 .IX Item "[ Member data: returns uint16_t * ] -vendId"
307 The device Vendor \s-1ID\s0.
308 .RE
309 .IP "[ Member data: returns string * ] \-attributes"
310 .IX Item "[ Member data: returns string * ] -attributes"
311 Comma-sep string of arbitrary attributes k=v
312 .RE
313 .IP "[ Member data: returns uint8_t ] \-rank"
314 .IX Item "[ Member data: returns uint8_t ] -rank"
315 The rank of the node (0 is a root)
316 .RE
317 .IP "[ Member data: returns IBSystem * ] \-p_system"
318 .IX Item "[ Member data: returns IBSystem * ] -p_system"
319 What system we belong to
320 .RE
321 .IP "[ Member data: returns IBFabric * ] \-p_fabric"
322 .IX Item "[ Member data: returns IBFabric * ] -p_fabric"
323 What fabric we belong to.
324 .RE
325 .IP "[ Member data: returns unsigned int ] \-numPorts"
326 .IX Item "[ Member data: returns unsigned int ] -numPorts"
327 Number of physical ports
328 .RE
329 .IP "[ Member data: returns vec_pport * ] \-Ports"
330 .IX Item "[ Member data: returns vec_pport * ] -Ports"
331 Vector of all the ports
332 .RE
333 .IP "[ Member data: returns vec_vec_byte * ] \-MinHopsTable"
334 .IX Item "[ Member data: returns vec_vec_byte * ] -MinHopsTable"
335 A table of the number of hops required to get from each port to each target \s-1LID\s0
336 .RE
337 .IP "[ Member data: returns vec_byte * ] \-LFT"
338 .IX Item "[ Member data: returns vec_byte * ] -LFT"
339 The \s-1LFT\s0 of this node (for switches only) which is a long vector of target ports \- index is the \s-1LID\s0
340 .RE
341 .IP "[ Member : returns new_uint64_t ] guid_get"
342 .IX Item "[ Member : returns new_uint64_t ] guid_get"
343 Obtain the node \s-1GUID\s0
344 .RE
345 .IP "[ Member : returns void ] guid_set guid"
346 .IX Item "[ Member : returns void ] guid_set guid"
347 Set the node \s-1GUID\s0
348 .RE
349 .IP "[ Constructor: returns IBNode * ] IBNode name n p_fab p_sys t np"
350 .IX Item "[ Constructor: returns IBNode * ] IBNode name n p_fab p_sys t np"
351 Constractor
352 .RE
353 .IP "[ Member : returns IBPort * ] makePort num"
354 .IX Item "[ Member : returns IBPort * ] makePort num"
355 Create a new port by its number (if required) return the port pointer
356 .RE
357 .IP "[ Member : returns IBPort * ] getPort num"
358 .IX Item "[ Member : returns IBPort * ] getPort num"
359 Get a port by number num = 1..N:
360 .RE
361 .IP "[ Member : returns void ] setHops p_port lid hops"
362 .IX Item "[ Member : returns void ] setHops p_port lid hops"
363 Set the min hop for the given port (* is all) lid pair
364 .RE
365 .IP "[ Member : returns int ] getHops p_port lid"
366 .IX Item "[ Member : returns int ] getHops p_port lid"
367 Get the min number of hops defined for the given port or all
368 .RE
369 .IP "[ Member : returns IBPort * ] getFirstMinHopPort lid"
370 .IX Item "[ Member : returns IBPort * ] getFirstMinHopPort lid"
371 Scan the node ports and find the first port with min hop to the lid
372 .RE
373 .IP "[ Member : returns void ] setLFTPortForLid lid portNum"
374 .IX Item "[ Member : returns void ] setLFTPortForLid lid portNum"
375 Set the Linear Forwarding Table for the given \s-1LID\s0
376 .RE
377 .IP "[ Member : returns int ] getLFTPortForLid lid"
378 .IX Item "[ Member : returns int ] getLFTPortForLid lid"
379 Get the \s-1LFT\s0 for a given \s-1LID\s0
380 .RE
381 .IP "[ Member : returns void ] repHopTable"
382 .IX Item "[ Member : returns void ] repHopTable"
383 Dump out the min hop table of the node
384 .Sh "class IBSysPort"
385 .IX Subsection "class IBSysPort"
386 The IBSysPort class represents an \s-1IB\s0 plug on the system front or back pannels
387 .RE
388 .IP "[ Member data: returns string * ] \-name"
389 .IX Item "[ Member data: returns string * ] -name"
390 The front pannel name (silk) of the port
391 .RE
392 .IP "[ Member data: returns IBSysPort * ] \-p_remoteSysPort"
393 .IX Item "[ Member data: returns IBSysPort * ] -p_remoteSysPort"
394 If connected the other side sys port
395 .RE
396 .IP "[ Member data: returns IBSystem * ] \-p_system"
397 .IX Item "[ Member data: returns IBSystem * ] -p_system"
398 System it benongs to
399 .RE
400 .IP "[ Member data: returns IBPort * ] \-p_nodePort"
401 .IX Item "[ Member data: returns IBPort * ] -p_nodePort"
402 The node port it connects to.
403 .RE
404 .IP "[ Constructor: returns IBSysPort * ] IBSysPort name n p_sys"
405 .IX Item "[ Constructor: returns IBSysPort * ] IBSysPort name n p_sys"
406 Constructor
407 .RE
408 .IP "[ Member : returns void ] connect p_otherSysPort ?width? ?speed?"
409 .IX Item "[ Member : returns void ] connect p_otherSysPort ?width? ?speed?"
410 Connect two SysPorts
411 .RE
412 .IP "[ Member : returns int ] disconnect"
413 .IX Item "[ Member : returns int ] disconnect"
414 Disconnect the SysPort (and ports). Return 0 if successful
415 .Sh "class IBSystem"
416 .IX Subsection "class IBSystem"
417 The IBSystem class represents an entire chassis
418 .RE
419 .IP "[ Member data: returns string * ] \-name"
420 .IX Item "[ Member data: returns string * ] -name"
421 The \*(L"host\*(R" name of the system
422 .RE
423 .IP "[ Member data: returns string * ] \-type"
424 .IX Item "[ Member data: returns string * ] -type"
425 What is the type i.e. Cougar, Buffalo, \s-1MTS2400\s0, etc. A corresponding \s-1IBNL\s0 file should exist \- defining this system type
426 .RE
427 .IP "[ Member data: returns IBFabric * ] \-p_fabric"
428 .IX Item "[ Member data: returns IBFabric * ] -p_fabric"
429 Fabric the system belongs to
430 .RE
431 .IP "[ Member data: returns map_str_pnode * ] \-NodeByName"
432 .IX Item "[ Member data: returns map_str_pnode * ] -NodeByName"
433 Provide the node pointer by its name
434 .RE
435 .IP "[ Member data: returns map_str_psysport * ] \-PortByName"
436 .IX Item "[ Member data: returns map_str_psysport * ] -PortByName"
437 A map provising pointer to the SysPort by name
438 .RE
439 .IP "[ Constructor: returns IBSystem * ] IBSystem name n p_fab t"
440 .IX Item "[ Constructor: returns IBSystem * ] IBSystem name n p_fab t"
441 Constractor
442 .RE
443 .IP "[ Member : returns new_uint64_t ] guid_get"
444 .IX Item "[ Member : returns new_uint64_t ] guid_get"
445 Obtain the system image \s-1GUID\s0
446 .RE
447 .IP "[ Member : returns void ] guid_set guid"
448 .IX Item "[ Member : returns void ] guid_set guid"
449 Set the system image \s-1GUID\s0
450 .RE
451 .IP "[ Member : returns IBSysPort * ] makeSysPort pName"
452 .IX Item "[ Member : returns IBSysPort * ] makeSysPort pName"
453 Make sure we got the port defined (so define it if not)
454 .RE
455 .IP "[ Member : returns IBPort * ] getSysPortNodePortByName sysPortName"
456 .IX Item "[ Member : returns IBPort * ] getSysPortNodePortByName sysPortName"
457 Get the node port for the given sys port by name
458 .RE
459 .IP "[ Member : returns IBSysPort * ] getSysPort name"
460 .IX Item "[ Member : returns IBSysPort * ] getSysPort name"
461 Get a Sys Port by name
462 .Sh "class IBFabric"
463 .IX Subsection "class IBFabric"
464 Represents an entire \s-1IB\s0 subnet made of systems
465 .RE
466 .IP "[ Member data: returns map_str_pnode * ] \-NodeByName"
467 .IX Item "[ Member data: returns map_str_pnode * ] -NodeByName"
468 Provide a list of node name and pointer pairs
469 .RE
470 .IP "[ Member data: returns map_str_psys * ] \-SystemByName"
471 .IX Item "[ Member data: returns map_str_psys * ] -SystemByName"
472 Provide a list of system name and pointer pairs
473 .RE
474 .IP "[ Member data: returns vec_pport * ] \-PortByLid"
475 .IX Item "[ Member data: returns vec_pport * ] -PortByLid"
476 Provides a list of system port name and pointer pairs
477 .RE
478 .IP "[ Member data: returns map_guid_pnode * ] \-NodeByGuid"
479 .IX Item "[ Member data: returns map_guid_pnode * ] -NodeByGuid"
480 Provides a list of node guid and node pointer pairs
481 .RE
482 .IP "[ Member data: returns map_guid_psys * ] \-SystemByGuid"
483 .IX Item "[ Member data: returns map_guid_psys * ] -SystemByGuid"
484 Provides a list of system image guid and system pointer pairs
485 .RE
486 .IP "[ Member data: returns map_guid_pport * ] \-PortByGuid"
487 .IX Item "[ Member data: returns map_guid_pport * ] -PortByGuid"
488 Provides a list of port guid and port pointer pairs
489 .RE
490 .IP "[ Member data: returns unsigned int ] \-minLid"
491 .IX Item "[ Member data: returns unsigned int ] -minLid"
492 Track min lid used.
493 .RE
494 .IP "[ Member data: returns unsigned int ] \-maxLid"
495 .IX Item "[ Member data: returns unsigned int ] -maxLid"
496 Track max lid used.
497 .RE
498 .IP "[ Member data: returns unsigned int ] \-lmc"
499 .IX Item "[ Member data: returns unsigned int ] -lmc"
500 \&\s-1LMC\s0 value used
501 .RE
502 .IP "[ Member : returns IBNode * ] makeNode n p_sys type numPorts"
503 .IX Item "[ Member : returns IBNode * ] makeNode n p_sys type numPorts"
504 Get the node by its name (create one of does not exist)
505 .RE
506 .IP "[ Member : returns IBNode * ] getNode name"
507 .IX Item "[ Member : returns IBNode * ] getNode name"
508 Get the node by its name
509 .RE
510 .IP "[ Member : returns list_pnode * ] getNodesByType type"
511 .IX Item "[ Member : returns list_pnode * ] getNodesByType type"
512 Return the list of node pointers matching the required type
513 .RE
514 .IP "[ Member : returns IBSystem * ] makeGenericSystem name"
515 .IX Item "[ Member : returns IBSystem * ] makeGenericSystem name"
516 Create a new generic system \- basically an empty container for nodes...
517 .RE
518 .IP "[ Member : returns IBSystem * ] makeSystem name type"
519 .IX Item "[ Member : returns IBSystem * ] makeSystem name type"
520 Create a new system \- the type must have a registed factory.
521 .RE
522 .IP "[ Member : returns IBSystem * ] getSystem name"
523 .IX Item "[ Member : returns IBSystem * ] getSystem name"
524 Get system by name
525 .RE
526 .IP "[ Member : returns IBSystem * ] getSystemByGuid guid"
527 .IX Item "[ Member : returns IBSystem * ] getSystemByGuid guid"
528 get the system by its guid
529 .RE
530 .IP "[ Member : returns IBNode * ] getNodeByGuid guid"
531 .IX Item "[ Member : returns IBNode * ] getNodeByGuid guid"
532 get the node by its guid
533 .RE
534 .IP "[ Member : returns IBPort * ] getPortByGuid guid"
535 .IX Item "[ Member : returns IBPort * ] getPortByGuid guid"
536 get the port by its guid
537 .RE
538 .IP "[ Member : returns void ] addCable t1 n1 p1 t2 n2 p2 ?width? ?speed?"
539 .IX Item "[ Member : returns void ] addCable t1 n1 p1 t2 n2 p2 ?width? ?speed?"
540 Adds a cable given two sets of node type, node name and port number. Optionally use a given width and speed for the connection
541 .RE
542 .IP "[ Member : returns int ] parseCables fn"
543 .IX Item "[ Member : returns int ] parseCables fn"
544 Parse the cables file and build the fabric
545 .RE
546 .IP "[ Member : returns int ] parseTopology fn"
547 .IX Item "[ Member : returns int ] parseTopology fn"
548 Parse Topology File and build the fabric
549 .RE
550 .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?"
551 .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?"
552 Add a link into the fabric \- this will create system and nodes as required.
553 .RE
554 .IP "[ Member : returns int ] parseSubnetLinks fn"
555 .IX Item "[ Member : returns int ] parseSubnetLinks fn"
556 Parse the OpenSM subnet.lst file and build the fabric from it.
557 .RE
558 .IP "[ Member : returns int ] parseFdbFile fn"
559 .IX Item "[ Member : returns int ] parseFdbFile fn"
560 Parse OpenSM \s-1FDB\s0 dump file and fill in the switches \s-1LFT\s0 tables
561 .RE
562 .IP "[ Member : returns int ] parseMCFdbFile fn"
563 .IX Item "[ Member : returns int ] parseMCFdbFile fn"
564 Parse an OpenSM MCFDBs file and set the \s-1MFT\s0 table accordingly
565 .RE
566 .IP "[ Member : returns int ] parsePSLFile fn"
567 .IX Item "[ Member : returns int ] parsePSLFile fn"
568 Parse Path to \s-1SL\s0 mapping file. Each line with:
569 src_node_guid \s-1DLID\s0 \s-1SL\s0
570 .PP
571 Used by credit loop check
572 .RE
573 .IP "[ Member : returns int ] parseSLVLFile fn"
574 .IX Item "[ Member : returns int ] parseSLVLFile fn"
575 Parse \s-1SLVL\s0 tables file. Each line holds:
576 sw_node_guid in_port out_port 0x(sl0)(sl1) 0x(sl2)(sl3)...
577 .RE
578 .IP "[ Member : returns void ] setLidPort lid p_port"
579 .IX Item "[ Member : returns void ] setLidPort lid p_port"
580 Set a lid port
581 .RE
582 .IP "[ Member : returns IBPort * ] getPortByLid lid"
583 .IX Item "[ Member : returns IBPort * ] getPortByLid lid"
584 Get a port by lid
585 .RE
586 .IP "[ returns IBFabric * ] new_IBFabric"
587 .IX Item "[ returns IBFabric * ] new_IBFabric"
588 Construct a new fabric
589 .RE
590 .IP "[ returns void ] delete_IBFabric p_fabric"
591 .IX Item "[ returns void ] delete_IBFabric p_fabric"
592 Destruct a fabric
593 .SH "IBDM Functions"
594 .IX Header "IBDM Functions"
595 This section provide the details about the functions \s-1IBDM\s0 exposes.
596 The order follows the expected order in a regular \s-1IBDM\s0 flow.
597 They all return 0 on succes.
598 .Sh "Subnet Utilities"
599 .IX Subsection "Subnet Utilities"
600 The file holds a set of utilities to be run on the subnet to mimic OpenSM initialization and analyze the results:
601 .RE
602 .IP "[ returns int ] ibdmAssignLids p_smNodePort ?lmc?"
603 .IX Item "[ returns int ] ibdmAssignLids p_smNodePort ?lmc?"
604 Assign LIDs with an optional \s-1LMC\s0 (multiple \s-1LID\s0 per port)
605 .RE
606 .IP "[ returns int ] ibdmCalcMinHopTables p_fabric"
607 .IX Item "[ returns int ] ibdmCalcMinHopTables p_fabric"
608 Calculate and populate the MinHopTables required for running OpenSM style routing.
609 .RE
610 .IP "[ returns int ] ibdmCalcUpDnMinHopTbls p_fabric rootNodesNameRex"
611 .IX Item "[ returns int ] ibdmCalcUpDnMinHopTbls p_fabric rootNodesNameRex"
612 Calculate and populate the MinHopTables following Up/Down rule.
613 .RE
614 .IP "[ returns int ] ibdmOsmRoute p_fabric"
615 .IX Item "[ returns int ] ibdmOsmRoute p_fabric"
616 Route the fabric with OpenSM style routing
617 .RE
618 .IP "[ returns int ] ibdmEnhancedRoute p_fabric"
619 .IX Item "[ returns int ] ibdmEnhancedRoute p_fabric"
620 Route the fabric with OpenSM style routing enhanced with better support for \s-1LMC\s0 > 0
621 .RE
622 .IP "[ returns int ] ibdmFatTreeRoute p_fabric rootNodes"
623 .IX Item "[ returns int ] ibdmFatTreeRoute p_fabric rootNodes"
624 Route the fabric using algorithm that fits only full fat trees
625 .RE
626 .IP "[ returns int ] ibdmFatTreeAnalysis p_fabric"
627 .IX Item "[ returns int ] ibdmFatTreeAnalysis p_fabric"
628 Analyze the fabric to see if it is a fat tree and route it if it is
629 .RE
630 .IP "[ returns int ] ibdmVerifyCAtoCARoutes p_fabric"
631 .IX Item "[ returns int ] ibdmVerifyCAtoCARoutes p_fabric"
632 Make sure all (H)CAs are connected to each other based on the \s-1LFT\s0 settings
633 .RE
634 .IP "[ returns int ] ibdmVerifyAllPaths p_fabric"
635 .IX Item "[ returns int ] ibdmVerifyAllPaths p_fabric"
636 Make sure all Switches and (H)CAs are connected to each other based on the \s-1LFT\s0 settings
637 .RE
638 .IP "[ returns int ] ibdmAnalyzeLoops p_fabric"
639 .IX Item "[ returns int ] ibdmAnalyzeLoops p_fabric"
640 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
641 .RE
642 .IP "[ returns list_pnode ] ibdmFindSymmetricalTreeRoots p_fabric"
643 .IX Item "[ returns list_pnode ] ibdmFindSymmetricalTreeRoots p_fabric"
644 Analyze the tree topology and find the roots of the tree based on its symmetry
645 .RE
646 .IP "[ returns list_pnode ] ibdmFindRootNodesByMinHop p_fabric"
647 .IX Item "[ returns list_pnode ] ibdmFindRootNodesByMinHop p_fabric"
648 Based on the MinHopTable find the roots of the tree. A 5% assymetry is allowed
649 .RE
650 .IP "[ returns int ] ibdmRankFabricByRoots p_fabric rootNodes"
651 .IX Item "[ returns int ] ibdmRankFabricByRoots p_fabric rootNodes"
652 Given the list of root nodes (names) rank the nodes (root = 0)
653 .RE
654 .IP "[ returns int ] ibdmReportNonUpDownCa2CaPaths p_fabric rootNodes"
655 .IX Item "[ returns int ] ibdmReportNonUpDownCa2CaPaths p_fabric rootNodes"
656 Analyze the routes to make sure Up/Down rule is maintained
657 .RE
658 .IP "[ returns int ] ibdmCheckMulticastGroups p_fabric"
659 .IX Item "[ returns int ] ibdmCheckMulticastGroups p_fabric"
660 Verify connectivity of multicast routing
661 .RE
662 .IP "[ returns int ] ibdmCheckFabricMCGrpsForCreditLoopPotential p_fabric rootNodes"
663 .IX Item "[ returns int ] ibdmCheckFabricMCGrpsForCreditLoopPotential p_fabric rootNodes"
664 Analyze multicast routing to make sure it obeys Up/Down rule
665 .RE
666 .IP "[ returns int ] ibdmLinkCoverageAnalysis p_fabric rootNodes"
667 .IX Item "[ returns int ] ibdmLinkCoverageAnalysis p_fabric rootNodes"
668 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
669 .Sh "Tracing Utilities"
670 .IX Subsection "Tracing Utilities"
671 These functions allows tracing paths reporting back the visited nodes
672 .RE
673 .IP "[ returns int ] ibdmTraceDRPathRoute p_smNodePort drPathPortNums"
674 .IX Item "[ returns int ] ibdmTraceDRPathRoute p_smNodePort drPathPortNums"
675 Trace a directed route path from the given port
676 .RE
677 .IP "[ returns int ] ibdmTraceRouteByMinHops p_fabric slid dlid"
678 .IX Item "[ returns int ] ibdmTraceRouteByMinHops p_fabric slid dlid"
679 Trace a path along the MinHop from the source to destination LIDs
680 .RE
681 .IP "[ returns int ] ibdmTraceRouteByLFT p_fabric slid dlid hops p_nodesList"
682 .IX Item "[ returns int ] ibdmTraceRouteByLFT p_fabric slid dlid hops p_nodesList"
683 Trace a path following the \s-1LFT\s0 updating the hops and node list variables
684 .Sh "Topology Matching Utilities"
685 .IX Subsection "Topology Matching Utilities"
686 The following utilities matches two fabrics providing both missmatch messages and a unified fabric
687 .RE
688 .IP "[ returns int ] ibdmMatchFabrics p_spec_fabric p_discovered_fabric anchorNodeName anchorPortNum anchorPortGuid"
689 .IX Item "[ returns int ] ibdmMatchFabrics p_spec_fabric p_discovered_fabric anchorNodeName anchorPortNum anchorPortGuid"
690 Match a topology based fabric with a discovered one starting at the enchor port
691 .RE
692 .IP "[ returns int ] ibdmBuildMergedFabric p_spec_fabric p_discovered_fabric p_merged_fabric"
693 .IX Item "[ returns int ] ibdmBuildMergedFabric p_spec_fabric p_discovered_fabric p_merged_fabric"
694 After matching using ibdmMatchFabrics populate the \*(L"merged fabric\*(R" with information merged for the matched nodes
695 .Sh "Congestion Analysis Utilities"
696 .IX Subsection "Congestion Analysis Utilities"
697 Provide ability to track and report link oversubscription
698 .RE
699 .IP "[ returns int ] ibdmCongInit p_fabric"
700 .IX Item "[ returns int ] ibdmCongInit p_fabric"
701 Initialize the tracking system
702 .RE
703 .IP "[ returns int ] ibdmCongCleanup p_fabric"
704 .IX Item "[ returns int ] ibdmCongCleanup p_fabric"
705 Cleanup the counters and deallocate
706 .RE
707 .IP "[ returns int ] ibdmCongClear p_fabric"
708 .IX Item "[ returns int ] ibdmCongClear p_fabric"
709 Cleanup counters
710 .RE
711 .IP "[ returns int ] ibdmCongTrace p_fabric srcLid dstLid"
712 .IX Item "[ returns int ] ibdmCongTrace p_fabric srcLid dstLid"
713 Trace a path between the LIDs updating link usage info
714 .RE
715 .IP "[ returns int ] ibdmCongReport p_fabric"
716 .IX Item "[ returns int ] ibdmCongReport p_fabric"
717 Report the resulting congestion information
718 .RE
719 .IP "[ returns int ] ibdmCongDump p_fabric"
720 .IX Item "[ returns int ] ibdmCongDump p_fabric"
721 Dump all congestion tracking info
722 .SH "AUTHOR"
723 .IX Header "AUTHOR"
724 Eitan Zahavi, Mellanox Technologies \s-1LTD\s0, eitan@mellanox.co.il
+0
-211
ibdm/doc/ibdmtr.1 less more
0 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
1 .\"
2 .\" Standard preamble:
3 .\" ========================================================================
4 .de Sh \" Subsection heading
5 .br
6 .if t .Sp
7 .ne 5
8 .PP
9 \fB\\$1\fR
10 .PP
11 ..
12 .de Sp \" Vertical space (when we can't use .PP)
13 .if t .sp .5v
14 .if n .sp
15 ..
16 .de Vb \" Begin verbatim text
17 .ft CW
18 .nf
19 .ne \\$1
20 ..
21 .de Ve \" End verbatim text
22 .ft R
23 .fi
24 ..
25 .\" Set up some character translations and predefined strings. \*(-- will
26 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
27 .\" double quote, and \*(R" will give a right double quote. | will give a
28 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
29 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
30 .\" expand to `' in nroff, nothing in troff, for use with C<>.
31 .tr \(*W-|\(bv\*(Tr
32 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
33 .ie n \{\
34 . ds -- \(*W-
35 . ds PI pi
36 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
37 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
38 . ds L" ""
39 . ds R" ""
40 . ds C` ""
41 . ds C' ""
42 'br\}
43 .el\{\
44 . ds -- \|\(em\|
45 . ds PI \(*p
46 . ds L" ``
47 . ds R" ''
48 'br\}
49 .\"
50 .\" If the F register is turned on, we'll generate index entries on stderr for
51 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
52 .\" entries marked with X<> in POD. Of course, you'll have to process the
53 .\" output yourself in some meaningful fashion.
54 .if \nF \{\
55 . de IX
56 . tm Index:\\$1\t\\n%\t"\\$2"
57 ..
58 . nr % 0
59 . rr F
60 .\}
61 .\"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .hy 0
65 .if n .na
66 .\"
67 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
68 .\" Fear. Run. Save yourself. No user-serviceable parts.
69 . \" fudge factors for nroff and troff
70 .if n \{\
71 . ds #H 0
72 . ds #V .8m
73 . ds #F .3m
74 . ds #[ \f1
75 . ds #] \fP
76 .\}
77 .if t \{\
78 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
79 . ds #V .6m
80 . ds #F 0
81 . ds #[ \&
82 . ds #] \&
83 .\}
84 . \" simple accents for nroff and troff
85 .if n \{\
86 . ds ' \&
87 . ds ` \&
88 . ds ^ \&
89 . ds , \&
90 . ds ~ ~
91 . ds /
92 .\}
93 .if t \{\
94 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
95 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
96 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
97 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
98 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
99 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
100 .\}
101 . \" troff and (daisy-wheel) nroff accents
102 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
103 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
104 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
105 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
106 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
107 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
108 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
109 .ds ae a\h'-(\w'a'u*4/10)'e
110 .ds Ae A\h'-(\w'A'u*4/10)'E
111 . \" corrections for vroff
112 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
113 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
114 . \" for low resolution devices (crt and lpr)
115 .if \n(.H>23 .if \n(.V>19 \
116 \{\
117 . ds : e
118 . ds 8 ss
119 . ds o a
120 . ds d- d\h'-1'\(ga
121 . ds D- D\h'-1'\(hy
122 . ds th \o'bp'
123 . ds Th \o'LP'
124 . ds ae ae
125 . ds Ae AE
126 .\}
127 .rm #[ #] #H #V #F C
128 .\" ========================================================================
129 .\"
130 .IX Title "IBDMTR 1"
131 .TH IBDMTR 1 "2008-06-16" "IBDM 1.0" "IB DATA MODEL PACKAGE"
132 .SH "NAME"
133 \&\fBibdmtr\fR \- Fabric Trace Route
134 .SH "SYNOPSYS"
135 .IX Header "SYNOPSYS"
136 ibdmtr [\-v][\-h] {\-c <cbaling file>|\-t <topo file>} \-s <sm node name>
137 \-p <sm port num> \-d <comma\-sep\-dr\-path>
138 .SH "DESCRIPTION"
139 .IX Header "DESCRIPTION"
140 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.
141 .SH "ARGUMENTS Required arguments description."
142 .IX Header "ARGUMENTS Required arguments description."
143 .IP "\-t|\-\-topology <file>" 4
144 .IX Item "-t|--topology <file>"
145 .RS 4
146 .PD 0
147 .IP "Topology file describing the network. See man ibdm\-topology\-file." 4
148 .IX Item "Topology file describing the network. See man ibdm-topology-file."
149 .RE
150 .RS 4
151 .RE
152 .IP "\-c|\-\-cables <file>" 4
153 .IX Item "-c|--cables <file>"
154 .RS 4
155 .IP "Cabling list file. Following the line format:" 4
156 .IX Item "Cabling list file. Following the line format:"
157 .RE
158 .RS 4
159 .PD
160 .Sp
161 <Sys1Type> <Sys1Name> <Port1Name> <Sys2Type> <Sys2Name> <Port2Name>
162 .RE
163 .IP "\-s|\-\-sm\-node <name>" 4
164 .IX Item "-s|--sm-node <name>"
165 .RS 4
166 .PD 0
167 .IP "The name of the \s-1SM\s0 node (not system). E.g. \s-1OSM/U1\s0." 4
168 .IX Item "The name of the SM node (not system). E.g. OSM/U1."
169 .RE
170 .RS 4
171 .RE
172 .IP "\-p|\-\-port\-num <num>" 4
173 .IX Item "-p|--port-num <num>"
174 .RS 4
175 .IP "The number of the \s-1SM\s0 node port the \s-1SM\s0 is attached to" 4
176 .IX Item "The number of the SM node port the SM is attached to"
177 .RE
178 .RS 4
179 .RE
180 .IP "\-d|\-\-dr\-path <comm\-sep\-dr\-path>" 4
181 .IX Item "-d|--dr-path <comm-sep-dr-path>"
182 .RS 4
183 .IP "A list of ports to go out through" 4
184 .IX Item "A list of ports to go out through"
185 .RE
186 .RS 4
187 .PD
188 .SH "OPTIONS"
189 .IX Header "OPTIONS"
190 .RE
191 .IP "\-v|\-\-verbose" 4
192 .IX Item "-v|--verbose"
193 .RS 4
194 .PD 0
195 .IP "verbsoe mode" 4
196 .IX Item "verbsoe mode"
197 .RE
198 .RS 4
199 .RE
200 .IP "\-h|\-\-help" 4
201 .IX Item "-h|--help"
202 .RS 4
203 .IP "provide this help message" 4
204 .IX Item "provide this help message"
205 .RE
206 .RS 4
207 .PD
208 .SH "AUTHOR"
209 .IX Header "AUTHOR"
210 Eitan Zahavi, Mellanox Technologies \s-1LTD\s0, eitan@mellanox.co.il
+0
-176
ibdm/doc/ibtopodiff.1 less more
0 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
1 .\"
2 .\" Standard preamble:
3 .\" ========================================================================
4 .de Sh \" Subsection heading
5 .br
6 .if t .Sp
7 .ne 5
8 .PP
9 \fB\\$1\fR
10 .PP
11 ..
12 .de Sp \" Vertical space (when we can't use .PP)
13 .if t .sp .5v
14 .if n .sp
15 ..
16 .de Vb \" Begin verbatim text
17 .ft CW
18 .nf
19 .ne \\$1
20 ..
21 .de Ve \" End verbatim text
22 .ft R
23 .fi
24 ..
25 .\" Set up some character translations and predefined strings. \*(-- will
26 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
27 .\" double quote, and \*(R" will give a right double quote. | will give a
28 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
29 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
30 .\" expand to `' in nroff, nothing in troff, for use with C<>.
31 .tr \(*W-|\(bv\*(Tr
32 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
33 .ie n \{\
34 . ds -- \(*W-
35 . ds PI pi
36 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
37 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
38 . ds L" ""
39 . ds R" ""
40 . ds C` ""
41 . ds C' ""
42 'br\}
43 .el\{\
44 . ds -- \|\(em\|
45 . ds PI \(*p
46 . ds L" ``
47 . ds R" ''
48 'br\}
49 .\"
50 .\" If the F register is turned on, we'll generate index entries on stderr for
51 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
52 .\" entries marked with X<> in POD. Of course, you'll have to process the
53 .\" output yourself in some meaningful fashion.
54 .if \nF \{\
55 . de IX
56 . tm Index:\\$1\t\\n%\t"\\$2"
57 ..
58 . nr % 0
59 . rr F
60 .\}
61 .\"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .hy 0
65 .if n .na
66 .\"
67 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
68 .\" Fear. Run. Save yourself. No user-serviceable parts.
69 . \" fudge factors for nroff and troff
70 .if n \{\
71 . ds #H 0
72 . ds #V .8m
73 . ds #F .3m
74 . ds #[ \f1
75 . ds #] \fP
76 .\}
77 .if t \{\
78 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
79 . ds #V .6m
80 . ds #F 0
81 . ds #[ \&
82 . ds #] \&
83 .\}
84 . \" simple accents for nroff and troff
85 .if n \{\
86 . ds ' \&
87 . ds ` \&
88 . ds ^ \&
89 . ds , \&
90 . ds ~ ~
91 . ds /
92 .\}
93 .if t \{\
94 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
95 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
96 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
97 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
98 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
99 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
100 .\}
101 . \" troff and (daisy-wheel) nroff accents
102 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
103 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
104 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
105 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
106 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
107 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
108 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
109 .ds ae a\h'-(\w'a'u*4/10)'e
110 .ds Ae A\h'-(\w'A'u*4/10)'E
111 . \" corrections for vroff
112 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
113 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
114 . \" for low resolution devices (crt and lpr)
115 .if \n(.H>23 .if \n(.V>19 \
116 \{\
117 . ds : e
118 . ds 8 ss
119 . ds o a
120 . ds d- d\h'-1'\(ga
121 . ds D- D\h'-1'\(hy
122 . ds th \o'bp'
123 . ds Th \o'LP'
124 . ds ae ae
125 . ds Ae AE
126 .\}
127 .rm #[ #] #H #V #F C
128 .\" ========================================================================
129 .\"
130 .IX Title "IBTOPODIFF 1"
131 .TH IBTOPODIFF 1 "2008-06-16" "IBDM 1.0" "IB DATA MODEL PACKAGE"
132 .SH "NAME"
133 \&\fBibtoopdiff \- Fabric Topology Matcher\fR
134 .SH "SYNOPSYS"
135 .IX Header "SYNOPSYS"
136 ibtopodiff [\-v][\-h] \-t <topo file> \-d <subnet file> \-s <start node name>
137 \-p <start port num> \-g <start port guid>
138 .SH "DESCRIPTION"
139 .IX Header "DESCRIPTION"
140 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).
141 .SH "ARGUMENTS"
142 .IX Header "ARGUMENTS"
143 .RE
144 .IP "\-t|\-\-topology <file>"
145 .IX Item "-t|--topology <file>"
146 Topology file. See man \fBibdm-topology-file\fR for its definition.
147 .RE
148 .IP "\-d|\-\-discovered <file>"
149 .IX Item "-d|--discovered <file>"
150 subnet.lst file produced by \fBOpenSM\fR or \fBibdiagnet\fR
151 .RE
152 .IP "\-s|\-\-start\-node <name>"
153 .IX Item "-s|--start-node <name>"
154 The name of the matching start node, also known as anchor node. E.g. H\-1/U1
155 .RE
156 .IP "\-p|\-\-port\-num <num>"
157 .IX Item "-p|--port-num <num>"
158 The number of the matching start port, also known as anchor port
159 .RE
160 .IP "\-g|\-\-port\-guid <guid>"
161 .IX Item "-g|--port-guid <guid>"
162 The guid of the matching start port
163 .SH "OPTIONS"
164 .IX Header "OPTIONS"
165 .RE
166 .IP "\-v|\-\-verbose"
167 .IX Item "-v|--verbose"
168 Verbsoe mode
169 .RE
170 .IP "\-h|\-\-help"
171 .IX Item "-h|--help"
172 Provides this help message
173 .SH "AUTHOR"
174 .IX Header "AUTHOR"
175 Eitan Zahavi, Mellanox Technologies \s-1LTD\s0, eitan@mellanox.co.il
+0
-2254
ibis/doc/ibis.1 less more
0 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
1 .\"
2 .\" Standard preamble:
3 .\" ========================================================================
4 .de Sh \" Subsection heading
5 .br
6 .if t .Sp
7 .ne 5
8 .PP
9 \fB\\$1\fR
10 .PP
11 ..
12 .de Sp \" Vertical space (when we can't use .PP)
13 .if t .sp .5v
14 .if n .sp
15 ..
16 .de Vb \" Begin verbatim text
17 .ft CW
18 .nf
19 .ne \\$1
20 ..
21 .de Ve \" End verbatim text
22 .ft R
23 .fi
24 ..
25 .\" Set up some character translations and predefined strings. \*(-- will
26 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
27 .\" double quote, and \*(R" will give a right double quote. | will give a
28 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
29 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
30 .\" expand to `' in nroff, nothing in troff, for use with C<>.
31 .tr \(*W-|\(bv\*(Tr
32 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
33 .ie n \{\
34 . ds -- \(*W-
35 . ds PI pi
36 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
37 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
38 . ds L" ""
39 . ds R" ""
40 . ds C` ""
41 . ds C' ""
42 'br\}
43 .el\{\
44 . ds -- \|\(em\|
45 . ds PI \(*p
46 . ds L" ``
47 . ds R" ''
48 'br\}
49 .\"
50 .\" If the F register is turned on, we'll generate index entries on stderr for
51 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
52 .\" entries marked with X<> in POD. Of course, you'll have to process the
53 .\" output yourself in some meaningful fashion.
54 .if \nF \{\
55 . de IX
56 . tm Index:\\$1\t\\n%\t"\\$2"
57 ..
58 . nr % 0
59 . rr F
60 .\}
61 .\"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .hy 0
65 .if n .na
66 .\"
67 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
68 .\" Fear. Run. Save yourself. No user-serviceable parts.
69 . \" fudge factors for nroff and troff
70 .if n \{\
71 . ds #H 0
72 . ds #V .8m
73 . ds #F .3m
74 . ds #[ \f1
75 . ds #] \fP
76 .\}
77 .if t \{\
78 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
79 . ds #V .6m
80 . ds #F 0
81 . ds #[ \&
82 . ds #] \&
83 .\}
84 . \" simple accents for nroff and troff
85 .if n \{\
86 . ds ' \&
87 . ds ` \&
88 . ds ^ \&
89 . ds , \&
90 . ds ~ ~
91 . ds /
92 .\}
93 .if t \{\
94 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
95 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
96 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
97 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
98 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
99 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
100 .\}
101 . \" troff and (daisy-wheel) nroff accents
102 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
103 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
104 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
105 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
106 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
107 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
108 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
109 .ds ae a\h'-(\w'a'u*4/10)'e
110 .ds Ae A\h'-(\w'A'u*4/10)'E
111 . \" corrections for vroff
112 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
113 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
114 . \" for low resolution devices (crt and lpr)
115 .if \n(.H>23 .if \n(.V>19 \
116 \{\
117 . ds : e
118 . ds 8 ss
119 . ds o a
120 . ds d- d\h'-1'\(ga
121 . ds D- D\h'-1'\(hy
122 . ds th \o'bp'
123 . ds Th \o'LP'
124 . ds ae ae
125 . ds Ae AE
126 .\}
127 .rm #[ #] #H #V #F C
128 .\" ========================================================================
129 .\"
130 .IX Title "IBIS 1"
131 .TH IBIS 1 "2008-06-16" "IBIS 1.0" "IB MANAGEMENT IN-BAND SERVICES PACKAGE"
132 .SH "NAME"
133 \&\fBibis\fR \- IB management Inband Services \- an extended TCL shell
134 .SH "SYNOPSYS"
135 .IX Header "SYNOPSYS"
136 ibis [\-port_num <port number to attach to>]
137 .SH "DESCRIPTION"
138 .IX Header "DESCRIPTION"
139 \&\fBibis\fR is a \s-1TCL\s0 shell extended with interface for sending and receiving \s-1IB\s0 management datagrams (\s-1MADS\s0).
140 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.
141 .PP
142 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.
143 .SH "IBIS Constants"
144 .IX Header "IBIS Constants"
145 These constants are provided by \s-1IBIS:\s0
146 .Sh "Log Verbosity Flags"
147 .IX Subsection "Log Verbosity Flags"
148 .ie n .IP "[ Constant : int ] $IBIS_LOG_NONE = 0x00" 4
149 .el .IP "[ Constant : int ] \f(CW$IBIS_LOG_NONE\fR = 0x00" 4
150 .IX Item "[ Constant : int ] $IBIS_LOG_NONE = 0x00"
151 .PD 0
152 .ie n .IP "[ Constant : int ] $IBIS_LOG_ERROR = 0x01" 4
153 .el .IP "[ Constant : int ] \f(CW$IBIS_LOG_ERROR\fR = 0x01" 4
154 .IX Item "[ Constant : int ] $IBIS_LOG_ERROR = 0x01"
155 .ie n .IP "[ Constant : int ] $IBIS_LOG_INFO = 0x02" 4
156 .el .IP "[ Constant : int ] \f(CW$IBIS_LOG_INFO\fR = 0x02" 4
157 .IX Item "[ Constant : int ] $IBIS_LOG_INFO = 0x02"
158 .ie n .IP "[ Constant : int ] $IBIS_LOG_VERBOSE = 0x04" 4
159 .el .IP "[ Constant : int ] \f(CW$IBIS_LOG_VERBOSE\fR = 0x04" 4
160 .IX Item "[ Constant : int ] $IBIS_LOG_VERBOSE = 0x04"
161 .ie n .IP "[ Constant : int ] $IBIS_LOG_DEBUG = 0x08" 4
162 .el .IP "[ Constant : int ] \f(CW$IBIS_LOG_DEBUG\fR = 0x08" 4
163 .IX Item "[ Constant : int ] $IBIS_LOG_DEBUG = 0x08"
164 .ie n .IP "[ Constant : int ] $IBIS_LOG_FUNCS = 0x10" 4
165 .el .IP "[ Constant : int ] \f(CW$IBIS_LOG_FUNCS\fR = 0x10" 4
166 .IX Item "[ Constant : int ] $IBIS_LOG_FUNCS = 0x10"
167 .ie n .IP "[ Constant : int ] $IBIS_LOG_FRAMES = 0x20" 4
168 .el .IP "[ Constant : int ] \f(CW$IBIS_LOG_FRAMES\fR = 0x20" 4
169 .IX Item "[ Constant : int ] $IBIS_LOG_FRAMES = 0x20"
170 .PD
171 .SH "IBIS Functions"
172 .IX Header "IBIS Functions"
173 This section provide the details about the functions \s-1IBIS\s0 exposes.
174 They all return 0 on succes.
175 .IP "[return list] ibis_get_local_ports_info" 4
176 .IX Item "[return list] ibis_get_local_ports_info"
177 Return the list of available \s-1IB\s0 ports with \s-1GUID\s0, \s-1LID\s0, state and port number.
178 .IP "[ returns int ] ibis_init" 4
179 .IX Item "[ returns int ] ibis_init"
180 Initialize ibis object
181 .IP "[ returns int ] ibis_set_verbosity level" 4
182 .IX Item "[ returns int ] ibis_set_verbosity level"
183 Change the log verbosity
184 .IP "[ returns int ] ibis_set_port guid" 4
185 .IX Item "[ returns int ] ibis_set_port guid"
186 Set the port \s-1IBIS\s0 is attached to and initialize all sub packages.
187 Must be called once during ibis operation.
188 .IP "[ returns new_uint64_t ] ibis_get_port" 4
189 .IX Item "[ returns new_uint64_t ] ibis_get_port"
190 Provide the \s-1GUID\s0 of the port \s-1IBIS\s0 is attached to
191 .IP "[ returns int ] ibis_set_transaction_timeout timeout_ms" 4
192 .IX Item "[ returns int ] ibis_set_transaction_timeout timeout_ms"
193 Set the transaction time out in [msec]
194 .IP "[ returns int ] ibis_exit" 4
195 .IX Item "[ returns int ] ibis_exit"
196 Exit \s-1IBIS\s0.
197 .IP "[ returns int ] ibis_puts verbosity msg" 4
198 .IX Item "[ returns int ] ibis_puts verbosity msg"
199 Appends a message to the OpenSM log
200 .Sh "\s-1IBIS\s0 Options Object"
201 .IX Subsection "IBIS Options Object"
202 .RS 4
203 The \s-1IBIS\s0 options are available through the predefined object: ibis_opts.
204 It can be manipulated using the standard Tcl methods: cget and configure.
205 Examples:
206 .Sp
207 .Vb 1
208 \& ibis_opts cget -force_log_flush
209 .Ve
210 .Sp
211 .Vb 1
212 \& ibis_opts configure -force_log_flush TRUE
213 .Ve
214 .Sp
215 The following are the different options that can be configured:
216 .RE
217 .IP "[ Member data: returns boolean_t * ] \-single_thread" 4
218 .IX Item "[ Member data: returns boolean_t * ] -single_thread"
219 Run single threaded
220 .IP "[ Member data: returns boolean_t * ] \-force_log_flush" 4
221 .IX Item "[ Member data: returns boolean_t * ] -force_log_flush"
222 If \s-1TRUE\s0 \- forces flash after each log message (\s-1TRUE\s0).
223 .IP "[ Member data: returns uint8_t * ] \-log_flags" 4
224 .IX Item "[ Member data: returns uint8_t * ] -log_flags"
225 The log levels to be used
226 .IP "[ Member data: returns char * ] \-log_file" 4
227 .IX Item "[ Member data: returns char * ] -log_file"
228 The name of the log file to be used.Must be configured before \fBibis_init\fR
229 is used to make an affect
230 .IP "[ Member data: returns uint64_t * ] \-sm_key" 4
231 .IX Item "[ Member data: returns uint64_t * ] -sm_key"
232 The SM_Key to be used when sending SubnetMgt and SubnetAdmin MADs
233 .IP "[ Member data: returns uint64_t * ] \-m_key" 4
234 .IX Item "[ Member data: returns uint64_t * ] -m_key"
235 The M_Key to be used when sending SubnetMgt
236 .IP "[ Member data: returns uint64_t * ] \-v_key" 4
237 .IX Item "[ Member data: returns uint64_t * ] -v_key"
238 The Vendor Key to be used when sending Vendor Specific MADs.
239 .SH "IBPM"
240 .IX Header "IBPM"
241 \&\s-1IBPM\s0 stands for \s-1IB\s0 Performance Monitoring MADs. \s-1IB\s0 provides standard facilities for tracking statistics on every port.
242 .Sp
243 This section provide the details about the functions \s-1IBPM\s0 exposes.
244 They all return 0 on succes.
245 .IP "[ returns int ] pmMultiMaxGet" 4
246 .IX Item "[ returns int ] pmMultiMaxGet"
247 Obtain the maximal number of parallel queries that can be sent
248 .IP "[ returns int ] pmGetPortCounters lid port_select" 4
249 .IX Item "[ returns int ] pmGetPortCounters lid port_select"
250 Send a \*(L"PortCounters\*(R" query to teh given \s-1LID\s0 and port
251 .IP "[ returns int ] pmGetPortCountersMulti num lid_list port_select_list" 4
252 .IX Item "[ returns int ] pmGetPortCountersMulti num lid_list port_select_list"
253 Send a batch of \*(L"PortCounters\*(R" queries to the given list of LIDs and ports.
254 num \- defines the number of elements in each list.
255 .IP "[ returns int ] pmGetExtPortCountersMulti num lid_list port_select_list" 4
256 .IX Item "[ returns int ] pmGetExtPortCountersMulti num lid_list port_select_list"
257 Send a batch of \*(L"ExtendedPortCounters\*(R" queries to the given list of LIDs and ports.
258 num \- defines the number of elements in each list.
259 .IP "[ returns int ] pmClrAllCounters lid port_select" 4
260 .IX Item "[ returns int ] pmClrAllCounters lid port_select"
261 Sends a command to \*(L"clear all counters\*(R" on the given \s-1LID\s0 and port
262 .IP "[ returns int ] pmClrAllCountersMulti num lid_list port_select_list" 4
263 .IX Item "[ returns int ] pmClrAllCountersMulti num lid_list port_select_list"
264 Send a batch of \*(L"clear all counters\*(R" commands to the given list of LIDs and ports.
265 num \- defines the number of elements in each list.
266 .SH "IBSAC"
267 .IX Header "IBSAC"
268 \&\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
269 .Sp
270 The following sections describe the concepts behind the \s-1SAC\s0 interface and then provides detailed description of each attribute that can be queried.
271 .Sh "\s-1IBSAC\s0 Objects"
272 .IX Subsection "IBSAC Objects"
273 .RS 4
274 \&\s-1IBSAC\s0 uses predefined global objects to facilitate \s-1SA\s0 Queries.
275 Such objects are named sac<Attribute>Query. Each such object
276 exposes a standard set of methods:
277 .RE
278 .IP "dump" 4
279 .IX Item "dump"
280 dump out all fields and values for the obejct
281 .IP "cget \-<field>:" 4
282 .IX Item "cget -<field>:"
283 obtain the value of the given field
284 .IP "configure \-<field> <value>:" 4
285 .IX Item "configure -<field> <value>:"
286 set the field value
287 .IP "get <comp mask>:" 4
288 .IX Item "get <comp mask>:"
289 query the \s-1SA\s0 for one record using the component mask and field values as set on the query object
290 .IP "getTable <comp mask>:" 4
291 .IX Item "getTable <comp mask>:"
292 query the \s-1SA\s0 for all records matching component mask and field values as set on the query object
293 .Sp
294 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:
295 .IP "set <comp mask>:" 4
296 .IX Item "set <comp mask>:"
297 send a \fBset\fR method to the \s-1SA\s0 with the component mask and field values as set on the query object
298 .IP "delete <comp mask>:" 4
299 .IX Item "delete <comp mask>:"
300 send a \fBdelete\fR method to the \s-1SA\s0 with the component mask and field values as set on the query object
301 .Sh "Returned Objects"
302 .IX Subsection "Returned Objects"
303 This section describes the values returned from the get/getTable/set/delete methods of the query objects:
304 .Sp
305 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:
306 .Sp
307 Queries embedding Subnet Management Attributes:
308 .IP "ni:<idx> = node info" 4
309 .IX Item "ni:<idx> = node info"
310 .PD 0
311 .IP "nr:<idx> = node info record (\s-1SA\s0 \s-1RID\s0 + node info)" 4
312 .IX Item "nr:<idx> = node info record (SA RID + node info)"
313 .IP "pi:<idx> = port info" 4
314 .IX Item "pi:<idx> = port info"
315 .IP "pir:<idx> = port info record (\s-1SA\s0 \s-1RID\s0 + port info)" 4
316 .IX Item "pir:<idx> = port info record (SA RID + port info)"
317 .IP "smi:<idx> = \s-1SM\s0 info" 4
318 .IX Item "smi:<idx> = SM info"
319 .IP "smir:<idx> = \s-1SM\s0 info record (\s-1SA\s0 \s-1RID\s0 + \s-1SM\s0 info)" 4
320 .IX Item "smir:<idx> = SM info record (SA RID + SM info)"
321 .IP "swi:<idx> = switch info" 4
322 .IX Item "swi:<idx> = switch info"
323 .IP "swir:<idx> = switch info record (\s-1SA\s0 \s-1RID\s0 + switch info)" 4
324 .IX Item "swir:<idx> = switch info record (SA RID + switch info)"
325 .IP "slvt:<idx> = \s-1SL\s0 to \s-1VL\s0 table" 4
326 .IX Item "slvt:<idx> = SL to VL table"
327 .IP "slvr:<idx> = \s-1SL\s0 to \s-1VL\s0 table Record (\s-1SA\s0 \s-1RID\s0 + \s-1SL\s0 to \s-1VL\s0 table)" 4
328 .IX Item "slvr:<idx> = SL to VL table Record (SA RID + SL to VL table)"
329 .IP "pkt:<idx> = PKey table" 4
330 .IX Item "pkt:<idx> = PKey table"
331 .IP "pkr:<idx> = PKey table record (\s-1SA\s0 \s-1RID\s0 + PKey table)" 4
332 .IX Item "pkr:<idx> = PKey table record (SA RID + PKey table)"
333 .PD
334 Queries of non embedded attributes:
335 .IP "link:<idx> = link record" 4
336 .IX Item "link:<idx> = link record"
337 .PD 0
338 .IP "path:<idx> = path record" 4
339 .IX Item "path:<idx> = path record"
340 .IP "lft:<idx> = Linear forwarding table" 4
341 .IX Item "lft:<idx> = Linear forwarding table"
342 .IP "mcm:<idx> = Multicast Member Record" 4
343 .IX Item "mcm:<idx> = Multicast Member Record"
344 .IP "cpi:<idx> = \s-1SA\s0 Class Port Info" 4
345 .IX Item "cpi:<idx> = SA Class Port Info"
346 .IP "info:<idx> = Inform info (registration of event forwarding)" 4
347 .IX Item "info:<idx> = Inform info (registration of event forwarding)"
348 .IP "svc:<idx> = Service Record" 4
349 .IX Item "svc:<idx> = Service Record"
350 .IP "vlarb:<idx>= \s-1VL\s0 Arbitration table record" 4
351 .IX Item "vlarb:<idx>= VL Arbitration table record"
352 .PD
353 .Sh "\s-1NODE\s0 \s-1INFO\s0 \s-1RECORD\s0"
354 .IX Subsection "NODE INFO RECORD"
355 .RS 4
356 Component mask bits:
357 .RE
358 .ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_LID = 0x1" 4
359 .el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_LID\fR = 0x1" 4
360 .IX Item "[ Constant : int ] $IB_NR_COMPMASK_LID = 0x1"
361 .PD 0
362 .ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_RESERVED1 = 0x2" 4
363 .el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_RESERVED1\fR = 0x2" 4
364 .IX Item "[ Constant : int ] $IB_NR_COMPMASK_RESERVED1 = 0x2"
365 .ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_BASEVERSION = 0x4" 4
366 .el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_BASEVERSION\fR = 0x4" 4
367 .IX Item "[ Constant : int ] $IB_NR_COMPMASK_BASEVERSION = 0x4"
368 .ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_CLASSVERSION = 0x8" 4
369 .el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_CLASSVERSION\fR = 0x8" 4
370 .IX Item "[ Constant : int ] $IB_NR_COMPMASK_CLASSVERSION = 0x8"
371 .ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_NODETYPE = 0x10" 4
372 .el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_NODETYPE\fR = 0x10" 4
373 .IX Item "[ Constant : int ] $IB_NR_COMPMASK_NODETYPE = 0x10"
374 .ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_NUMPORTS = 0x20" 4
375 .el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_NUMPORTS\fR = 0x20" 4
376 .IX Item "[ Constant : int ] $IB_NR_COMPMASK_NUMPORTS = 0x20"
377 .ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_SYSIMAGEGUID = 0x40" 4
378 .el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_SYSIMAGEGUID\fR = 0x40" 4
379 .IX Item "[ Constant : int ] $IB_NR_COMPMASK_SYSIMAGEGUID = 0x40"
380 .ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_NODEGUID = 0x80" 4
381 .el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_NODEGUID\fR = 0x80" 4
382 .IX Item "[ Constant : int ] $IB_NR_COMPMASK_NODEGUID = 0x80"
383 .ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_PORTGUID = 0x100" 4
384 .el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_PORTGUID\fR = 0x100" 4
385 .IX Item "[ Constant : int ] $IB_NR_COMPMASK_PORTGUID = 0x100"
386 .ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_PARTCAP = 0x200" 4
387 .el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_PARTCAP\fR = 0x200" 4
388 .IX Item "[ Constant : int ] $IB_NR_COMPMASK_PARTCAP = 0x200"
389 .ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_DEVID = 0x400" 4
390 .el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_DEVID\fR = 0x400" 4
391 .IX Item "[ Constant : int ] $IB_NR_COMPMASK_DEVID = 0x400"
392 .ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_REV = 0x800" 4
393 .el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_REV\fR = 0x800" 4
394 .IX Item "[ Constant : int ] $IB_NR_COMPMASK_REV = 0x800"
395 .ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_PORTNUM = 0x1000" 4
396 .el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_PORTNUM\fR = 0x1000" 4
397 .IX Item "[ Constant : int ] $IB_NR_COMPMASK_PORTNUM = 0x1000"
398 .ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_VENDID = 0x2000" 4
399 .el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_VENDID\fR = 0x2000" 4
400 .IX Item "[ Constant : int ] $IB_NR_COMPMASK_VENDID = 0x2000"
401 .ie n .IP "[ Constant : int ] $IB_NR_COMPMASK_NODEDESC = 0x4000" 4
402 .el .IP "[ Constant : int ] \f(CW$IB_NR_COMPMASK_NODEDESC\fR = 0x4000" 4
403 .IX Item "[ Constant : int ] $IB_NR_COMPMASK_NODEDESC = 0x4000"
404 .PD
405 \&\-\-\-\-
406 .Sp
407 \fIclass sacNodeInfo\fR
408 .IX Subsection "class sacNodeInfo"
409 .Sp
410 Fields:
411 .IP "[ Member data: returns uint8_t * ] \-base_version" 4
412 .IX Item "[ Member data: returns uint8_t * ] -base_version"
413 .PD 0
414 .IP "[ Member data: returns uint8_t * ] \-class_version" 4
415 .IX Item "[ Member data: returns uint8_t * ] -class_version"
416 .IP "[ Member data: returns uint8_t * ] \-node_type" 4
417 .IX Item "[ Member data: returns uint8_t * ] -node_type"
418 .IP "[ Member data: returns uint8_t * ] \-num_ports" 4
419 .IX Item "[ Member data: returns uint8_t * ] -num_ports"
420 .IP "[ Member data: returns ib_net64_t * ] \-sys_guid" 4
421 .IX Item "[ Member data: returns ib_net64_t * ] -sys_guid"
422 .IP "[ Member data: returns ib_net64_t * ] \-node_guid" 4
423 .IX Item "[ Member data: returns ib_net64_t * ] -node_guid"
424 .IP "[ Member data: returns ib_net64_t * ] \-port_guid" 4
425 .IX Item "[ Member data: returns ib_net64_t * ] -port_guid"
426 .IP "[ Member data: returns ib_net16_t * ] \-partition_cap" 4
427 .IX Item "[ Member data: returns ib_net16_t * ] -partition_cap"
428 .IP "[ Member data: returns ib_net16_t * ] \-device_id" 4
429 .IX Item "[ Member data: returns ib_net16_t * ] -device_id"
430 .IP "[ Member data: returns ib_net32_t * ] \-revision" 4
431 .IX Item "[ Member data: returns ib_net32_t * ] -revision"
432 .IP "[ Member data: returns ib_net32_t * ] \-port_num_vendor_id" 4
433 .IX Item "[ Member data: returns ib_net32_t * ] -port_num_vendor_id"
434 .IP "[ Member : returns void ] delete" 4
435 .IX Item "[ Member : returns void ] delete"
436 .PD
437 \&\-\-\-\-
438 .Sp
439 \fIclass sacNodeRec\fR
440 .IX Subsection "class sacNodeRec"
441 .Sp
442 \&\s-1RID\s0 Fields:
443 .IP "[ Member data: returns ib_net16_t * ] \-lid" 4
444 .IX Item "[ Member data: returns ib_net16_t * ] -lid"
445 .PD 0
446 .IP "[ Member data: returns sacNodeInfo * ] \-node_info" 4
447 .IX Item "[ Member data: returns sacNodeInfo * ] -node_info"
448 .IP "[ Member data: returns ib_node_desc_t * ] \-node_desc" 4
449 .IX Item "[ Member data: returns ib_node_desc_t * ] -node_desc"
450 .PD
451 Methods:
452 .IP "[ Member : returns char * ] get comp_mask" 4
453 .IX Item "[ Member : returns char * ] get comp_mask"
454 .PD 0
455 .IP "[ Member : returns char * ] getTable comp_mask" 4
456 .IX Item "[ Member : returns char * ] getTable comp_mask"
457 .IP "[ Member : returns void ] delete" 4
458 .IX Item "[ Member : returns void ] delete"
459 .PD
460 .Sh "\s-1PORT\s0 \s-1INFO\s0 \s-1RECORD\s0"
461 .IX Subsection "PORT INFO RECORD"
462 .RS 4
463 Component mask bits:
464 .RE
465 .ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_LID = 0x1" 4
466 .el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_LID\fR = 0x1" 4
467 .IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_LID = 0x1"
468 .PD 0
469 .ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_PORTNUM = 0x2" 4
470 .el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_PORTNUM\fR = 0x2" 4
471 .IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_PORTNUM = 0x2"
472 .ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_RESV1 = 0x4" 4
473 .el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_RESV1\fR = 0x4" 4
474 .IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_RESV1 = 0x4"
475 .ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_MKEY = 0x8" 4
476 .el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_MKEY\fR = 0x8" 4
477 .IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_MKEY = 0x8"
478 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_GIDPRE = 0x10" 4
479 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_GIDPRE\fR = 0x10" 4
480 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_GIDPRE = 0x10"
481 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_BASELID = 0x20" 4
482 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_BASELID\fR = 0x20" 4
483 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_BASELID = 0x20"
484 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_SMLID = 0x40" 4
485 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_SMLID\fR = 0x40" 4
486 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_SMLID = 0x40"
487 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_CAPMASK = 0x80" 4
488 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_CAPMASK\fR = 0x80" 4
489 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_CAPMASK = 0x80"
490 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_DIAGCODE = 0x100" 4
491 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_DIAGCODE\fR = 0x100" 4
492 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_DIAGCODE = 0x100"
493 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_MKEYLEASEPRD = 0x200" 4
494 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_MKEYLEASEPRD\fR = 0x200" 4
495 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_MKEYLEASEPRD = 0x200"
496 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_LOCALPORTNUM = 0x400" 4
497 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_LOCALPORTNUM\fR = 0x400" 4
498 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_LOCALPORTNUM = 0x400"
499 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_LNKWIDTHSUPPORT = 0x800" 4
500 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_LNKWIDTHSUPPORT\fR = 0x800" 4
501 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_LNKWIDTHSUPPORT = 0x800"
502 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_LNKWIDTHACTIVE = 0x1000" 4
503 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_LNKWIDTHACTIVE\fR = 0x1000" 4
504 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_LNKWIDTHACTIVE = 0x1000"
505 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_LINKWIDTHENABLED = 0x2000" 4
506 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_LINKWIDTHENABLED\fR = 0x2000" 4
507 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_LINKWIDTHENABLED = 0x2000"
508 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_LNKSPEEDSUPPORT = 0x4000" 4
509 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_LNKSPEEDSUPPORT\fR = 0x4000" 4
510 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_LNKSPEEDSUPPORT = 0x4000"
511 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_PORTSTATE = 0x10000" 4
512 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_PORTSTATE\fR = 0x10000" 4
513 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_PORTSTATE = 0x10000"
514 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_PORTPHYSTATE = 0x20000" 4
515 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_PORTPHYSTATE\fR = 0x20000" 4
516 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_PORTPHYSTATE = 0x20000"
517 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_LINKDWNDFLTSTATE = 0x40000" 4
518 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_LINKDWNDFLTSTATE\fR = 0x40000" 4
519 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_LINKDWNDFLTSTATE = 0x40000"
520 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_MKEYPROTBITS = 0x80000" 4
521 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_MKEYPROTBITS\fR = 0x80000" 4
522 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_MKEYPROTBITS = 0x80000"
523 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_LMC = 0x100000" 4
524 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_LMC\fR = 0x100000" 4
525 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_LMC = 0x100000"
526 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_LINKSPEEDACTIVE = 0x200000" 4
527 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_LINKSPEEDACTIVE\fR = 0x200000" 4
528 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_LINKSPEEDACTIVE = 0x200000"
529 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_LINKSPEEDENABLE = 0x400000" 4
530 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_LINKSPEEDENABLE\fR = 0x400000" 4
531 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_LINKSPEEDENABLE = 0x400000"
532 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_NEIGHBORMTU = 0x800000" 4
533 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_NEIGHBORMTU\fR = 0x800000" 4
534 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_NEIGHBORMTU = 0x800000"
535 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_MASTERSMSL = 0x1000000" 4
536 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_MASTERSMSL\fR = 0x1000000" 4
537 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_MASTERSMSL = 0x1000000"
538 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_VLCAP = 0x2000000" 4
539 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_VLCAP\fR = 0x2000000" 4
540 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_VLCAP = 0x2000000"
541 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_INITTYPE = 0x4000000" 4
542 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_INITTYPE\fR = 0x4000000" 4
543 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_INITTYPE = 0x4000000"
544 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_VLHIGHLIMIT = 0x8000000" 4
545 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_VLHIGHLIMIT\fR = 0x8000000" 4
546 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_VLHIGHLIMIT = 0x8000000"
547 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_VLARBHIGHCAP = 0x10000000" 4
548 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_VLARBHIGHCAP\fR = 0x10000000" 4
549 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_VLARBHIGHCAP = 0x10000000"
550 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_VLARBLOWCAP = 0x20000000" 4
551 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_VLARBLOWCAP\fR = 0x20000000" 4
552 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_VLARBLOWCAP = 0x20000000"
553 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_INITTYPEREPLY = 0x40000000" 4
554 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_INITTYPEREPLY\fR = 0x40000000" 4
555 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_INITTYPEREPLY = 0x40000000"
556 .ie n .IP "[ Constant : int ] $IB_PIR_COMPMASK_MTUCAP = 0x80000000" 4
557 .el .IP "[ Constant : int ] \f(CW$IB_PIR_COMPMASK_MTUCAP\fR = 0x80000000" 4
558 .IX Item "[ Constant : int ] $IB_PIR_COMPMASK_MTUCAP = 0x80000000"
559 .ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_VLSTALLCNT = 0x100000000" 4
560 .el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_VLSTALLCNT\fR = 0x100000000" 4
561 .IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_VLSTALLCNT = 0x100000000"
562 .ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_HOQLIFE = 0x200000000" 4
563 .el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_HOQLIFE\fR = 0x200000000" 4
564 .IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_HOQLIFE = 0x200000000"
565 .ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_OPVLS = 0x400000000" 4
566 .el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_OPVLS\fR = 0x400000000" 4
567 .IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_OPVLS = 0x400000000"
568 .ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_PARENFIN = 0x800000000" 4
569 .el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_PARENFIN\fR = 0x800000000" 4
570 .IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_PARENFIN = 0x800000000"
571 .ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_PARENFOUT = 0x1000000000" 4
572 .el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_PARENFOUT\fR = 0x1000000000" 4
573 .IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_PARENFOUT = 0x1000000000"
574 .ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_FILTERRAWIN = 0x2000000000" 4
575 .el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_FILTERRAWIN\fR = 0x2000000000" 4
576 .IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_FILTERRAWIN = 0x2000000000"
577 .ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_FILTERRAWOUT = 0x4000000000" 4
578 .el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_FILTERRAWOUT\fR = 0x4000000000" 4
579 .IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_FILTERRAWOUT = 0x4000000000"
580 .ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_MKEYVIO = 0x8000000000" 4
581 .el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_MKEYVIO\fR = 0x8000000000" 4
582 .IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_MKEYVIO = 0x8000000000"
583 .ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_PKEYVIO = 0x10000000000" 4
584 .el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_PKEYVIO\fR = 0x10000000000" 4
585 .IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_PKEYVIO = 0x10000000000"
586 .ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_QKEYVIO = 0x20000000000" 4
587 .el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_QKEYVIO\fR = 0x20000000000" 4
588 .IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_QKEYVIO = 0x20000000000"
589 .ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_GUIDCAP = 0x40000000000" 4
590 .el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_GUIDCAP\fR = 0x40000000000" 4
591 .IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_GUIDCAP = 0x40000000000"
592 .ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_RESV2 = 0x80000000000" 4
593 .el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_RESV2\fR = 0x80000000000" 4
594 .IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_RESV2 = 0x80000000000"
595 .ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_SUBNTO = 0x100000000000" 4
596 .el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_SUBNTO\fR = 0x100000000000" 4
597 .IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_SUBNTO = 0x100000000000"
598 .ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_RESV3 = 0x200000000000" 4
599 .el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_RESV3\fR = 0x200000000000" 4
600 .IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_RESV3 = 0x200000000000"
601 .ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_RESPTIME = 0x400000000000" 4
602 .el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_RESPTIME\fR = 0x400000000000" 4
603 .IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_RESPTIME = 0x400000000000"
604 .ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_LOCALPHYERR = 0x800000000000" 4
605 .el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_LOCALPHYERR\fR = 0x800000000000" 4
606 .IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_LOCALPHYERR = 0x800000000000"
607 .ie n .IP "[ Constant : char * ] $IB_PIR_COMPMASK_OVERRUNERR = 0x1000000000000" 4
608 .el .IP "[ Constant : char * ] \f(CW$IB_PIR_COMPMASK_OVERRUNERR\fR = 0x1000000000000" 4
609 .IX Item "[ Constant : char * ] $IB_PIR_COMPMASK_OVERRUNERR = 0x1000000000000"
610 .PD
611 \&\-\-\-\-
612 .Sp
613 \fIclass sacPortInfo\fR
614 .IX Subsection "class sacPortInfo"
615 .Sp
616 Fields:
617 .IP "[ Member data: returns ib_net64_t * ] \-m_key" 4
618 .IX Item "[ Member data: returns ib_net64_t * ] -m_key"
619 .PD 0
620 .IP "[ Member data: returns ib_net64_t * ] \-subnet_prefix" 4
621 .IX Item "[ Member data: returns ib_net64_t * ] -subnet_prefix"
622 .IP "[ Member data: returns ib_net16_t * ] \-base_lid" 4
623 .IX Item "[ Member data: returns ib_net16_t * ] -base_lid"
624 .IP "[ Member data: returns ib_net16_t * ] \-master_sm_base_lid" 4
625 .IX Item "[ Member data: returns ib_net16_t * ] -master_sm_base_lid"
626 .IP "[ Member data: returns ib_net32_t * ] \-capability_mask" 4
627 .IX Item "[ Member data: returns ib_net32_t * ] -capability_mask"
628 .IP "[ Member data: returns ib_net16_t * ] \-diag_code" 4
629 .IX Item "[ Member data: returns ib_net16_t * ] -diag_code"
630 .IP "[ Member data: returns ib_net16_t * ] \-m_key_lease_period" 4
631 .IX Item "[ Member data: returns ib_net16_t * ] -m_key_lease_period"
632 .IP "[ Member data: returns uint8_t * ] \-local_port_num" 4
633 .IX Item "[ Member data: returns uint8_t * ] -local_port_num"
634 .IP "[ Member data: returns uint8_t * ] \-link_width_enabled" 4
635 .IX Item "[ Member data: returns uint8_t * ] -link_width_enabled"
636 .IP "[ Member data: returns uint8_t * ] \-link_width_supported" 4
637 .IX Item "[ Member data: returns uint8_t * ] -link_width_supported"
638 .IP "[ Member data: returns uint8_t * ] \-link_width_active" 4
639 .IX Item "[ Member data: returns uint8_t * ] -link_width_active"
640 .IP "[ Member data: returns uint8_t * ] \-state_info1" 4
641 .IX Item "[ Member data: returns uint8_t * ] -state_info1"
642 .PD
643 LinkSpeedSupported and PortState
644 .IP "[ Member data: returns uint8_t * ] \-state_info2" 4
645 .IX Item "[ Member data: returns uint8_t * ] -state_info2"
646 PortPhysState and LinkDownDefaultState
647 .IP "[ Member data: returns uint8_t * ] \-mkey_lmc" 4
648 .IX Item "[ Member data: returns uint8_t * ] -mkey_lmc"
649 .PD 0
650 .IP "[ Member data: returns uint8_t * ] \-link_speed" 4
651 .IX Item "[ Member data: returns uint8_t * ] -link_speed"
652 .PD
653 LinkSpeedEnabled and LinkSpeedActive
654 .IP "[ Member data: returns uint8_t * ] \-mtu_smsl" 4
655 .IX Item "[ Member data: returns uint8_t * ] -mtu_smsl"
656 .PD 0
657 .IP "[ Member data: returns uint8_t * ] \-vl_cap" 4
658 .IX Item "[ Member data: returns uint8_t * ] -vl_cap"
659 .PD
660 VlCap and InitType
661 .IP "[ Member data: returns uint8_t * ] \-vl_high_limit" 4
662 .IX Item "[ Member data: returns uint8_t * ] -vl_high_limit"
663 .PD 0
664 .IP "[ Member data: returns uint8_t * ] \-vl_arb_high_cap" 4
665 .IX Item "[ Member data: returns uint8_t * ] -vl_arb_high_cap"
666 .IP "[ Member data: returns uint8_t * ] \-vl_arb_low_cap" 4
667 .IX Item "[ Member data: returns uint8_t * ] -vl_arb_low_cap"
668 .IP "[ Member data: returns uint8_t * ] \-mtu_cap" 4
669 .IX Item "[ Member data: returns uint8_t * ] -mtu_cap"
670 .IP "[ Member data: returns uint8_t * ] \-vl_stall_life" 4
671 .IX Item "[ Member data: returns uint8_t * ] -vl_stall_life"
672 .IP "[ Member data: returns uint8_t * ] \-vl_enforce" 4
673 .IX Item "[ Member data: returns uint8_t * ] -vl_enforce"
674 .IP "[ Member data: returns ib_net16_t * ] \-m_key_violations" 4
675 .IX Item "[ Member data: returns ib_net16_t * ] -m_key_violations"
676 .IP "[ Member data: returns ib_net16_t * ] \-p_key_violations" 4
677 .IX Item "[ Member data: returns ib_net16_t * ] -p_key_violations"
678 .IP "[ Member data: returns ib_net16_t * ] \-q_key_violations" 4
679 .IX Item "[ Member data: returns ib_net16_t * ] -q_key_violations"
680 .IP "[ Member data: returns uint8_t * ] \-guid_cap" 4
681 .IX Item "[ Member data: returns uint8_t * ] -guid_cap"
682 .IP "[ Member data: returns uint8_t * ] \-subnet_timeout" 4
683 .IX Item "[ Member data: returns uint8_t * ] -subnet_timeout"
684 .IP "[ Member data: returns uint8_t * ] \-resp_time_value" 4
685 .IX Item "[ Member data: returns uint8_t * ] -resp_time_value"
686 .IP "[ Member data: returns uint8_t * ] \-error_threshold" 4
687 .IX Item "[ Member data: returns uint8_t * ] -error_threshold"
688 .IP "[ Member : returns void ] delete" 4
689 .IX Item "[ Member : returns void ] delete"
690 .PD
691 \&\-\-\-\-
692 .Sp
693 \fIclass sacPortRec\fR
694 .IX Subsection "class sacPortRec"
695 .Sp
696 \&\s-1RID\s0 Fields:
697 .IP "[ Member data: returns ib_net16_t * ] \-lid" 4
698 .IX Item "[ Member data: returns ib_net16_t * ] -lid"
699 .PD 0
700 .IP "[ Member data: returns uint8_t * ] \-port_num" 4
701 .IX Item "[ Member data: returns uint8_t * ] -port_num"
702 .IP "[ Member data: returns sacPortInfo * ] \-port_info" 4
703 .IX Item "[ Member data: returns sacPortInfo * ] -port_info"
704 .PD
705 Methods:
706 .IP "[ Member : returns char * ] get comp_mask" 4
707 .IX Item "[ Member : returns char * ] get comp_mask"
708 .PD 0
709 .IP "[ Member : returns char * ] getTable comp_mask" 4
710 .IX Item "[ Member : returns char * ] getTable comp_mask"
711 .IP "[ Member : returns void ] delete" 4
712 .IX Item "[ Member : returns void ] delete"
713 .PD
714 .Sh "\s-1SM\s0 \s-1INFO\s0 \s-1RECORD\s0"
715 .IX Subsection "SM INFO RECORD"
716 .RS 4
717 Component mask bits:
718 .RE
719 .ie n .IP "[ Constant : char * ] $IB_SMR_COMPMASK_LID = 0x1" 4
720 .el .IP "[ Constant : char * ] \f(CW$IB_SMR_COMPMASK_LID\fR = 0x1" 4
721 .IX Item "[ Constant : char * ] $IB_SMR_COMPMASK_LID = 0x1"
722 .PD 0
723 .ie n .IP "[ Constant : char * ] $IB_SMR_COMPMASK_GUID = 0x2" 4
724 .el .IP "[ Constant : char * ] \f(CW$IB_SMR_COMPMASK_GUID\fR = 0x2" 4
725 .IX Item "[ Constant : char * ] $IB_SMR_COMPMASK_GUID = 0x2"
726 .ie n .IP "[ Constant : char * ] $IB_SMR_COMPMASK_SM_KEY = 0x4" 4
727 .el .IP "[ Constant : char * ] \f(CW$IB_SMR_COMPMASK_SM_KEY\fR = 0x4" 4
728 .IX Item "[ Constant : char * ] $IB_SMR_COMPMASK_SM_KEY = 0x4"
729 .ie n .IP "[ Constant : char * ] $IB_SMR_COMPMASK_ACT_COUNT = 0x8" 4
730 .el .IP "[ Constant : char * ] \f(CW$IB_SMR_COMPMASK_ACT_COUNT\fR = 0x8" 4
731 .IX Item "[ Constant : char * ] $IB_SMR_COMPMASK_ACT_COUNT = 0x8"
732 .ie n .IP "[ Constant : int ] $IB_SMR_COMPMASK_STATE = 0x10" 4
733 .el .IP "[ Constant : int ] \f(CW$IB_SMR_COMPMASK_STATE\fR = 0x10" 4
734 .IX Item "[ Constant : int ] $IB_SMR_COMPMASK_STATE = 0x10"
735 .ie n .IP "[ Constant : int ] $IB_SMR_COMPMASK_PRI = 0x20" 4
736 .el .IP "[ Constant : int ] \f(CW$IB_SMR_COMPMASK_PRI\fR = 0x20" 4
737 .IX Item "[ Constant : int ] $IB_SMR_COMPMASK_PRI = 0x20"
738 .PD
739 \&\-\-\-\-
740 .Sp
741 \fIclass sacSmInfo\fR
742 .IX Subsection "class sacSmInfo"
743 .Sp
744 Fields:
745 .IP "[ Member data: returns ib_net64_t * ] \-guid" 4
746 .IX Item "[ Member data: returns ib_net64_t * ] -guid"
747 .PD 0
748 .IP "[ Member data: returns ib_net64_t * ] \-sm_key" 4
749 .IX Item "[ Member data: returns ib_net64_t * ] -sm_key"
750 .IP "[ Member data: returns ib_net32_t * ] \-act_count" 4
751 .IX Item "[ Member data: returns ib_net32_t * ] -act_count"
752 .IP "[ Member data: returns uint8_t * ] \-pri_state" 4
753 .IX Item "[ Member data: returns uint8_t * ] -pri_state"
754 .IP "[ Member : returns void ] delete" 4
755 .IX Item "[ Member : returns void ] delete"
756 .PD
757 \&\-\-\-\-
758 .Sp
759 \fIclass sacSmRec\fR
760 .IX Subsection "class sacSmRec"
761 .Sp
762 \&\s-1RID\s0 Fields:
763 .IP "[ Member data: returns ib_net16_t * ] \-lid" 4
764 .IX Item "[ Member data: returns ib_net16_t * ] -lid"
765 .PD 0
766 .IP "[ Member data: returns sacSmInfo * ] \-sm_info" 4
767 .IX Item "[ Member data: returns sacSmInfo * ] -sm_info"
768 .PD
769 Methods:
770 .IP "[ Member : returns char * ] get comp_mask" 4
771 .IX Item "[ Member : returns char * ] get comp_mask"
772 .PD 0
773 .IP "[ Member : returns char * ] getTable comp_mask" 4
774 .IX Item "[ Member : returns char * ] getTable comp_mask"
775 .IP "[ Member : returns void ] delete" 4
776 .IX Item "[ Member : returns void ] delete"
777 .PD
778 .Sh "\s-1SWITCH\s0 \s-1INFO\s0 \s-1RECORD\s0"
779 .IX Subsection "SWITCH INFO RECORD"
780 .RS 4
781 Component mask bits:
782 .RE
783 .ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_LID = 0x1" 4
784 .el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_LID\fR = 0x1" 4
785 .IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_LID = 0x1"
786 .PD 0
787 .ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_LIN_CAP = 0x2" 4
788 .el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_LIN_CAP\fR = 0x2" 4
789 .IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_LIN_CAP = 0x2"
790 .ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_RAND_CAP = 0x4" 4
791 .el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_RAND_CAP\fR = 0x4" 4
792 .IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_RAND_CAP = 0x4"
793 .ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_MCAST_CAP = 0x8" 4
794 .el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_MCAST_CAP\fR = 0x8" 4
795 .IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_MCAST_CAP = 0x8"
796 .ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_LIN_TOP = 0x10" 4
797 .el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_LIN_TOP\fR = 0x10" 4
798 .IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_LIN_TOP = 0x10"
799 .ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_DEF_PORT = 0x20" 4
800 .el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_DEF_PORT\fR = 0x20" 4
801 .IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_DEF_PORT = 0x20"
802 .ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_DEF_MCAST_PRI = 0x40" 4
803 .el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_DEF_MCAST_PRI\fR = 0x40" 4
804 .IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_DEF_MCAST_PRI = 0x40"
805 .ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_DEF_MCAST_NOT = 0x80" 4
806 .el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_DEF_MCAST_NOT\fR = 0x80" 4
807 .IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_DEF_MCAST_NOT = 0x80"
808 .ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_STATE = 0x100" 4
809 .el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_STATE\fR = 0x100" 4
810 .IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_STATE = 0x100"
811 .ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_LIFE = 0x200" 4
812 .el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_LIFE\fR = 0x200" 4
813 .IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_LIFE = 0x200"
814 .ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_LMC = 0x400" 4
815 .el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_LMC\fR = 0x400" 4
816 .IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_LMC = 0x400"
817 .ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_ENFORCE_CAP = 0x800" 4
818 .el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_ENFORCE_CAP\fR = 0x800" 4
819 .IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_ENFORCE_CAP = 0x800"
820 .ie n .IP "[ Constant : char * ] $IB_SWR_COMPMASK_FLAGS = 0x1000" 4
821 .el .IP "[ Constant : char * ] \f(CW$IB_SWR_COMPMASK_FLAGS\fR = 0x1000" 4
822 .IX Item "[ Constant : char * ] $IB_SWR_COMPMASK_FLAGS = 0x1000"
823 .PD
824 \&\-\-\-\-
825 .Sp
826 \fIclass sacSwInfo\fR
827 .IX Subsection "class sacSwInfo"
828 .Sp
829 Fields:
830 .IP "[ Member data: returns ib_net16_t * ] \-lin_cap" 4
831 .IX Item "[ Member data: returns ib_net16_t * ] -lin_cap"
832 .PD 0
833 .IP "[ Member data: returns ib_net16_t * ] \-rand_cap" 4
834 .IX Item "[ Member data: returns ib_net16_t * ] -rand_cap"
835 .IP "[ Member data: returns ib_net16_t * ] \-mcast_cap" 4
836 .IX Item "[ Member data: returns ib_net16_t * ] -mcast_cap"
837 .IP "[ Member data: returns ib_net16_t * ] \-lin_top" 4
838 .IX Item "[ Member data: returns ib_net16_t * ] -lin_top"
839 .IP "[ Member data: returns uint8_t * ] \-def_port" 4
840 .IX Item "[ Member data: returns uint8_t * ] -def_port"
841 .IP "[ Member data: returns uint8_t * ] \-def_mcast_pri_port" 4
842 .IX Item "[ Member data: returns uint8_t * ] -def_mcast_pri_port"
843 .IP "[ Member data: returns uint8_t * ] \-def_mcast_not_port" 4
844 .IX Item "[ Member data: returns uint8_t * ] -def_mcast_not_port"
845 .IP "[ Member data: returns uint8_t * ] \-life_state" 4
846 .IX Item "[ Member data: returns uint8_t * ] -life_state"
847 .IP "[ Member data: returns ib_net16_t * ] \-lids_per_port" 4
848 .IX Item "[ Member data: returns ib_net16_t * ] -lids_per_port"
849 .IP "[ Member data: returns ib_net16_t * ] \-enforce_cap" 4
850 .IX Item "[ Member data: returns ib_net16_t * ] -enforce_cap"
851 .IP "[ Member data: returns uint8_t * ] \-flags" 4
852 .IX Item "[ Member data: returns uint8_t * ] -flags"
853 .IP "[ Member : returns void ] delete" 4
854 .IX Item "[ Member : returns void ] delete"
855 .PD
856 \&\-\-\-\-
857 .Sp
858 \fIclass sacSwRec\fR
859 .IX Subsection "class sacSwRec"
860 .Sp
861 \&\s-1RID\s0 Fields:
862 .IP "[ Member data: returns ib_net16_t * ] \-lid" 4
863 .IX Item "[ Member data: returns ib_net16_t * ] -lid"
864 .PD 0
865 .IP "[ Member data: returns sacSwInfo * ] \-switch_info" 4
866 .IX Item "[ Member data: returns sacSwInfo * ] -switch_info"
867 .PD
868 Methods:
869 .IP "[ Member : returns char * ] get comp_mask" 4
870 .IX Item "[ Member : returns char * ] get comp_mask"
871 .PD 0
872 .IP "[ Member : returns char * ] getTable comp_mask" 4
873 .IX Item "[ Member : returns char * ] getTable comp_mask"
874 .IP "[ Member : returns void ] delete" 4
875 .IX Item "[ Member : returns void ] delete"
876 .PD
877 .Sh "\s-1LINK\s0 \s-1RECORD\s0"
878 .IX Subsection "LINK RECORD"
879 .RS 4
880 Component mask bits:
881 .RE
882 .ie n .IP "[ Constant : int ] $IB_LR_COMPMASK_FROM_LID = 0x1" 4
883 .el .IP "[ Constant : int ] \f(CW$IB_LR_COMPMASK_FROM_LID\fR = 0x1" 4
884 .IX Item "[ Constant : int ] $IB_LR_COMPMASK_FROM_LID = 0x1"
885 .PD 0
886 .ie n .IP "[ Constant : int ] $IB_LR_COMPMASK_FROM_PORT = 0x2" 4
887 .el .IP "[ Constant : int ] \f(CW$IB_LR_COMPMASK_FROM_PORT\fR = 0x2" 4
888 .IX Item "[ Constant : int ] $IB_LR_COMPMASK_FROM_PORT = 0x2"
889 .ie n .IP "[ Constant : int ] $IB_LR_COMPMASK_TO_PORT = 0x4" 4
890 .el .IP "[ Constant : int ] \f(CW$IB_LR_COMPMASK_TO_PORT\fR = 0x4" 4
891 .IX Item "[ Constant : int ] $IB_LR_COMPMASK_TO_PORT = 0x4"
892 .ie n .IP "[ Constant : int ] $IB_LR_COMPMASK_TO_LID = 0x8" 4
893 .el .IP "[ Constant : int ] \f(CW$IB_LR_COMPMASK_TO_LID\fR = 0x8" 4
894 .IX Item "[ Constant : int ] $IB_LR_COMPMASK_TO_LID = 0x8"
895 .PD
896 \&\-\-\-\-
897 .Sp
898 \fIclass sacLinkRec\fR
899 .IX Subsection "class sacLinkRec"
900 .Sp
901 Fields:
902 .IP "[ Member data: returns ib_net16_t * ] \-from_lid" 4
903 .IX Item "[ Member data: returns ib_net16_t * ] -from_lid"
904 .PD 0
905 .IP "[ Member data: returns uint8_t * ] \-from_port_num" 4
906 .IX Item "[ Member data: returns uint8_t * ] -from_port_num"
907 .IP "[ Member data: returns uint8_t * ] \-to_port_num" 4
908 .IX Item "[ Member data: returns uint8_t * ] -to_port_num"
909 .IP "[ Member data: returns ib_net16_t * ] \-to_lid" 4
910 .IX Item "[ Member data: returns ib_net16_t * ] -to_lid"
911 .PD
912 Methods:
913 .IP "[ Member : returns char * ] get comp_mask" 4
914 .IX Item "[ Member : returns char * ] get comp_mask"
915 .PD 0
916 .IP "[ Member : returns char * ] getTable comp_mask" 4
917 .IX Item "[ Member : returns char * ] getTable comp_mask"
918 .IP "[ Member : returns void ] delete" 4
919 .IX Item "[ Member : returns void ] delete"
920 .PD
921 .Sh "\s-1PATH\s0 \s-1RECORD\s0"
922 .IX Subsection "PATH RECORD"
923 .RS 4
924 Component mask bits:
925 .RE
926 .ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_DGID = 0x4" 4
927 .el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_DGID\fR = 0x4" 4
928 .IX Item "[ Constant : int ] $IB_PR_COMPMASK_DGID = 0x4"
929 .PD 0
930 .ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_SGID = 0x8" 4
931 .el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_SGID\fR = 0x8" 4
932 .IX Item "[ Constant : int ] $IB_PR_COMPMASK_SGID = 0x8"
933 .ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_DLID = 0x10" 4
934 .el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_DLID\fR = 0x10" 4
935 .IX Item "[ Constant : int ] $IB_PR_COMPMASK_DLID = 0x10"
936 .ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_SLID = 0x20" 4
937 .el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_SLID\fR = 0x20" 4
938 .IX Item "[ Constant : int ] $IB_PR_COMPMASK_SLID = 0x20"
939 .ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_RAWTRAFIC = 0x40" 4
940 .el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_RAWTRAFIC\fR = 0x40" 4
941 .IX Item "[ Constant : int ] $IB_PR_COMPMASK_RAWTRAFIC = 0x40"
942 .ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_RESV0 = 0x80" 4
943 .el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_RESV0\fR = 0x80" 4
944 .IX Item "[ Constant : int ] $IB_PR_COMPMASK_RESV0 = 0x80"
945 .ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_FLOWLABEL = 0x100" 4
946 .el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_FLOWLABEL\fR = 0x100" 4
947 .IX Item "[ Constant : int ] $IB_PR_COMPMASK_FLOWLABEL = 0x100"
948 .ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_HOPLIMIT = 0x200" 4
949 .el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_HOPLIMIT\fR = 0x200" 4
950 .IX Item "[ Constant : int ] $IB_PR_COMPMASK_HOPLIMIT = 0x200"
951 .ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_TCLASS = 0x400" 4
952 .el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_TCLASS\fR = 0x400" 4
953 .IX Item "[ Constant : int ] $IB_PR_COMPMASK_TCLASS = 0x400"
954 .ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_REVERSIBLE = 0x800" 4
955 .el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_REVERSIBLE\fR = 0x800" 4
956 .IX Item "[ Constant : int ] $IB_PR_COMPMASK_REVERSIBLE = 0x800"
957 .ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_NUMBPATH = 0x1000" 4
958 .el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_NUMBPATH\fR = 0x1000" 4
959 .IX Item "[ Constant : int ] $IB_PR_COMPMASK_NUMBPATH = 0x1000"
960 .ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_PKEY = 0x2000" 4
961 .el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_PKEY\fR = 0x2000" 4
962 .IX Item "[ Constant : int ] $IB_PR_COMPMASK_PKEY = 0x2000"
963 .ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_RESV1 = 0x4000" 4
964 .el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_RESV1\fR = 0x4000" 4
965 .IX Item "[ Constant : int ] $IB_PR_COMPMASK_RESV1 = 0x4000"
966 .ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_SL = 0x8000" 4
967 .el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_SL\fR = 0x8000" 4
968 .IX Item "[ Constant : int ] $IB_PR_COMPMASK_SL = 0x8000"
969 .ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_MTUSELEC = 0x10000" 4
970 .el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_MTUSELEC\fR = 0x10000" 4
971 .IX Item "[ Constant : int ] $IB_PR_COMPMASK_MTUSELEC = 0x10000"
972 .ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_MTU = 0x20000" 4
973 .el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_MTU\fR = 0x20000" 4
974 .IX Item "[ Constant : int ] $IB_PR_COMPMASK_MTU = 0x20000"
975 .ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_RATESELEC = 0x40000" 4
976 .el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_RATESELEC\fR = 0x40000" 4
977 .IX Item "[ Constant : int ] $IB_PR_COMPMASK_RATESELEC = 0x40000"
978 .ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_RATE = 0x80000" 4
979 .el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_RATE\fR = 0x80000" 4
980 .IX Item "[ Constant : int ] $IB_PR_COMPMASK_RATE = 0x80000"
981 .ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_PKTLIFETIMESELEC = 0x100000" 4
982 .el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_PKTLIFETIMESELEC\fR = 0x100000" 4
983 .IX Item "[ Constant : int ] $IB_PR_COMPMASK_PKTLIFETIMESELEC = 0x100000"
984 .ie n .IP "[ Constant : int ] $IB_PR_COMPMASK_PFTLIFETIME = 0x200000" 4
985 .el .IP "[ Constant : int ] \f(CW$IB_PR_COMPMASK_PFTLIFETIME\fR = 0x200000" 4
986 .IX Item "[ Constant : int ] $IB_PR_COMPMASK_PFTLIFETIME = 0x200000"
987 .PD
988 \&\-\-\-\-
989 .Sp
990 \fIclass sacPathRec\fR
991 .IX Subsection "class sacPathRec"
992 .Sp
993 Fields:
994 .IP "[ Member data: returns ib_gid_t * ] \-dgid" 4
995 .IX Item "[ Member data: returns ib_gid_t * ] -dgid"
996 .PD 0
997 .IP "[ Member data: returns ib_gid_t * ] \-sgid" 4
998 .IX Item "[ Member data: returns ib_gid_t * ] -sgid"
999 .IP "[ Member data: returns ib_net16_t * ] \-dlid" 4
1000 .IX Item "[ Member data: returns ib_net16_t * ] -dlid"
1001 .IP "[ Member data: returns ib_net16_t * ] \-slid" 4
1002 .IX Item "[ Member data: returns ib_net16_t * ] -slid"
1003 .IP "[ Member data: returns ib_net32_t * ] \-hop_flow_raw" 4
1004 .IX Item "[ Member data: returns ib_net32_t * ] -hop_flow_raw"
1005 .IP "[ Member data: returns uint8_t * ] \-tclass" 4
1006 .IX Item "[ Member data: returns uint8_t * ] -tclass"
1007 .IP "[ Member data: returns uint8_t * ] \-num_path" 4
1008 .IX Item "[ Member data: returns uint8_t * ] -num_path"
1009 .IP "[ Member data: returns ib_net16_t * ] \-pkey" 4
1010 .IX Item "[ Member data: returns ib_net16_t * ] -pkey"
1011 .IP "[ Member data: returns ib_net16_t * ] \-sl" 4
1012 .IX Item "[ Member data: returns ib_net16_t * ] -sl"
1013 .IP "[ Member data: returns uint8_t * ] \-mtu" 4
1014 .IX Item "[ Member data: returns uint8_t * ] -mtu"
1015 .IP "[ Member data: returns uint8_t * ] \-rate" 4
1016 .IX Item "[ Member data: returns uint8_t * ] -rate"
1017 .IP "[ Member data: returns uint8_t * ] \-pkt_life" 4
1018 .IX Item "[ Member data: returns uint8_t * ] -pkt_life"
1019 .IP "[ Member data: returns uint8_t * ] \-preference" 4
1020 .IX Item "[ Member data: returns uint8_t * ] -preference"
1021 .PD
1022 Methds:
1023 .IP "[ Member : returns char * ] get comp_mask" 4
1024 .IX Item "[ Member : returns char * ] get comp_mask"
1025 .PD 0
1026 .IP "[ Member : returns char * ] getTable comp_mask" 4
1027 .IX Item "[ Member : returns char * ] getTable comp_mask"
1028 .IP "[ Member : returns void ] delete" 4
1029 .IX Item "[ Member : returns void ] delete"
1030 .PD
1031 .Sh "\s-1LINEAR\s0 \s-1FORWARDING\s0 \s-1TABLE\s0"
1032 .IX Subsection "LINEAR FORWARDING TABLE"
1033 .RS 4
1034 Component mask bits:
1035 .RE
1036 .ie n .IP "[ Constant : char * ] $IB_LFT_COMPMASK_LID = 0x1" 4
1037 .el .IP "[ Constant : char * ] \f(CW$IB_LFT_COMPMASK_LID\fR = 0x1" 4
1038 .IX Item "[ Constant : char * ] $IB_LFT_COMPMASK_LID = 0x1"
1039 .PD 0
1040 .ie n .IP "[ Constant : char * ] $IB_LFT_COMPMASK_BLOCK = 0x2" 4
1041 .el .IP "[ Constant : char * ] \f(CW$IB_LFT_COMPMASK_BLOCK\fR = 0x2" 4
1042 .IX Item "[ Constant : char * ] $IB_LFT_COMPMASK_BLOCK = 0x2"
1043 .PD
1044 \&\-\-\-\-
1045 .Sp
1046 \fIclass sacLFTRec\fR
1047 .IX Subsection "class sacLFTRec"
1048 .Sp
1049 Fields:
1050 .IP "[ Member data: returns ib_net16_t * ] \-lid" 4
1051 .IX Item "[ Member data: returns ib_net16_t * ] -lid"
1052 .PD 0
1053 .IP "[ Member data: returns ib_net16_t * ] \-block_num" 4
1054 .IX Item "[ Member data: returns ib_net16_t * ] -block_num"
1055 .IP "[ Member data: returns ib_lft_t * ] \-lft" 4
1056 .IX Item "[ Member data: returns ib_lft_t * ] -lft"
1057 .PD
1058 Methods:
1059 .IP "[ Member : returns char * ] get comp_mask" 4
1060 .IX Item "[ Member : returns char * ] get comp_mask"
1061 .PD 0
1062 .IP "[ Member : returns char * ] getTable comp_mask" 4
1063 .IX Item "[ Member : returns char * ] getTable comp_mask"
1064 .IP "[ Member : returns void ] delete" 4
1065 .IX Item "[ Member : returns void ] delete"
1066 .PD
1067 .Sh "\s-1MULTICAST\s0 \s-1MEMBER\s0 \s-1RECORD\s0"
1068 .IX Subsection "MULTICAST MEMBER RECORD"
1069 .RS 4
1070 Component mask bits:
1071 .RE
1072 .ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_GID = 0x1" 4
1073 .el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_GID\fR = 0x1" 4
1074 .IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_GID = 0x1"
1075 .PD 0
1076 .ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_MGID = 0x1" 4
1077 .el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_MGID\fR = 0x1" 4
1078 .IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_MGID = 0x1"
1079 .ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_PORT_GID = 0x2" 4
1080 .el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_PORT_GID\fR = 0x2" 4
1081 .IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_PORT_GID = 0x2"
1082 .ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_QKEY = 0x4" 4
1083 .el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_QKEY\fR = 0x4" 4
1084 .IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_QKEY = 0x4"
1085 .ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_MLID = 0x8" 4
1086 .el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_MLID\fR = 0x8" 4
1087 .IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_MLID = 0x8"
1088 .ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_MTU_SEL = 0x10" 4
1089 .el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_MTU_SEL\fR = 0x10" 4
1090 .IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_MTU_SEL = 0x10"
1091 .ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_MTU = 0x20" 4
1092 .el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_MTU\fR = 0x20" 4
1093 .IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_MTU = 0x20"
1094 .ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_TCLASS = 0x40" 4
1095 .el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_TCLASS\fR = 0x40" 4
1096 .IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_TCLASS = 0x40"
1097 .ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_PKEY = 0x80" 4
1098 .el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_PKEY\fR = 0x80" 4
1099 .IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_PKEY = 0x80"
1100 .ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_RATE_SEL = 0x100" 4
1101 .el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_RATE_SEL\fR = 0x100" 4
1102 .IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_RATE_SEL = 0x100"
1103 .ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_RATE = 0x200" 4
1104 .el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_RATE\fR = 0x200" 4
1105 .IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_RATE = 0x200"
1106 .ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_LIFE_SEL = 0x400" 4
1107 .el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_LIFE_SEL\fR = 0x400" 4
1108 .IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_LIFE_SEL = 0x400"
1109 .ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_LIFE = 0x800" 4
1110 .el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_LIFE\fR = 0x800" 4
1111 .IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_LIFE = 0x800"
1112 .ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_SL = 0x1000" 4
1113 .el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_SL\fR = 0x1000" 4
1114 .IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_SL = 0x1000"
1115 .ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_FLOW = 0x2000" 4
1116 .el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_FLOW\fR = 0x2000" 4
1117 .IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_FLOW = 0x2000"
1118 .ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_HOP = 0x4000" 4
1119 .el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_HOP\fR = 0x4000" 4
1120 .IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_HOP = 0x4000"
1121 .ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_SCOPE = 0x8000" 4
1122 .el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_SCOPE\fR = 0x8000" 4
1123 .IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_SCOPE = 0x8000"
1124 .ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_JOIN_STATE = 0x10000" 4
1125 .el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_JOIN_STATE\fR = 0x10000" 4
1126 .IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_JOIN_STATE = 0x10000"
1127 .ie n .IP "[ Constant : char * ] $IB_MCR_COMPMASK_PROXY = 0x20000" 4
1128 .el .IP "[ Constant : char * ] \f(CW$IB_MCR_COMPMASK_PROXY\fR = 0x20000" 4
1129 .IX Item "[ Constant : char * ] $IB_MCR_COMPMASK_PROXY = 0x20000"
1130 .PD
1131 \&\-\-\-\-
1132 .Sp
1133 \fIclass sacMCMRec\fR
1134 .IX Subsection "class sacMCMRec"
1135 .Sp
1136 Fields:
1137 .IP "[ Member data: returns ib_gid_t * ] \-mgid" 4
1138 .IX Item "[ Member data: returns ib_gid_t * ] -mgid"
1139 .PD 0
1140 .IP "[ Member data: returns ib_gid_t * ] \-port_gid" 4
1141 .IX Item "[ Member data: returns ib_gid_t * ] -port_gid"
1142 .IP "[ Member data: returns ib_net32_t * ] \-qkey" 4
1143 .IX Item "[ Member data: returns ib_net32_t * ] -qkey"
1144 .IP "[ Member data: returns ib_net16_t * ] \-mlid" 4
1145 .IX Item "[ Member data: returns ib_net16_t * ] -mlid"
1146 .IP "[ Member data: returns uint8_t * ] \-mtu" 4
1147 .IX Item "[ Member data: returns uint8_t * ] -mtu"
1148 .IP "[ Member data: returns uint8_t * ] \-tclass" 4
1149 .IX Item "[ Member data: returns uint8_t * ] -tclass"
1150 .IP "[ Member data: returns ib_net16_t * ] \-pkey" 4
1151 .IX Item "[ Member data: returns ib_net16_t * ] -pkey"
1152 .IP "[ Member data: returns uint8_t * ] \-rate" 4
1153 .IX Item "[ Member data: returns uint8_t * ] -rate"
1154 .IP "[ Member data: returns uint8_t * ] \-pkt_life" 4
1155 .IX Item "[ Member data: returns uint8_t * ] -pkt_life"
1156 .IP "[ Member data: returns ib_net32_t * ] \-sl_flow_hop" 4
1157 .IX Item "[ Member data: returns ib_net32_t * ] -sl_flow_hop"
1158 .IP "[ Member data: returns uint8_t * ] \-scope_state" 4
1159 .IX Item "[ Member data: returns uint8_t * ] -scope_state"
1160 .PD
1161 Methods:
1162 .IP "[ Member : returns char * ] get comp_mask" 4
1163 .IX Item "[ Member : returns char * ] get comp_mask"
1164 .PD 0
1165 .IP "[ Member : returns char * ] getTable comp_mask" 4
1166 .IX Item "[ Member : returns char * ] getTable comp_mask"
1167 .IP "[ Member : returns char * ] set comp_mask" 4
1168 .IX Item "[ Member : returns char * ] set comp_mask"
1169 .IP "[ Member : returns char * ] del comp_mask" 4
1170 .IX Item "[ Member : returns char * ] del comp_mask"
1171 .IP "[ Member : returns int ] proxy_join_get" 4
1172 .IX Item "[ Member : returns int ] proxy_join_get"
1173 .PD
1174 Instead of simple field cget
1175 .IP "[ Member : returns void ] proxy_join_set proxy_join" 4
1176 .IX Item "[ Member : returns void ] proxy_join_set proxy_join"
1177 Instead of simple field configure
1178 .IP "[ Member : returns void ] obj_delete" 4
1179 .IX Item "[ Member : returns void ] obj_delete"
1180 Delete the object
1181 .Sh "\s-1SA\s0 \s-1CLASS\s0 \s-1PORT\s0 \s-1INFO\s0"
1182 .IX Subsection "SA CLASS PORT INFO"
1183 .RS 4
1184 \&\-\-\-\-
1185 .Sp
1186 \fIclass sacClassPortInfo\fR
1187 .IX Subsection "class sacClassPortInfo"
1188 .Sp
1189 Fields:
1190 .RE
1191 .IP "[ Member data: returns uint8_t * ] \-base_ver" 4
1192 .IX Item "[ Member data: returns uint8_t * ] -base_ver"
1193 .PD 0
1194 .IP "[ Member data: returns uint8_t * ] \-class_ver" 4
1195 .IX Item "[ Member data: returns uint8_t * ] -class_ver"
1196 .IP "[ Member data: returns ib_net16_t * ] \-cap_mask" 4
1197 .IX Item "[ Member data: returns ib_net16_t * ] -cap_mask"
1198 .IP "[ Member data: returns ib_net32_t * ] \-resp_time_val" 4
1199 .IX Item "[ Member data: returns ib_net32_t * ] -resp_time_val"
1200 .IP "[ Member data: returns ib_gid_t * ] \-redir_gid" 4
1201 .IX Item "[ Member data: returns ib_gid_t * ] -redir_gid"
1202 .IP "[ Member data: returns ib_net32_t * ] \-redir_tc_sl_fl" 4
1203 .IX Item "[ Member data: returns ib_net32_t * ] -redir_tc_sl_fl"
1204 .IP "[ Member data: returns ib_net16_t * ] \-redir_lid" 4
1205 .IX Item "[ Member data: returns ib_net16_t * ] -redir_lid"
1206 .IP "[ Member data: returns ib_net16_t * ] \-redir_pkey" 4
1207 .IX Item "[ Member data: returns ib_net16_t * ] -redir_pkey"
1208 .IP "[ Member data: returns ib_net32_t * ] \-redir_qp" 4
1209 .IX Item "[ Member data: returns ib_net32_t * ] -redir_qp"
1210 .IP "[ Member data: returns ib_net32_t * ] \-redir_qkey" 4
1211 .IX Item "[ Member data: returns ib_net32_t * ] -redir_qkey"
1212 .IP "[ Member data: returns ib_gid_t * ] \-trap_gid" 4
1213 .IX Item "[ Member data: returns ib_gid_t * ] -trap_gid"
1214 .IP "[ Member data: returns ib_net32_t * ] \-trap_tc_sl_fl" 4
1215 .IX Item "[ Member data: returns ib_net32_t * ] -trap_tc_sl_fl"
1216 .IP "[ Member data: returns ib_net16_t * ] \-trap_lid" 4
1217 .IX Item "[ Member data: returns ib_net16_t * ] -trap_lid"
1218 .IP "[ Member data: returns ib_net16_t * ] \-trap_pkey" 4
1219 .IX Item "[ Member data: returns ib_net16_t * ] -trap_pkey"
1220 .IP "[ Member data: returns ib_net32_t * ] \-trap_hop_qp" 4
1221 .IX Item "[ Member data: returns ib_net32_t * ] -trap_hop_qp"
1222 .IP "[ Member data: returns ib_net32_t * ] \-trap_qkey" 4
1223 .IX Item "[ Member data: returns ib_net32_t * ] -trap_qkey"
1224 .PD
1225 Methods:
1226 .IP "[ Member : returns char * ] get" 4
1227 .IX Item "[ Member : returns char * ] get"
1228 .PD 0
1229 .IP "[ Member : returns void ] delete" 4
1230 .IX Item "[ Member : returns void ] delete"
1231 .PD
1232 .Sh "\s-1INFORM\s0 \s-1INFO\s0 \s-1RECORD\s0"
1233 .IX Subsection "INFORM INFO RECORD"
1234 .RS 4
1235 The inform Info is built with heirarchy of objects. So several classes are defined.
1236 .Sp
1237 \&\-\-\-\-
1238 .Sp
1239 \fIclass sacInformInfo\fR
1240 .IX Subsection "class sacInformInfo"
1241 .Sp
1242 Fields:
1243 .RE
1244 .IP "[ Member data: returns ib_gid_t * ] \-gid" 4
1245 .IX Item "[ Member data: returns ib_gid_t * ] -gid"
1246 .PD 0
1247 .IP "[ Member data: returns ib_net16_t * ] \-lid_range_begin" 4
1248 .IX Item "[ Member data: returns ib_net16_t * ] -lid_range_begin"
1249 .IP "[ Member data: returns ib_net16_t * ] \-lid_range_end" 4
1250 .IX Item "[ Member data: returns ib_net16_t * ] -lid_range_end"
1251 .IP "[ Member data: returns ib_net16_t * ] \-reserved1" 4
1252 .IX Item "[ Member data: returns ib_net16_t * ] -reserved1"
1253 .IP "[ Member data: returns uint8_t * ] \-is_generic" 4
1254 .IX Item "[ Member data: returns uint8_t * ] -is_generic"
1255 .IP "[ Member data: returns uint8_t * ] \-subscribe" 4
1256 .IX Item "[ Member data: returns uint8_t * ] -subscribe"
1257 .IP "[ Member data: returns ib_net16_t * ] \-trap_type" 4
1258 .IX Item "[ Member data: returns ib_net16_t * ] -trap_type"
1259 .IP "[ Member data: returns sacInformInfo_g_or_v * ] \-g_or_v" 4
1260 .IX Item "[ Member data: returns sacInformInfo_g_or_v * ] -g_or_v"
1261 .PD
1262 Methods:
1263 .IP "[ Member : returns char * ] set" 4
1264 .IX Item "[ Member : returns char * ] set"
1265 .PD 0
1266 .IP "[ Member : returns void ] delete" 4
1267 .IX Item "[ Member : returns void ] delete"
1268 .PD
1269 \&\-\-\-\-
1270 .Sp
1271 \fIclass sacInformInfo_g_or_v\fR
1272 .IX Subsection "class sacInformInfo_g_or_v"
1273 .Sp
1274 Fields:
1275 .IP "[ Member data: returns sacInformInfo_g_or_v_generic * ] \-generic" 4
1276 .IX Item "[ Member data: returns sacInformInfo_g_or_v_generic * ] -generic"
1277 .PD 0
1278 .IP "[ Member data: returns sacInformInfo_g_or_v_vend * ] \-vend" 4
1279 .IX Item "[ Member data: returns sacInformInfo_g_or_v_vend * ] -vend"
1280 .PD
1281 \&\-\-\-\-
1282 .Sp
1283 \fIclass sacInformInfo_g_or_v_generic\fR
1284 .IX Subsection "class sacInformInfo_g_or_v_generic"
1285 .Sp
1286 Fields:
1287 .IP "[ Member data: returns ib_net16_t * ] \-trap_num" 4
1288 .IX Item "[ Member data: returns ib_net16_t * ] -trap_num"
1289 .PD 0
1290 .IP "[ Member data: returns ib_net32_t * ] \-qpn_resp_time_val" 4
1291 .IX Item "[ Member data: returns ib_net32_t * ] -qpn_resp_time_val"
1292 .IP "[ Member data: returns uint8_t * ] \-reserved2" 4
1293 .IX Item "[ Member data: returns uint8_t * ] -reserved2"
1294 .IP "[ Member data: returns uint8_t * ] \-node_type_msb" 4
1295 .IX Item "[ Member data: returns uint8_t * ] -node_type_msb"
1296 .IP "[ Member data: returns ib_net16_t * ] \-node_type_lsb" 4
1297 .IX Item "[ Member data: returns ib_net16_t * ] -node_type_lsb"
1298 .PD
1299 \&\-\-\-\-
1300 .Sp
1301 \fIclass sacInformInfo_g_or_v_vend\fR
1302 .IX Subsection "class sacInformInfo_g_or_v_vend"
1303 .Sp
1304 Fields:
1305 .IP "[ Member data: returns ib_net16_t * ] \-dev_id" 4
1306 .IX Item "[ Member data: returns ib_net16_t * ] -dev_id"
1307 .PD 0
1308 .IP "[ Member data: returns ib_net32_t * ] \-qpn_resp_time_val" 4
1309 .IX Item "[ Member data: returns ib_net32_t * ] -qpn_resp_time_val"
1310 .IP "[ Member data: returns uint8_t * ] \-reserved2" 4
1311 .IX Item "[ Member data: returns uint8_t * ] -reserved2"
1312 .IP "[ Member data: returns uint8_t * ] \-vendor_id_msb" 4
1313 .IX Item "[ Member data: returns uint8_t * ] -vendor_id_msb"
1314 .IP "[ Member data: returns ib_net16_t * ] \-vendor_id_lsb" 4
1315 .IX Item "[ Member data: returns ib_net16_t * ] -vendor_id_lsb"
1316 .PD
1317 .Sh "\s-1SERVICE\s0 \s-1RECORD\s0"
1318 .IX Subsection "SERVICE RECORD"
1319 .RS 4
1320 Component mask bits:
1321 .RE
1322 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SID = 0x1" 4
1323 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SID\fR = 0x1" 4
1324 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SID = 0x1"
1325 .PD 0
1326 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SGID = 0x1" 4
1327 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SGID\fR = 0x1" 4
1328 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SGID = 0x1"
1329 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SPKEY = 0x2" 4
1330 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SPKEY\fR = 0x2" 4
1331 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SPKEY = 0x2"
1332 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_RES1 = 0x4" 4
1333 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_RES1\fR = 0x4" 4
1334 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_RES1 = 0x4"
1335 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SLEASE = 0x8" 4
1336 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SLEASE\fR = 0x8" 4
1337 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SLEASE = 0x8"
1338 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SKEY = 0x10" 4
1339 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SKEY\fR = 0x10" 4
1340 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SKEY = 0x10"
1341 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SNAME = 0x20" 4
1342 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SNAME\fR = 0x20" 4
1343 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SNAME = 0x20"
1344 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_0 = 0x40" 4
1345 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_0\fR = 0x40" 4
1346 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_0 = 0x40"
1347 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_1 = 0x80" 4
1348 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_1\fR = 0x80" 4
1349 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_1 = 0x80"
1350 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_2 = 0x100" 4
1351 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_2\fR = 0x100" 4
1352 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_2 = 0x100"
1353 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_3 = 0x200" 4
1354 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_3\fR = 0x200" 4
1355 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_3 = 0x200"
1356 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_4 = 0x400" 4
1357 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_4\fR = 0x400" 4
1358 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_4 = 0x400"
1359 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_5 = 0x800" 4
1360 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_5\fR = 0x800" 4
1361 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_5 = 0x800"
1362 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_6 = 0x1000" 4
1363 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_6\fR = 0x1000" 4
1364 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_6 = 0x1000"
1365 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_7 = 0x2000" 4
1366 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_7\fR = 0x2000" 4
1367 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_7 = 0x2000"
1368 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_8 = 0x4000" 4
1369 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_8\fR = 0x4000" 4
1370 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_8 = 0x4000"
1371 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_9 = 0x8000" 4
1372 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_9\fR = 0x8000" 4
1373 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_9 = 0x8000"
1374 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_10 = 0x10000" 4
1375 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_10\fR = 0x10000" 4
1376 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_10 = 0x10000"
1377 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_11 = 0x20000" 4
1378 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_11\fR = 0x20000" 4
1379 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_11 = 0x20000"
1380 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_12 = 0x40000" 4
1381 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_12\fR = 0x40000" 4
1382 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_12 = 0x40000"
1383 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_13 = 0x80000" 4
1384 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_13\fR = 0x80000" 4
1385 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_13 = 0x80000"
1386 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_14 = 0x100000" 4
1387 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_14\fR = 0x100000" 4
1388 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_14 = 0x100000"
1389 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_15 = 0x200000" 4
1390 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA8_15\fR = 0x200000" 4
1391 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA8_15 = 0x200000"
1392 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_0 = 0x400000" 4
1393 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA16_0\fR = 0x400000" 4
1394 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_0 = 0x400000"
1395 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_1 = 0x800000" 4
1396 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA16_1\fR = 0x800000" 4
1397 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_1 = 0x800000"
1398 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_2 = 0x1000000" 4
1399 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA16_2\fR = 0x1000000" 4
1400 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_2 = 0x1000000"
1401 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_3 = 0x2000000" 4
1402 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA16_3\fR = 0x2000000" 4
1403 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_3 = 0x2000000"
1404 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_4 = 0x4000000" 4
1405 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA16_4\fR = 0x4000000" 4
1406 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_4 = 0x4000000"
1407 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_5 = 0x8000000" 4
1408 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA16_5\fR = 0x8000000" 4
1409 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_5 = 0x8000000"
1410 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_6 = 0x10000000" 4
1411 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA16_6\fR = 0x10000000" 4
1412 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_6 = 0x10000000"
1413 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_7 = 0x20000000" 4
1414 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA16_7\fR = 0x20000000" 4
1415 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA16_7 = 0x20000000"
1416 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA32_0 = 0x40000000" 4
1417 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA32_0\fR = 0x40000000" 4
1418 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA32_0 = 0x40000000"
1419 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA32_1 = 0x80000000" 4
1420 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA32_1\fR = 0x80000000" 4
1421 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA32_1 = 0x80000000"
1422 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA32_2 = 0x100000000" 4
1423 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA32_2\fR = 0x100000000" 4
1424 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA32_2 = 0x100000000"
1425 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA32_3 = 0x200000000" 4
1426 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA32_3\fR = 0x200000000" 4
1427 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA32_3 = 0x200000000"
1428 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA64_0 = 0x400000000" 4
1429 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA64_0\fR = 0x400000000" 4
1430 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA64_0 = 0x400000000"
1431 .ie n .IP "[ Constant : char * ] $IB_SR_COMPMASK_SDATA64_1 = 0x800000000" 4
1432 .el .IP "[ Constant : char * ] \f(CW$IB_SR_COMPMASK_SDATA64_1\fR = 0x800000000" 4
1433 .IX Item "[ Constant : char * ] $IB_SR_COMPMASK_SDATA64_1 = 0x800000000"
1434 .PD
1435 \&\-\-\-\-
1436 .Sp
1437 \fIclass sacServiceRec\fR
1438 .IX Subsection "class sacServiceRec"
1439 .Sp
1440 Fields:
1441 .IP "[ Member data: returns ib_net64_t * ] \-service_id" 4
1442 .IX Item "[ Member data: returns ib_net64_t * ] -service_id"
1443 .PD 0
1444 .IP "[ Member data: returns ib_gid_t * ] \-service_gid" 4
1445 .IX Item "[ Member data: returns ib_gid_t * ] -service_gid"
1446 .IP "[ Member data: returns ib_net16_t * ] \-service_pkey" 4
1447 .IX Item "[ Member data: returns ib_net16_t * ] -service_pkey"
1448 .IP "[ Member data: returns ib_net16_t * ] \-resv" 4
1449 .IX Item "[ Member data: returns ib_net16_t * ] -resv"
1450 .IP "[ Member data: returns ib_net32_t * ] \-service_lease" 4
1451 .IX Item "[ Member data: returns ib_net32_t * ] -service_lease"
1452 .IP "[ Member data: returns uint8_array_t * ] \-service_key" 4
1453 .IX Item "[ Member data: returns uint8_array_t * ] -service_key"
1454 .IP "[ Member data: returns ib_svc_name_t * ] \-service_name" 4
1455 .IX Item "[ Member data: returns ib_svc_name_t * ] -service_name"
1456 .IP "[ Member data: returns uint8_array_t * ] \-service_data8" 4
1457 .IX Item "[ Member data: returns uint8_array_t * ] -service_data8"
1458 .IP "[ Member data: returns ib_net16_array_t * ] \-service_data16" 4
1459 .IX Item "[ Member data: returns ib_net16_array_t * ] -service_data16"
1460 .IP "[ Member data: returns ib_net32_array_t * ] \-service_data32" 4
1461 .IX Item "[ Member data: returns ib_net32_array_t * ] -service_data32"
1462 .IP "[ Member data: returns ib_net64_array_t * ] \-service_data64" 4
1463 .IX Item "[ Member data: returns ib_net64_array_t * ] -service_data64"
1464 .PD
1465 Methods:
1466 .IP "[ Member : returns char * ] get comp_mask" 4
1467 .IX Item "[ Member : returns char * ] get comp_mask"
1468 .PD 0