File: hwlocality_disc_backends.3

package info (click to toggle)
hwloc-contrib 1.10.0-1
  • links: PTS, VCS
  • area: contrib
  • in suites: jessie, jessie-kfreebsd
  • size: 15,604 kB
  • ctags: 6,628
  • sloc: ansic: 34,014; sh: 12,810; xml: 8,466; makefile: 1,614; sed: 9; php: 8
file content (73 lines) | stat: -rw-r--r-- 2,590 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
70
71
72
73
.TH "Components and Plugins: Discovery backends" 3 "Tue Oct 7 2014" "Version 1.10.0" "Hardware Locality (hwloc)" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Components and Plugins: Discovery backends \- 
.SS "Data Structures"

.in +1c
.ti -1c
.RI "struct \fBhwloc_backend\fP"
.br
.in -1c
.SS "Enumerations"

.in +1c
.ti -1c
.RI "enum \fBhwloc_backend_flag_e\fP { \fBHWLOC_BACKEND_FLAG_NEED_LEVELS\fP }"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "struct \fBhwloc_backend\fP * \fBhwloc_backend_alloc\fP (struct \fBhwloc_disc_component\fP *component)"
.br
.ti -1c
.RI "int \fBhwloc_backend_enable\fP (struct hwloc_topology *topology, struct \fBhwloc_backend\fP *backend)"
.br
.ti -1c
.RI "int \fBhwloc_backends_get_obj_cpuset\fP (struct \fBhwloc_backend\fP *caller, struct \fBhwloc_obj\fP *obj, \fBhwloc_bitmap_t\fP cpuset)"
.br
.ti -1c
.RI "int \fBhwloc_backends_notify_new_object\fP (struct \fBhwloc_backend\fP *caller, struct \fBhwloc_obj\fP *obj)"
.br
.in -1c
.SH "Detailed Description"
.PP 

.SH "Enumeration Type Documentation"
.PP 
.SS "enum \fBhwloc_backend_flag_e\fP"

.PP
Backend flags\&. 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIHWLOC_BACKEND_FLAG_NEED_LEVELS \fP\fP
Levels should be reconnected before this backend discover() is used\&. 
.SH "Function Documentation"
.PP 
.SS "struct \fBhwloc_backend\fP* hwloc_backend_alloc (struct \fBhwloc_disc_component\fP *component)"

.PP
Allocate a backend structure, set good default values, initialize backend->component and topology, etc\&. The caller will then modify whatever needed, and call \fBhwloc_backend_enable()\fP\&. 
.SS "int hwloc_backend_enable (struct hwloc_topology *topology, struct \fBhwloc_backend\fP *backend)"

.PP
Enable a previously allocated and setup backend\&. 
.SS "int hwloc_backends_get_obj_cpuset (struct \fBhwloc_backend\fP *caller, struct \fBhwloc_obj\fP *obj, \fBhwloc_bitmap_t\fPcpuset)"

.PP
Used by backends discovery callbacks to request locality information from others\&. Traverse the list of enabled backends until one has a get_obj_cpuset() method, and call it\&. 
.SS "int hwloc_backends_notify_new_object (struct \fBhwloc_backend\fP *caller, struct \fBhwloc_obj\fP *obj)"

.PP
Used by backends discovery callbacks to notify other backends of new objects\&. Traverse the list of enabled backends (all but caller) and invoke their notify_new_object() method to notify them that a new object just got added to the topology\&.
.PP
Currently only used for notifying of new PCI device objects\&. 
.SH "Author"
.PP 
Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.