Debian Codegraph @

doc/doxygen-doc/man/man3/hwlocality_helper_find_cache.3

raw
1 .TH "hwlocality_helper_find_cache" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 hwlocality_helper_find_cache \- Looking at Cache Objects
6 .SH SYNOPSIS
7 .br
8 .PP
9 .SS "Functions"
10
11 .in +1c
12 .ti -1c
13 .RI "int \fBhwloc_get_cache_type_depth\fP (\fBhwloc_topology_t\fP topology, unsigned cachelevel, \fBhwloc_obj_cache_type_t\fP cachetype)"
14 .br
15 .ti -1c
16 .RI "\fBhwloc_obj_t\fP \fBhwloc_get_cache_covering_cpuset\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set)"
17 .br
18 .ti -1c
19 .RI "\fBhwloc_obj_t\fP \fBhwloc_get_shared_cache_covering_obj\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP obj)"
20 .br
21 .in -1c
22 .SH "Detailed Description"
23 .PP
24
25 .SH "Function Documentation"
26 .PP
27 .SS "\fBhwloc_obj_t\fP hwloc_get_cache_covering_cpuset (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set)\fR [inline]\fP"
28
29 .PP
30 Get the first data (or unified) cache covering a cpuset \fRset\fP\&.
31 .PP
32 \fBReturns\fP
33 .RS 4
34 a covering cache, or \fRNULL\fP if no cache matches\&.
35 .RE
36 .PP
37
38 .SS "int hwloc_get_cache_type_depth (\fBhwloc_topology_t\fP topology, unsigned cachelevel, \fBhwloc_obj_cache_type_t\fP cachetype)\fR [inline]\fP"
39
40 .PP
41 Find the depth of cache objects matching cache level and type\&. Return the depth of the topology level that contains cache objects whose attributes match \fRcachelevel\fP and \fRcachetype\fP\&.
42
43 .PP
44 This function is identical to calling \fBhwloc_get_type_depth()\fP with the corresponding type such as \fBHWLOC_OBJ_L1ICACHE\fP, except that it may also return a Unified cache when looking for an instruction cache\&.
45
46 .PP
47 \fBReturns\fP
48 .RS 4
49 the depth of the unique matching unified cache level is returned if \fRcachetype\fP is \fBHWLOC_OBJ_CACHE_UNIFIED\fP\&.
50
51 .PP
52 the depth of either a matching cache level or a unified cache level if \fRcachetype\fP is \fBHWLOC_OBJ_CACHE_DATA\fP or \fBHWLOC_OBJ_CACHE_INSTRUCTION\fP\&.
53
54 .PP
55 the depth of the matching level if \fRcachetype\fP is \fR-1\fP but only one level matches\&.
56
57 .PP
58 \fBHWLOC_TYPE_DEPTH_MULTIPLE\fP if \fRcachetype\fP is \fR-1\fP but multiple levels match\&.
59
60 .PP
61 \fBHWLOC_TYPE_DEPTH_UNKNOWN\fP if no cache level matches\&.
62 .RE
63 .PP
64
65 .SS "\fBhwloc_obj_t\fP hwloc_get_shared_cache_covering_obj (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP obj)\fR [inline]\fP"
66
67 .PP
68 Get the first data (or unified) cache shared between an object and somebody else\&.
69 .PP
70 \fBReturns\fP
71 .RS 4
72 a shared cache\&.
73
74 .PP
75 \fRNULL\fP if no cache matches or if an invalid object is given (e\&.g\&. I/O object)\&.
76 .RE
77 .PP
78
79 .SH "Author"
80 .PP
81 Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.