File: ibv_fork_init.3.md

package info (click to toggle)
rdma-core 33.2-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 13,844 kB
  • sloc: ansic: 145,804; python: 5,688; sh: 2,761; perl: 1,465; makefile: 73
file content (69 lines) | stat: -rw-r--r-- 1,910 bytes parent folder | download | duplicates (2)
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
---
date: 2006-10-31
footer: libibverbs
header: "Libibverbs Programmer's Manual"
layout: page
license: 'Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md'
section: 3
title: IBV_FORK_INIT
---

# NAME

ibv_fork_init - initialize libibverbs to support fork()

# SYNOPSIS

```c
#include <infiniband/verbs.h>

int ibv_fork_init(void);
```

# DESCRIPTION

**ibv_fork_init()** initializes libibverbs's data structures to handle
**fork()** function calls correctly and avoid data corruption, whether
**fork()** is called explicitly or implicitly (such as in **system()**).

It is not necessary to use this function if all parent process threads are
always blocked until all child processes end or change address spaces via an
**exec()** operation.

# RETURN VALUE

**ibv_fork_init()** returns 0 on success, or the value of errno on failure
(which indicates the failure reason).

# NOTES

**ibv_fork_init()** works on Linux kernels supporting the **MADV_DONTFORK**
flag for **madvise()** (2.6.17 and higher).

Setting the environment variable **RDMAV_FORK_SAFE** or **IBV_FORK_SAFE** has
the same effect as calling **ibv_fork_init()**.

Setting the environment variable **RDMAV_HUGEPAGES_SAFE** tells the library to
check the underlying page size used by the kernel for memory regions.  This is
required if an application uses huge pages either directly or indirectly via a
library such as libhugetlbfs.

Calling **ibv_fork_init()** will reduce performance due to an extra system
call for every memory registration, and the additional memory allocated to
track memory regions.  The precise performance impact depends on the workload
and usually will not be significant.

Setting **RDMAV_HUGEPAGES_SAFE** adds further overhead to all memory
registrations.

# SEE ALSO

**exec**(3),
**fork**(2),
**ibv_get_device_list**(3),
**system**(3),
**wait**(2)

# AUTHOR

Dotan Barak <dotanba@gmail.com>