Compute Library
 21.02
CPUUtils.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-2020 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_RUNTIME_CPU_UTILS_H
25 #define ARM_COMPUTE_RUNTIME_CPU_UTILS_H
26 
27 namespace arm_compute
28 {
29 class CPUInfo;
30 
31 namespace utils
32 {
33 namespace cpu
34 {
35 /** This function will try to detect the CPU configuration on the system and will fill
36  * the cpuinfo object accordingly to reflect this.
37  *
38  * @param[out] cpuinfo @ref CPUInfo to be used to hold the system's cpu configuration.
39  */
40 void get_cpu_configuration(CPUInfo &cpuinfo);
41 /** Some systems have both big and small cores, this fuction computes the minimum number of cores
42  * that are exactly the same on the system. To maximize performance the library attempts to process
43  * workloads concurrently using as many threads as big cores are available on the system.
44  *
45  * @return The minumum number of common cores.
46  */
47 unsigned int get_threads_hint();
48 } // namespace cpu
49 } // namespace utils
50 } // namespace arm_compute
51 #endif /* ARM_COMPUTE_RUNTIME_CPU_UTILS_H */
Copyright (c) 2017-2021 Arm Limited.
void get_cpu_configuration(CPUInfo &cpuinfo)
This function will try to detect the CPU configuration on the system and will fill the cpuinfo object...
Definition: CPUUtils.cpp:359
unsigned int get_threads_hint()
Some systems have both big and small cores, this fuction computes the minimum number of cores that ar...
Definition: CPUUtils.cpp:414