Loading...
Searching...
No Matches
threads.h
Go to the documentation of this file.
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the Apache License, Version 2.0 (the "Apache License")
5// with the following modification; you may not use this file except in
6// compliance with the Apache License and the following modification to it:
7// Section 6. Trademarks. is deleted and replaced with:
8//
9// 6. Trademarks. This License does not grant permission to use the trade
10// names, trademarks, service marks, or product names of the Licensor
11// and its affiliates, except as required to comply with Section 4(c) of
12// the License and to reproduce the content of the NOTICE file.
13//
14// You may obtain a copy of the Apache License at
15//
16// http://www.apache.org/licenses/LICENSE-2.0
17//
18// Unless required by applicable law or agreed to in writing, software
19// distributed under the Apache License with the above modification is
20// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21// KIND, either express or implied. See the Apache License for the specific
22// language governing permissions and limitations under the Apache License.
23//
24#ifndef PXR_BASE_ARCH_THREADS_H
25#define PXR_BASE_ARCH_THREADS_H
26
30
31#include "pxr/pxr.h"
32#include "pxr/base/arch/api.h"
33#include "pxr/base/arch/defines.h"
34
35// Needed for ARCH_SPIN_PAUSE on Windows in builds with precompiled
36// headers disabled.
37#ifdef ARCH_COMPILER_MSVC
38#include <intrin.h>
39#endif
40
41#include <thread>
42
43PXR_NAMESPACE_OPEN_SCOPE
44
47ARCH_API bool ArchIsMainThread();
48
51ARCH_API std::thread::id ArchGetMainThreadId();
52
54#if defined(ARCH_CPU_INTEL)
55#if defined(ARCH_COMPILER_GCC) || defined(ARCH_COMPILER_CLANG)
56#define ARCH_SPIN_PAUSE() __builtin_ia32_pause()
57#elif defined(ARCH_COMPILER_MSVC)
58#define ARCH_SPIN_PAUSE() _mm_pause()
59#endif
60#elif defined(ARCH_CPU_ARM)
61#if defined(ARCH_COMPILER_GCC) || defined(ARCH_COMPILER_CLANG)
62#define ARCH_SPIN_PAUSE() asm volatile ("yield" ::: "memory")
63#elif defined(ARCH_COMPILER_MSVC)
64#define ARCH_SPIN_PAUSE() __yield();
65#endif
66#else
67#define ARCH_SPIN_PAUSE()
68#endif
69
70PXR_NAMESPACE_CLOSE_SCOPE
71
72#endif // PXR_BASE_ARCH_THREADS_H
ARCH_API std::thread::id ArchGetMainThreadId()
Return the std::thread_id for the thread arch considers to be the "main" thread.
ARCH_API bool ArchIsMainThread()
Return true if the calling thread is the main thread, false otherwise.