/*
 * Copyright 2011-2013 Blender Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __UTIL_SYSTEM_H__
#define __UTIL_SYSTEM_H__

#include "util/util_string.h"
#include "util/util_vector.h"

CCL_NAMESPACE_BEGIN

/* Make sure CPU groups / NUMA API is initialized. */
bool system_cpu_ensure_initialized();

/* Get total number of threads in all NUMA nodes / CPU groups. */
int system_cpu_thread_count();

/* Get width in characters of the current console output. */
int system_console_width();

/* Get number of available nodes.
 *
 * This is in fact an index of last node plus one and it's not guaranteed
 * that all nodes up to this one are available. */
int system_cpu_num_numa_nodes();

/* Returns truth if the given node is available for compute. */
bool system_cpu_is_numa_node_available(int node);

/* Get number of available processors on a given node. */
int system_cpu_num_numa_node_processors(int node);

/* Runs the current thread and its children on a specific node.
 *
 * Returns truth if affinity has successfully changed. */
bool system_cpu_run_thread_on_node(int node);

/* Number of processors within the current CPU group (or within active thread
 * thread affinity). */
int system_cpu_num_active_group_processors();

string system_cpu_brand_string();
int system_cpu_bits();
bool system_cpu_support_sse2();
bool system_cpu_support_sse3();
bool system_cpu_support_sse41();
bool system_cpu_support_avx();
bool system_cpu_support_avx2();

size_t system_physical_ram();

/* Start a new process of the current application with the given arguments. */
bool system_call_self(const vector<string> &args);

/* Get identifier of the currently running process. */
uint64_t system_self_process_id();

CCL_NAMESPACE_END

#endif /* __UTIL_SYSTEM_H__ */