user_config.h

/*******************************************************************************
 * Copyright 2019 Intel Corporation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files(the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions :
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 ******************************************************************************/
 
// CPU INTRINSICS
 
#if defined(GTS_HAS_CUSTOM_CPU_INTRINSICS_WRAPPERS) || defined(DOXYGEN_DOCUMENTING)
 
#define GTS_PAUSE() #error "Replace with custom definition"
 
#define GTS_RDTSC() #error "Replace with custom definition"
 
#define GTS_MEMORY_FENCE() #error "Replace with custom definition"
 
#define GTS_SPECULATION_FENCE() #error "Replace with custom definition"
 
#define GTS_MSB_SCAN(bitSet) #error "Replace with custom definition"
 
#define GTS_MSB_SCAN64(bitSet) #error "Replace with custom definition"
 
#endif
 // end of CpuIntrinsicsWrapper
 
// C MEMORY WRAPPERS
 
#if defined(GTS_HAS_CUSTOM_DYNAMIC_MEMORY_WRAPPERS) || defined(DOXYGEN_DOCUMENTING)
 
#define GTS_MALLOC(size) #error "Replace with custom definition"
 
#define GTS_FREE(ptr) #error "Replace with custom definition"
 
#define GTS_ALIGNED_MALLOC(size, alignment) #error "Replace with custom definition"
 
#define GTS_ALIGNED_FREE(ptr) #error "Replace with custom definition"
 
#endif
 // end of CMemoryWrapper
 
// OS MEMORY WRAPPERS
 
#if defined(GTS_HAS_CUSTOM_OS_MEMORY_WRAPPERS) || defined(DOXYGEN_DOCUMENTING)
 
#define GTS_GET_OS_ALLOCATION_GRULARITY() #error "Replace with custom definition"
 
#define GTS_GET_OS_PAGE_SIZE() #error "Replace with custom definition"
 
#define GTS_GET_OS_LARGE_PAGE_SIZE() #error "Replace with custom definition"
 
#define GTS_ENABLE_LARGE_PAGE_SUPPORT() #error "Replace with custom definition"
 
#define GTS_OS_HEAP_ALLOCATE(size) #error "Replace with custom definition"
 
#define GTS_OS_HEAP_FREE(ptr) #error "Replace with custom definition"
 
#define GTS_OS_VIRTUAL_ALLOCATE(ptr, size, commit, largePage) #error "Replace with custom definition"
 
#define GTS_OS_VIRTUAL_COMMIT(ptr, size) #error "Replace with custom definition"
 
#define GTS_OS_VIRTUAL_DECOMMIT(ptr, size) #error "Replace with custom definition"
 
#define GTS_OS_VIRTUAL_FREE(ptr, size)
 
#endif
 // end of OsMemoryWrapper
 
// OS THREAD WRAPPERS
 
#if defined(GTS_HAS_CUSTOM_THREAD_WRAPPERS) || defined(DOXYGEN_DOCUMENTING)
 
#define GTS_CONTEXT_SWITCH_CYCLES #error "Replace with custom definition"
#define GTS_THREAD_AFFINITY_ALL #error "Replace with custom definition"
 
#define GTS_THREAD_PRIORITY_HIGHEST #error "Replace with custom definition"
#define GTS_THREAD_PRIORITY_ABOVE_NORMAL #error "Replace with custom definition"
#define GTS_THREAD_PRIORITY_NORMAL #error "Replace with custom definition"
#define GTS_THREAD_PRIORITY_BELOW_NORMAL #error "Replace with custom definition"
#define GTS_THREAD_PRIORITY_BELOW_LOWEST #error "Replace with custom definition"
 
#define GTS_THREAD_HANDLE_TYPE #error "Replace with custom definition"
#define GTS_THREAD_ID_TYPE #error "Replace with custom definition"
 
#define GTS_THREAD_FUNCTION_DECL(name) #error "Replace with custom definition"
#define GTS_THREAD_FUNCTION_DEFN(cls, name) #error "Replace with custom definition"
 
#define GTS_THREAD_AFFINITY_SET_TYPE #error "Replace with custom definition"
 
#define GTS_CREATE_THREAD(threadHandle, tid, func, arg, stackSize) #error "Replace with custom definition"
 
