1 // Copyright Antony Polukhin, 2016-2020.
3 // Distributed under the Boost Software License, Version 1.0. (See
4 // accompanying file LICENSE_1_0.txt or copy at
5 // http://www.boost.org/LICENSE_1_0.txt)
7 #ifndef BOOST_STACKTRACE_DETAIL_ADDR2LINE_IMPLS_HPP
8 #define BOOST_STACKTRACE_DETAIL_ADDR2LINE_IMPLS_HPP
10 #include <boost/config.hpp>
11 #ifdef BOOST_HAS_PRAGMA_ONCE
15 #include <boost/stacktrace/detail/to_hex_array.hpp>
16 #include <boost/stacktrace/detail/to_dec_array.hpp>
17 #include <boost/stacktrace/detail/try_dec_convert.hpp>
18 #include <boost/core/demangle.hpp>
21 #include <sys/types.h>
26 namespace boost { namespace stacktrace { namespace detail {
29 #if defined(BOOST_STACKTRACE_ADDR2LINE_LOCATION) && !defined(BOOST_NO_CXX11_CONSTEXPR)
31 constexpr bool is_abs_path(const char* path) BOOST_NOEXCEPT {
32 return *path != '\0' && (
33 *path == ':' || *path == '/' || is_abs_path(path + 1)
39 class addr2line_pipe {
44 explicit addr2line_pipe(const char *flag, const char* exec_path, const char* addr) BOOST_NOEXCEPT
49 #ifdef BOOST_STACKTRACE_ADDR2LINE_LOCATION
50 char prog_name[] = BOOST_STRINGIZE( BOOST_STACKTRACE_ADDR2LINE_LOCATION );
51 #if !defined(BOOST_NO_CXX11_CONSTEXPR) && !defined(BOOST_NO_CXX11_STATIC_ASSERT)
53 boost::stacktrace::detail::is_abs_path( BOOST_STRINGIZE( BOOST_STACKTRACE_ADDR2LINE_LOCATION ) ),
54 "BOOST_STACKTRACE_ADDR2LINE_LOCATION must be an absolute path"
59 char prog_name[] = "/usr/bin/addr2line";
64 const_cast<char*>(flag),
65 const_cast<char*>(exec_path),
66 const_cast<char*>(addr),
70 if (::pipe(pdes) < 0) {
84 ::close(STDERR_FILENO);
86 if (pdes[1] != STDOUT_FILENO) {
87 ::dup2(pdes[1], STDOUT_FILENO);
90 // Do not use `execlp()`, `execvp()`, and `execvpe()` here!
91 // `exec*p*` functions are vulnerable to PATH variable evaluation attacks.
92 ::execv(prog_name, argp);
96 p = ::fdopen(pdes[0], "r");
100 operator ::FILE*() const BOOST_NOEXCEPT {
104 ~addr2line_pipe() BOOST_NOEXCEPT {
108 ::kill(pid, SIGKILL);
109 ::waitpid(pid, &pstat, 0);
114 inline std::string addr2line(const char* flag, const void* addr) {
117 boost::stacktrace::detail::location_from_symbol loc(addr);
122 int rlin_size = ::readlink("/proc/self/exe", &res[0], res.size() - 1);
123 while (rlin_size == static_cast<int>(res.size() - 1)) {
124 res.resize(res.size() * 4);
125 rlin_size = ::readlink("/proc/self/exe", &res[0], res.size() - 1);
127 if (rlin_size == -1) {
131 res.resize(rlin_size);
134 addr2line_pipe p(flag, res.c_str(), to_hex_array(addr).data());
143 if (::fgets(data, sizeof(data), p)) {
151 while (!res.empty() && (res[res.size() - 1] == '\n' || res[res.size() - 1] == '\r')) {
152 res.erase(res.size() - 1);
159 struct to_string_using_addr2line {
161 void prepare_function_name(const void* addr) {
162 res = boost::stacktrace::frame(addr).name();
165 bool prepare_source_location(const void* addr) {
166 //return addr2line("-Cfipe", addr); // Does not seem to work in all cases
167 std::string source_line = boost::stacktrace::detail::addr2line("-Cpe", addr);
168 if (!source_line.empty() && source_line[0] != '?') {
178 template <class Base> class to_string_impl_base;
179 typedef to_string_impl_base<to_string_using_addr2line> to_string_impl;
181 inline std::string name_impl(const void* addr) {
182 std::string res = boost::stacktrace::detail::addr2line("-fe", addr);
183 res = res.substr(0, res.find_last_of('\n'));
184 res = boost::core::demangle(res.c_str());
193 } // namespace detail
195 std::string frame::source_file() const {
197 res = boost::stacktrace::detail::addr2line("-e", addr_);
198 res = res.substr(0, res.find_last_of(':'));
207 std::size_t frame::source_line() const {
208 std::size_t line_num = 0;
209 std::string res = boost::stacktrace::detail::addr2line("-e", addr_);
210 const std::size_t last = res.find_last_of(':');
211 if (last == std::string::npos) {
214 res = res.substr(last + 1);
216 if (!boost::stacktrace::detail::try_dec_convert(res.c_str(), line_num)) {
224 }} // namespace boost::stacktrace
226 #endif // BOOST_STACKTRACE_DETAIL_ADDR2LINE_IMPLS_HPP