.TH "Looking at Cache Objects" 3 "Sun Nov 2 2014" "Version 1.10.0" "Hardware Locality (hwloc)" \" -*- nroff -*-
.ad l
.nh
.SH NAME
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\fPtopology, \fBhwloc_const_cpuset_t\fPset)\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\fPtopology, unsignedcachelevel, \fBhwloc_obj_cache_type_t\fPcachetype)\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 \fCHWLOC_TYPE_DEPTH_MULTIPLE\fP\&.
.PP
If no cache level matches, \fCHWLOC_TYPE_DEPTH_UNKNOWN\fP is returned\&.
.PP
If \fCcachetype\fP is \fCHWLOC_OBJ_CACHE_UNIFIED\fP, the depth of the unique matching unified cache level is returned\&.
.PP
If \fCcachetype\fP is \fCHWLOC_OBJ_CACHE_DATA\fP or \fCHWLOC_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 \fCHWLOC_TYPE_DEPTH_MULTIPLE\fP\&. 
.SS "static \fBhwloc_obj_t\fP hwloc_get_shared_cache_covering_obj (\fBhwloc_topology_t\fPtopology, \fBhwloc_obj_t\fPobj)\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\&.