#define GTS_JOIN_THREAD(threadHandle) #error "Replace with custom definition"
 
#define GTS_DESTROY_THREAD(threadHandle) #error "Replace with custom definition"
 
#define GTS_SET_THREAD_GROUP_AFFINITY(threadHandle, groupId, affinitySet) #error "Replace with custom definition"
 
#define GTS_SET_THREAD_PRIORITY(tid, priority) #error "Replace with custom definition"
 
#define GTS_SET_THIS_THREAD_NAME(name) #error "Replace with custom definition"
 
#define GTS_GET_THIS_THREAD_ID() #error "Replace with custom definition"
 
#define GTS_GET_THIS_THREAD() #error "Replace with custom definition"
 
#define GTS_SET_THIS_THREAD_GROUP_AFFINITY(groupId, affinitySet) #error "Replace with custom definition"
 
#define GTS_SET_THREAD_PRIORITY(priority) #error "Replace with custom definition"
 
#define GTS_YIELD_THREAD() #error "Replace with custom definition"
 
#define GTS_THREAD_SLEEP(milliseconds) #error "Replace with custom definition"
 
#define GTS_GET_HARDWARE_THREAD_COUNT() #error "Replace with custom definition"
 
#define GTS_GET_CURRENT_PROCESSOR_ID(socketId, hwTid) #error "Replace with custom definition"
 
// CPU TOPOLOGY
 
#define GTS_CPU_CORE_INFO #error "Replace with custom definition"
 
#define GTS_SOCKET_CORE_INFO #error "Replace with custom definition"
 
#define GTS_NUMA_NODE_CORE_INFO #error "Replace with custom definition"
 
#define GTS_PROCESSOR_GROUP_INFO #error "Replace with custom definition"
 
#define GTS_SYSTEM_TOPOLOGY #error "Replace with custom definition"
 
#endif
 // end of OsThreadWrapper
 
// OS EVENT WRAPPERS
 
#if defined(GTS_HAS_CUSTOM_EVENT_WRAPPERS) || defined(DOXYGEN_DOCUMENTING)
 
#define GTS_WAIT_FOREVER #error "Replace with custom definition"
#define GTS_EVENT_HANDLE_TYPE #error "Replace with custom definition"
 
#define GTS_CREATE_EVENT(eventHandle) #error "Replace with custom definition"
 
#define GTS_DESTROY_EVENT(eventHandle) #error "Replace with custom definition"
 
#define GTS_WAIT_FOR_EVENT(eventHandle, waitForever) #error "Replace with custom definition"
 
#define GTS_SIGNAL_EVENT(eventHandle) #error "Replace with custom definition"
 
#define GTS_RESET_EVENT(eventHandle) #error "Replace with custom definition"
 
#endif
 // end of OsEventWrapper
 
// ATOMICS
 
#if defined(GTS_HAS_CUSTOM_ATOMICS_WRAPPERS) || defined(DOXYGEN_DOCUMENTING)
 
// See: https://en.cppreference.com/w/cpp/atomic/memory_order
#define GTS_MEMORY_ORDER_RELAXED #error "Replace with custom definition"
#define GTS_MEMORY_ORDER_CONSUME #error "Replace with custom definition"
#define GTS_MEMORY_ORDER_ACQUIRE #error "Replace with custom definition"
#define GTS_MEMORY_ORDER_RELEASE #error "Replace with custom definition"
#define GTS_MEMORY_ORDER_ACQ_REL #error "Replace with custom definition"
#define GTS_MEMORY_ORDER_SEQ_CST #error "Replace with custom definition"
 
#define GTS_ATOMIC_TYPE #error "Replace with custom definition"
 
#define GTS_ATOMIC_LOAD(a, memoryOrder) #error "Replace with custom definition"
 
#define GTS_ATOMIC_STORE(a, value, memoryOrder) #error "Replace with custom definition"
 
#define GTS_ATOMIC_FETCH_ADD(a, inc, memoryOrder) #error "Replace with custom definition"
 
#define GTS_ATOMIC_FETCH_AND(a, rhs, memoryOrder) #error "Replace with custom definition"
 
#define GTS_ATOMIC_FETCH_OR(a, rhs, memoryOrder) #error "Replace with custom definition"
 
