File: hwlocality_helper_find_cache.3

package info (click to toggle)
hwloc 1.11.5-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 16,800 kB
  • ctags: 4,878
  • sloc: ansic: 38,012; xml: 7,505; sh: 5,669; makefile: 1,658; php: 8; sed: 4
file content (65 lines) | stat: -rw-r--r-- 2,654 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
.TH "hwlocality_helper_find_cache" 3 "Thu Nov 10 2016" "Version 1.11.5" "Hardware Locality (hwloc)" \" -*- nroff -*-
.ad l
.nh
.SH NAME
hwlocality_helper_find_cache \- Looking at Cache Objects
.SS "Functions"

.in +1c
.ti -1c
.RI "static int \fBhwloc_get_cache_type_depth\fP (\fBhwloc_topology_t\fP topology, unsigned cachelevel, \fBhwloc_obj_cache_type_t\fP cachetype)"
.br
.ti -1c
.RI "static \fBhwloc_obj_t\fP \fBhwloc_get_cache_covering_cpuset\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set)"
.br
.ti -1c
.RI "static \fBhwloc_obj_t\fP \fBhwloc_get_shared_cache_covering_obj\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP obj)"
.br
.in -1c
.SH "Detailed Description"
.PP 

.SH "Function Documentation"
.PP 
.SS "static \fBhwloc_obj_t\fP hwloc_get_cache_covering_cpuset (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set)\fC [inline]\fP, \fC [static]\fP"

.PP
Get the first cache covering a cpuset \fCset\fP\&. 
.PP
\fBReturns:\fP
.RS 4
\fCNULL\fP if no cache matches\&.
.RE
.PP
\fBNote:\fP
.RS 4
This function cannot work if the root object does not have a CPU set, e\&.g\&. if the topology is made of different machines\&. 
.RE
.PP

.SS "static int hwloc_get_cache_type_depth (\fBhwloc_topology_t\fP topology, unsigned cachelevel, \fBhwloc_obj_cache_type_t\fP cachetype)\fC [inline]\fP, \fC [static]\fP"

.PP
Find the depth of cache objects matching cache depth and type\&. Return the depth of the topology level that contains cache objects whose attributes match \fCcachedepth\fP and \fCcachetype\fP\&. This function intends to disambiguate the case where \fBhwloc_get_type_depth()\fP returns \fBHWLOC_TYPE_DEPTH_MULTIPLE\fP\&.
.PP
If no cache level matches, \fBHWLOC_TYPE_DEPTH_UNKNOWN\fP is returned\&.
.PP
If \fCcachetype\fP is \fBHWLOC_OBJ_CACHE_UNIFIED\fP, the depth of the unique matching unified cache level is returned\&.
.PP
If \fCcachetype\fP is \fBHWLOC_OBJ_CACHE_DATA\fP or \fBHWLOC_OBJ_CACHE_INSTRUCTION\fP, either a matching cache, or a unified cache is returned\&.
.PP
If \fCcachetype\fP is \fC-1\fP, it is ignored and multiple levels may match\&. The function returns either the depth of a uniquely matching level or \fBHWLOC_TYPE_DEPTH_MULTIPLE\fP\&. 
.SS "static \fBhwloc_obj_t\fP hwloc_get_shared_cache_covering_obj (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP obj)\fC [inline]\fP, \fC [static]\fP"

.PP
Get the first cache shared between an object and somebody else\&. 
.PP
\fBReturns:\fP
.RS 4
\fCNULL\fP if no cache matches or if an invalid object is given\&. 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.