All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
debugger.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 ARCH_DEBUGGER_H
25 #define ARCH_DEBUGGER_H
26 
29 
30 #include "pxr/pxr.h"
31 #include "pxr/base/arch/api.h"
32 #include "pxr/base/arch/attributes.h"
33 
34 PXR_NAMESPACE_OPEN_SCOPE
35 
58 ARCH_API
60 
68 ARCH_API
69 void ArchDebuggerWait(bool wait);
70 
80 ARCH_API
82 
86 ARCH_API
87 bool ArchDebuggerIsAttached() ARCH_NOINLINE;
88 
93 [[noreturn]]
94 ARCH_API
95 void ArchAbort(bool logging = true);
96 
103 #if defined(ARCH_COMPILER_GCC) || defined(ARCH_COMPILER_CLANG)
104 #define ARCH_DEBUGGER_TRAP do { ArchDebuggerTrap(); asm(""); } while (0)
105 #else
106 #define ARCH_DEBUGGER_TRAP do { ArchDebuggerTrap(); } while (0)
107 #endif
108 
109 PXR_NAMESPACE_CLOSE_SCOPE
110 
111 #endif // ARCH_DEBUGGER_H
ARCH_API void ArchDebuggerTrap() ARCH_NOINLINE
Stop in a debugger.
ARCH_API void ArchAbort(bool logging=true)
Abort.
ARCH_API void ArchDebuggerWait(bool wait)
Cause debug traps to wait for the debugger or not.
#define ARCH_NOINLINE
Macro used to indicate that a function should never be inlined.
Definition: attributes.h:75
ARCH_API bool ArchDebuggerIsAttached() ARCH_NOINLINE
Test if a debugger is attached.
ARCH_API bool ArchDebuggerAttach() ARCH_NOINLINE
Attach a debugger.