#define GTS_ATOMIC_EXCHANGE(a, value, memoryOrder) #error "Replace with custom definition"
 
#define GTS_ATOMIC_COMPARE_EXCHANGE_WEAK(a, expected, value, xchgMemoryOrder, loadMemoryOrder) #error "Replace with custom definition"
 
#define GTS_ATOMIC_COMPARE_EXCHANGE_STRONG(a, expected, value, xchgMemoryOrder, loadMemoryOrder) #error "Replace with custom definition"
 
#endif
 // end of AtomicsWrapper
 
// ASSERT
 
#if defined(GTS_HAS_CUSTOM_ASSERT_WRAPPER) || defined(DOXYGEN_DOCUMENTING)
 
#GTS_CUSTOM_ASSERT(expression, file, line) #error "Replace with custom definition or nothing."
 
#endif
 // end of AssertWrapper
 
// TRACING
 
#if defined(GTS_HAS_CUSTOM_TRACE_WRAPPER) || defined(DOXYGEN_DOCUMENTING)
 
#include "gts/analysis/TraceCaptureMask.h"
#include "gts/analysis/TraceColors.h"
 
#define GTS_TRACE_INIT #error "Replace with custom definition"
 
#define GTS_TRACE_DUMP(filename) #error "Replace with custom definition or nothing."
 
#define GTS_TRACE_NAME_THREAD(captureMask, tid, fmt, ...) #error "Replace with custom definition or nothing."
 
#define GTS_TRACE_SET_CAPTURE_MASK(captureMask) #error "Replace with custom definition or nothing."
 
#define GTS_TRACE_FRAME_MARK(captureMask) #error "Replace with custom definition or nothing."
 
#define GTS_TRACE_SCOPED_ZONE(captureMask, color, fmt, ...) #error "Replace with custom definition or nothing."
#define GTS_TRACE_SCOPED_ZONE_P0(captureMask, color, txt) #error "Replace with custom definition or nothing."
#define GTS_TRACE_SCOPED_ZONE_P1(captureMask, color, txt, param1) #error "Replace with custom definition or nothing."
#define GTS_TRACE_SCOPED_ZONE_P2(captureMask, color, txt, param1, param2) #error "Replace with custom definition or nothing."
#define GTS_TRACE_SCOPED_ZONE_P3(captureMask, color, txt, param1, param2, param3) #error "Replace with custom definition or nothing."
 
#define GTS_TRACE_ZONE_MARKER(captureMask, color, fmt, ...) #error "Replace with custom definition or nothing."
#define GTS_TRACE_ZONE_MARKER_P0(captureMask, color, txt) #error "Replace with custom definition or nothing."
#define GTS_TRACE_ZONE_MARKER_P1(captureMask, color, txt, param1) #error "Replace with custom definition or nothing."
#define GTS_TRACE_ZONE_MARKER_P2(captureMask, color, txt, param1, param2) #error "Replace with custom definition or nothing."
#define GTS_TRACE_ZONE_MARKER_P3(captureMask, color, txt, param1, param2, param3) #error "Replace with custom definition or nothing."
 
#define GTS_TRACE_PLOT(captureMask, val, txt) #error "Replace with custom definition or nothing."
 
#define GTS_TRACE_ALLOC(captureMask, ptr, size, fmt, ...) #error "Replace with custom definition or nothing."
#define GTS_TRACE_FREE(captureMask, ptr, fmt, ...) #error "Replace with custom definition or nothing."
 
#define GTS_TRACE_MUTEX(type, varname) #error "Replace with custom definition or nothing."
#define GTS_TRACE_MUTEX_TYPE(type) #error "Replace with custom definition or nothing."
#define GTS_TRACE_WAIT_FOR_LOCK_START(captureMask, pLock, fmt, ...) #error "Replace with custom definition or nothing."
#define GTS_TRACE_WAIT_FOR_END(captureMask) #error "Replace with custom definition or nothing."
#define GTS_TRACE_LOCK_ACQUIRED(captureMask, pLock, fmt, ...) #error "Replace with custom definition or nothing."
#define GTS_TRACE_LOCK_RELEASED(captureMask, pLock) #error "Replace with custom definition or nothing."
 
#endif
 // end of TracingWrapper
 // end of Config