1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
// Copyright 2014 Renato Tegon Forti, Antony Polukhin.
// Copyright 2015-2016 Antony Polukhin.
//
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt
// or copy at http://www.boost.org/LICENSE_1_0.txt)
#ifndef BOOST_DLL_RUNTIME_SYMBOL_INFO_HPP
#define BOOST_DLL_RUNTIME_SYMBOL_INFO_HPP
#include <boost/config.hpp>
#include <boost/predef/os.h>
#include <boost/predef/compiler/visualc.h>
#include <boost/dll/detail/aggressive_ptr_cast.hpp>
#if BOOST_OS_WINDOWS
# include <boost/detail/winapi/dll.hpp>
# include <boost/dll/detail/windows/path_from_handle.hpp>
#else
# include <dlfcn.h>
# include <boost/dll/detail/posix/program_location_impl.hpp>
#endif
#ifdef BOOST_HAS_PRAGMA_ONCE
# pragma once
#endif
/// \file boost/dll/runtime_symbol_info.hpp
/// \brief Provides methods for getting acceptable by boost::dll::shared_library location of symbol, source line or program.
namespace boost { namespace dll {
namespace detail {
#if BOOST_OS_WINDOWS
inline boost::filesystem::path symbol_location_impl(const void* symbol, boost::system::error_code& ec) {
boost::filesystem::path ret;
boost::detail::winapi::MEMORY_BASIC_INFORMATION_ mbi;
if (!boost::detail::winapi::VirtualQuery(symbol, &mbi, sizeof(mbi))) {
ec = boost::dll::detail::last_error_code();
return ret;
}
return boost::dll::detail::path_from_handle(reinterpret_cast<boost::detail::winapi::HMODULE_>(mbi.AllocationBase), ec);
}
inline boost::filesystem::path program_location_impl(boost::system::error_code& ec) {
return boost::dll::detail::path_from_handle(NULL, ec);
}
#else
inline boost::filesystem::path symbol_location_impl(const void* symbol, boost::system::error_code& ec) {
boost::filesystem::path ret;
Dl_info info;
// Some of the libc headers miss `const` in `dladdr(const void*, Dl_info*)`
const int res = dladdr(const_cast<void*>(symbol), &info);
if (res) {
ret = info.dli_fname;
} else {
boost::dll::detail::reset_dlerror();
ec = boost::system::error_code(
boost::system::errc::bad_address,
boost::system::generic_category()
);
}
return ret;
}
#endif
} // namespace detail
/*!
* On success returns full path and name of the binary object that holds symbol.
* \tparam T Type of the symbol, must not be explicitly specified.
* \param symbol Symbol which location is to be determined.
* \param ec Variable that will be set to the result of the operation.
* \return Path to the binary object that holds symbol or empty path in case error.
* \throws std::bad_alloc in case of insufficient memory. Overload that does not accept boost::system::error_code also throws boost::system::system_error.
*
* \b Examples:
* \code
* int var;
* void foo() {}
*
* int main() {
* dll::symbol_location(var); // returns program location
* dll::symbol_location(foo); // returns program location
* dll::symbol_location(std::cerr); // returns location of libstdc++: "/usr/lib/x86_64-linux-gnu/libstdc++.so.6"
* dll::symbol_location(std::placeholders::_1); // returns location of libstdc++: "/usr/lib/x86_64-linux-gnu/libstdc++.so.6"
* dll::symbol_location(std::puts); // returns location of libc: "/lib/x86_64-linux-gnu/libc.so.6"
* }
* \endcode
*/
template <class T>
inline boost::filesystem::path symbol_location(const T& symbol, boost::system::error_code& ec) {
ec.clear();
return boost::dll::detail::symbol_location_impl(
boost::dll::detail::aggressive_ptr_cast<const void*>(boost::addressof(symbol)),
ec
);
}
#if BOOST_COMP_MSVC < BOOST_VERSION_NUMBER(14,0,0)
// Without this MSVC 7.1 fails with:
// ..\boost\dll\runtime_symbol_info.hpp(133) : error C2780: 'filesystem::path dll::symbol_location(const T &)' : expects 1 arguments - 2 provided
template <class T>
inline boost::filesystem::path symbol_location(const T& symbol, const char* /*workaround*/ = 0)
#else
//! \overload symbol_location(const T& symbol, boost::system::error_code& ec)
template <class T>
inline boost::filesystem::path symbol_location(const T& symbol)
#endif
{
boost::filesystem::path ret;
boost::system::error_code ec;
ret = boost::dll::detail::symbol_location_impl(
boost::dll::detail::aggressive_ptr_cast<const void*>(boost::addressof(symbol)),
ec
);
if (ec) {
boost::dll::detail::report_error(ec, "boost::dll::symbol_location(const T& symbol) failed");
}
return ret;
}
/// @cond
// We have anonymous namespace here to make sure that `this_line_location()` method is instantiated in
// current translation module and is not shadowed by instantiations from other modules.
namespace {
/// @endcond
/*!
* On success returns full path and name of the binary object that holds the current line of code
* (the line in which the `this_line_location()` method was called).
*
* \param ec Variable that will be set to the result of the operation.
* \throws std::bad_alloc in case of insufficient memory. Overload that does not accept boost::system::error_code also throws boost::system::system_error.
*/
static inline boost::filesystem::path this_line_location(boost::system::error_code& ec) {
typedef boost::filesystem::path(func_t)(boost::system::error_code& );
func_t& f = this_line_location;
return boost::dll::symbol_location(f, ec);
}
//! \overload this_line_location(boost::system::error_code& ec)
static inline boost::filesystem::path this_line_location() {
boost::filesystem::path ret;
boost::system::error_code ec;
ret = this_line_location(ec);
if (ec) {
boost::dll::detail::report_error(ec, "boost::dll::this_line_location() failed");
}
return ret;
}
/// @cond
} // anonymous namespace
/// @endcond
/*!
* On success returns full path and name of the currently running program (the one which contains the `main()` function).
*
* Return value can be used as a parameter for shared_library. See Tutorial "Linking plugin into the executable"
* for usage example. Flag '-rdynamic' must be used when linking the plugin into the executable
* on Linux OS.
*
* \param ec Variable that will be set to the result of the operation.
* \throws std::bad_alloc in case of insufficient memory. Overload that does not accept boost::system::error_code also throws boost::system::system_error.
*/
inline boost::filesystem::path program_location(boost::system::error_code& ec) {
ec.clear();
return boost::dll::detail::program_location_impl(ec);
}
//! \overload program_location(boost::system::error_code& ec) {
inline boost::filesystem::path program_location() {
boost::filesystem::path ret;
boost::system::error_code ec;
ret = boost::dll::detail::program_location_impl(ec);
if (ec) {
boost::dll::detail::report_error(ec, "boost::dll::program_location() failed");
}
return ret;
}
}} // namespace boost::dll
#endif // BOOST_DLL_RUNTIME_SYMBOL_INFO_HPP
|
