1e7cf1d9f2a00648045bad6693b5c4379e46fedf
[blender.git] / intern / cycles / util / util_system.h
1 /*
2  * Copyright 2011-2013 Blender Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #ifndef __UTIL_SYSTEM_H__
18 #define __UTIL_SYSTEM_H__
19
20 #include "util/util_string.h"
21
22 CCL_NAMESPACE_BEGIN
23
24 /* Make sure CPU groups / NUMA API is initialized. */
25 bool system_cpu_ensure_initialized();
26
27 /* Get total number of threads in all NUMA nodes / CPU groups. */
28 int system_cpu_thread_count();
29
30 /* Get width in characters of the current console output. */
31 int system_console_width();
32
33 /* Get number of available nodes.
34  *
35  * This is in fact an index of last node plus one and it's not guaranteed
36  * that all nodes up to this one are available. */
37 int system_cpu_num_numa_nodes();
38
39 /* Returns truth if the given node is available for compute. */
40 bool system_cpu_is_numa_node_available(int node);
41
42 /* Get number of available processors on a given node. */
43 int system_cpu_num_numa_node_processors(int node);
44
45 /* Runs the current thread and its children on a specific node.
46  *
47  * Returns truth if affinity has successfully changed. */
48 bool system_cpu_run_thread_on_node(int node);
49
50 /* Number of processors within the current CPU group (or within active thread
51  * thread affinity). */
52 int system_cpu_num_active_group_processors();
53
54 string system_cpu_brand_string();
55 int system_cpu_bits();
56 bool system_cpu_support_sse2();
57 bool system_cpu_support_sse3();
58 bool system_cpu_support_sse41();
59 bool system_cpu_support_avx();
60 bool system_cpu_support_avx2();
61
62 size_t system_physical_ram();
63
64 CCL_NAMESPACE_END
65
66 #endif  /* __UTIL_SYSTEM_H__ */