|
1 '\" te |
|
2 .\" CDDL HEADER START |
|
3 .\" |
|
4 .\" The contents of this file are subject to the terms of the |
|
5 .\" Common Development and Distribution License (the "License"). |
|
6 .\" You may not use this file except in compliance with the License. |
|
7 .\" |
|
8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE |
|
9 .\" or http://www.opensolaris.org/os/licensing. |
|
10 .\" See the License for the specific language governing permissions |
|
11 .\" and limitations under the License. |
|
12 .\" |
|
13 .\" When distributing Covered Code, include this CDDL HEADER in each |
|
14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE. |
|
15 .\" If applicable, add the following below this CDDL HEADER, with the |
|
16 .\" fields enclosed by brackets "[]" replaced with your own identifying |
|
17 .\" information: Portions Copyright [yyyy] [name of copyright owner] |
|
18 .\" |
|
19 .\" CDDL HEADER END |
|
20 .\" |
|
21 .\" Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. |
|
22 .\" |
|
23 .\" -*- nroff -*- |
|
24 .\" |
|
25 .TH IBV_GID_REACHABLE 3 2012-08-08 libibverbs "Libibverbs Programmer's Manual" |
|
26 .SH "NAME" |
|
27 ibv_gid_reachable \- will contact the SA to do a path record lookup from the |
|
28 device,port specified by 'context','port' to the remote 'gid_p'. It finds the |
|
29 status of the remote GID (reachable or unreachable). |
|
30 .sp |
|
31 .SH "SYNOPSIS" |
|
32 .nf |
|
33 .B #include <infiniband/verbs.h> |
|
34 .sp |
|
35 .BI "int ibv_gid_reachable(struct ibv_context *context, uint port, |
|
36 .BI "union ibv_gid *gid_p, int timeout) |
|
37 .if |
|
38 .TP |
|
39 .B gid_p |
|
40 A pointer to the gid to check |
|
41 .TP |
|
42 .B context |
|
43 A device context obtained from a call to ibv_open_device(). |
|
44 This identifies the device to use in order to contact the |
|
45 remote 'gid_p'. |
|
46 .TP |
|
47 .B port |
|
48 Specifies the port on the device associated with 'context'. |
|
49 If '0' then the implementation will choose a port. |
|
50 .TP |
|
51 .B timeout |
|
52 It is currently set to '0' and reserved for future enhancement. |
|
53 ibv_gid_reachable() will block until a response |
|
54 (success, fail or no path found) is obtained. |
|
55 .sp |
|
56 .SH "DESCRIPTION" |
|
57 .B ibv_gid_reachable() will contact the SA from the device,port specified |
|
58 by 'context','port' to the remote 'gid_p'. |
|
59 It finds the status of the remote 'gid_p' (reachable or not). |
|
60 .sp |
|
61 .B ibv_gid_reachable() |
|
62 returns 0 on success, -1 on failure with errno set as follows: |
|
63 .sp |
|
64 .TP |
|
65 .in +10 |
|
66 .B EINVAL \fR\fR\fR Invalid argument. |
|
67 .in -10 |
|
68 .TP |
|
69 .in +10 |
|
70 .B ENXIO \fR\fR\fR No Path Found |
|
71 .in -10 |
|
72 .TP |
|
73 .in +10 |
|
74 .B EIO \fR\fR\fR I/O Error |
|
75 .in -10 |
|
76 .TP |
|
77 .in +10 |
|
78 .B ENOMEM \fR\fR\fR Could not allocate kernel resource |
|
79 .in -10 |
|
80 .in +23 |
|
81 required to perform the lookup. |
|
82 .in -23 |
|
83 .TP |
|
84 .in +10 |
|
85 .B EINTR \fR\fR\fR Abort due to interrupted system call. |
|
86 .in -10 |
|
87 .sp |
|
88 .SH "RETURN VALUE" |
|
89 .B ibv_gid_reachable() |
|
90 returns 0 on success, and \-1 on error. |
|
91 .sp |
|
92 .SH "NOTES" |
|
93 .TP |