HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
stackTrace.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_TF_STACK_TRACE_H
25 #define PXR_BASE_TF_STACK_TRACE_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/base/tf/api.h"
29 
30 #include <cstdio>
31 #include <ctime>
32 #include <iosfwd>
33 #include <string>
34 
36 
37 class TfCallContext;
38 
39 /// Gets both the C++ and the python stack and returns it as a string.
41 
42 /// Prints both the C++ and the python stack to the \c file provided
43 TF_API
44 void TfPrintStackTrace(FILE *file, const std::string &reason);
45 
46 /// Prints both the C++ and the python stack to the \a stream provided
47 TF_API
48 void TfPrintStackTrace(std::ostream &out, std::string const &reason);
49 
50 /// Logs both the C++ and the python stack to a file in /var/tmp
51 /// A message is printed to stderr reporting that a stack trace
52 /// has been taken and what file it has been written to. If \c
53 /// logtodb is true, then the stack trace will be added to the
54 /// stack_trace database table.
55 TF_API
56 void TfLogStackTrace(const std::string &reason, bool logtodb=false);
57 
58 /// Creates a nicely formatted message describing a crash and writes it to a
59 /// temporary file.
60 ///
61 /// \p reason is a very short descriptive title for the error (ie, FATAL_ERROR)
62 /// \p message further describes the crash (ie, Dereferenced an invalid MfHandle)
63 /// \p additionalInfo is secondary, possibly multi-line, information that should
64 /// be included in the report.
65 /// \p callContext describes the location of the crash
66 /// \p logToDB controls whether the stack will be added to the stack_trace db table.
67 TF_API
68 void TfLogCrash(const std::string &reason,
69  const std::string &message, const std::string &additionalInfo,
70  TfCallContext const &context, bool logToDB);
71 
72 /// Returns the application's launch time.
73 TF_API
74 time_t TfGetAppLaunchTime();
75 
77 
78 #endif
GLuint GLsizei const GLchar * message
Definition: glcorearb.h:2543
#define TF_API
Definition: api.h:40
TF_API void TfPrintStackTrace(FILE *file, const std::string &reason)
Prints both the C++ and the python stack to the file provided.
TF_API void TfLogCrash(const std::string &reason, const std::string &message, const std::string &additionalInfo, TfCallContext const &context, bool logToDB)
TF_API void TfLogStackTrace(const std::string &reason, bool logtodb=false)
GLsizei const GLchar *const * string
Definition: glcorearb.h:814
TF_API std::string TfGetStackTrace()
Gets both the C++ and the python stack and returns it as a string.
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
TF_API time_t TfGetAppLaunchTime()
Returns the application's launch time.
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91