HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
symbols.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_SYMBOLS_H
25 #define ARCH_SYMBOLS_H
26 
27 /// \file arch/symbols.h
28 /// \ingroup group_arch_Diagnostics
29 /// Architecture-specific symbol lookup routines.
30 
31 #include "pxr/pxr.h"
32 #include "pxr/base/arch/api.h"
33 #include <string>
34 
36 
37 /// Returns information about the address \p address in the running program.
38 ///
39 /// Returns \c false if no information can be found, otherwise returns \c true
40 /// and modifies the other arguments: \p objectPath is set to the absolute path
41 /// to the executable or library the address is found in, \p baseAddress is the
42 /// address where that object is loaded, \p symbolName is the symbolic name of
43 /// the thing containing the address, and \p symbolAddress is the starting
44 /// address of that thing. If no thing is found to contain the address then
45 /// \p symbolName is cleared and \p symbolAddress is set to \c NULL. Any of
46 /// the arguments except \p address can be \c NULL if the result isn't needed.
47 /// This will return \c false if \c NULL is passed to \p address.
48 ///
49 /// \ingroup group_arch_Diagnostics
51 bool ArchGetAddressInfo(void* address,
52  std::string* objectPath, void** baseAddress,
53  std::string* symbolName, void** symbolAddress);
54 
56 
57 #endif // ARCH_SYMBOLS_H
GLuint GLuint64EXT address
Definition: glew.h:14600
PXR_NAMESPACE_OPEN_SCOPE ARCH_API bool ArchGetAddressInfo(void *address, std::string *objectPath, void **baseAddress, std::string *symbolName, void **symbolAddress)
GLsizei const GLchar *const * string
Definition: glew.h:1844
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1245
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:83
#define ARCH_API
Definition: api.h:40