File: ibv_open_device.3

package info (click to toggle)
rdma-core 61.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 13,124 kB
  • sloc: ansic: 176,798; python: 15,496; sh: 2,742; perl: 1,465; makefile: 73
file content (52 lines) | stat: -rw-r--r-- 1,638 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
.\" -*- nroff -*-
.\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
.\"
.TH IBV_OPEN_DEVICE 3 2006-10-31 libibverbs "Libibverbs Programmer's Manual"
.SH "NAME"
ibv_open_device, ibv_close_device \- open and close an RDMA device context
.SH "SYNOPSIS"
.nf
.B #include <infiniband/verbs.h>
.sp
.BI "struct ibv_context *ibv_open_device(struct ibv_device " "*device" ");
.sp
.BI "int ibv_close_device(struct ibv_context " "*context" ");
.fi
.SH "DESCRIPTION"
.B ibv_open_device()
opens the device
.I device
and creates a context for further use.
.PP
.B ibv_close_device()
closes the device context
.I context\fR.
.SH "RETURN VALUE"
.B ibv_open_device()
returns a pointer to the allocated device context, or NULL if the request fails.
.PP
.B ibv_close_device()
returns 0 on success, \-1 on failure.
.SH "NOTES"
.B ibv_close_device()
does not release all the resources allocated using context
.I context\fR.
To avoid resource leaks, the user should release all associated
resources before closing a context.

Setting the environment variable **RDMAV_ALLOW_DISASSOC_DESTROY** tells the
library to relate an EIO from destroy commands as a success as the kernel
resources were already released. This comes to prevent memory leakage in the
user space area upon device disassociation. Applications using this flag cannot
call ibv_get_cq_event or ibv_get_async_event concurrently with any call to an
object destruction function.

.SH "SEE ALSO"
.BR ibv_get_device_list (3),
.BR ibv_query_device (3),
.BR ibv_query_port (3),
.BR ibv_query_gid (3),
.BR ibv_query_pkey (3)
.SH "AUTHORS"
.TP
Dotan Barak <dotanba@gmail.com>