Blame libibnetdisc/man/ibnd_discover_fabric.3

Packit db064d
.TH IBND_DISCOVER_FABRIC 3  "July 25, 2008" "OpenIB" "OpenIB Programmer's Manual"
Packit db064d
.SH "NAME"
Packit db064d
ibnd_discover_fabric, ibnd_destroy_fabric, ibnd_debug ibnd_show_progress \- initialize ibnetdiscover library.
Packit db064d
.SH "SYNOPSIS"
Packit db064d
.nf
Packit db064d
.B #include <infiniband/ibnetdisc.h>
Packit db064d
.sp
Packit db064d
.BI "ibnd_fabric_t *ibnd_discover_fabric(struct ibmad_port *ibmad_port, int timeout_ms, ib_portid_t *from, int hops)"
Packit db064d
.BI "void ibnd_destroy_fabric(ibnd_fabric_t *fabric)"
Packit db064d
.BI "void ibnd_debug(int i)"
Packit db064d
.BI "void ibnd_show_progress(int i)"
Packit db064d
.BI "int ibnd_set_max_smps_on_wire(int i)"
Packit db064d
.SH "DESCRIPTION"
Packit db064d
.B ibnd_discover_fabric()
Packit db064d
Discover the fabric connected to the port specified by ibmad_port, using a timeout specified.  The "from" and "hops" parameters are optional and allow one to scan part of a fabric by specifying a node "from" and a number of hops away from that node to scan, "hops".  This gives the user a "sub-fabric" which is "centered" anywhere they chose.
Packit db064d
Packit db064d
ibmad_port must be opened with at least IB_SMI_CLASS and IB_SMI_DIRECT_CLASS
Packit db064d
classes for ibnd_discover_fabric to work.
Packit db064d
Packit db064d
.B ibnd_destroy_fabric()
Packit db064d
free all memory and resources associated with the fabric.
Packit db064d
Packit db064d
.B ibnd_debug()
Packit db064d
Set the debug level to be printed as library operations take place.
Packit db064d
Packit db064d
.B ibnd_show_progress()
Packit db064d
Indicate that the library should print debug output which shows it's progress
Packit db064d
through the fabric.
Packit db064d
Packit db064d
.B ibnd_set_max_smps_on_wire()
Packit db064d
Set the number of SMP\'s which will be issued on the wire simultaneously.
Packit db064d
Packit db064d
.SH "RETURN VALUE"
Packit db064d
.B ibnd_discover_fabric()
Packit db064d
return NULL on failure, otherwise a valid ibnd_fabric_t object.
Packit db064d
Packit db064d
.B ibnd_destory_fabric(), ibnd_debug()
Packit db064d
NONE
Packit db064d
Packit db064d
.B ibnd_set_max_smps_on_wire()
Packit db064d
The previous value is returned
Packit db064d
Packit db064d
.SH "EXAMPLES"
Packit db064d
Packit db064d
.B Discover the entire fabric connected to device "mthca0", port 1.
Packit db064d
Packit db064d
	int mgmt_classes[2] = {IB_SMI_CLASS, IB_SMI_DIRECT_CLASS};
Packit db064d
	struct ibmad_port *ibmad_port = mad_rpc_open_port(ca, ca_port, mgmt_classes, 2);
Packit db064d
	ibnd_fabric_t *fabric = ibnd_discover_fabric(ibmad_port, 100, NULL, 0);
Packit db064d
	...
Packit db064d
	ibnd_destroy_fabric(fabric);
Packit db064d
	mad_rpc_close_port(ibmad_port);
Packit db064d
Packit db064d
.B Discover only a single node and those nodes connected to it.
Packit db064d
Packit db064d
	...
Packit db064d
	str2drpath(&(port_id.drpath), from, 0, 0);
Packit db064d
	...
Packit db064d
	ibnd_discover_fabric(ibmad_port, 100, &port_id, 1);
Packit db064d
	...
Packit db064d
.SH "SEE ALSO"
Packit db064d
	libibmad, mad_rpc_open_port
Packit db064d
.SH "AUTHORS"
Packit db064d
.TP
Packit db064d
Ira Weiny <weiny2@llnl.gov>