LSSTApplications  19.0.0-14-gb0260a2+c4152221ba,20.0.0+428775a0ef,20.0.0+7c6b12c2f9,20.0.0+ae956f52c5,20.0.0+c388114e2c,20.0.0+e2e26847c2,20.0.0+e5529315c6,20.0.0-1-g04bee24+7c6b12c2f9,20.0.0-1-g10df615+cc9679e3e4,20.0.0-1-g253301a+7c6b12c2f9,20.0.0-1-g2b7511a+46a6078777,20.0.0-1-g4d801e7+9b3155b620,20.0.0-1-g5b95a8c+3d35cd64b7,20.0.0-1-gb058bd0+46a6078777,20.0.0-1-gb88604f+acecce4127,20.0.0-1-gc96f8cb+f5ea1f6730,20.0.0-1-gedffbd8+57e6df9186,20.0.0-10-g0891cd99+21712b8dc8,20.0.0-10-g9a20bd332+576ca7b471,20.0.0-17-gcdbda88+f8ebf1b2ab,20.0.0-2-g4dae9ad+f5ea1f6730,20.0.0-2-g61b8584+85c46248f3,20.0.0-2-gb780d76+f45b7d88f4,20.0.0-20-g7966b28+f5ea1f6730,20.0.0-21-g1f5da01+74cacf985d,20.0.0-23-g8900aa8+dfd6ff4ddf,20.0.0-3-g1653f94+85c46248f3,20.0.0-3-g4cc78c6+63636aeed8,20.0.0-3-g750bffe+3a91ba9410,20.0.0-3-gbd60e8c+ff10c6d78d,20.0.0-32-g15a0e07c+fb20712e7c,20.0.0-4-g97dc21a+dfd6ff4ddf,20.0.0-4-gfea843c+f45b7d88f4,20.0.0-5-g357b56b+f45b7d88f4,20.0.0-59-gb502cbb+701042a847,20.0.0-6-g9a5b7a1+3980549e0d,20.0.0-7-gcda7bf1+ddb9d7f898,w.2020.43
LSSTDataManagementBasePackage
Backtrace.cc
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 
3 /*
4  * LSST Data Management System
5  * Copyright 2008-2017 AURA/LSST.
6  *
7  * This product includes software developed by the
8  * LSST Project (http://www.lsst.org/).
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the LSST License Statement and
21  * the GNU General Public License along with this program. If not,
22  * see <https://www.lsstcorp.org/LegalNotices/>.
23  */
24 
25 #if defined(LSST_UTILS_BACKTRACE_ENABLE) && (defined(__clang__) || defined(__GNUC__))
26 
27 #include <cerrno>
28 #include <cstdio>
29 #include <cstdlib>
30 #include <csignal>
31 
32 #include <cxxabi.h>
33 #include <execinfo.h>
34 
35 #include <regex>
36 
37 #include "lsst/utils/Backtrace.h"
38 
39 namespace lsst {
40 namespace utils {
41 
42 namespace {
43 
45 static constexpr size_t MAX_FRAMES = 128;
47 static constexpr size_t NAME_SIZE_ESTIMATE = 1024;
48 
61 char *demangleAndPrint(char *input, char *buffer, size_t *bufferSize) noexcept {
62  int status = 1;
63 
64  try {
65  std::cmatch matches;
66  std::regex rgx(
67  "(.*[\\s|\\(])" // before
68  "(_\\w+)" // mangled name
69  "(.*\\+.*)" // after
70  );
71 
72  if (std::regex_match(input, matches, rgx)) {
73  buffer = abi::__cxa_demangle(matches.str(2).c_str(), buffer, bufferSize, &status);
74  fprintf(stderr, "%s%s%s\n", matches.str(1).c_str(), buffer, matches.str(3).c_str());
75  }
76  } catch(const std::regex_error &e) {
77  fprintf(stderr, "[demangleAndPrint] %s\n", e.what());
78  status = 1;
79  } catch(const std::runtime_error &e) {
80  fprintf(stderr, "[demangleAndPrint] %s\n", e.what());
81  status = 1;
82  } catch(const std::exception &e) {
83  fprintf(stderr, "[demangleAndPrint] %s\n", e.what());
84  status = 1;
85  } catch(...) {
86  fprintf(stderr, "[demangleAndPrint] unknown error occurred in demangling\n");
87  status = 1;
88  }
89 
90  if (status != 0) {
91  // no name found to demangle or name demangling failed
92  fprintf(stderr, "%s\n", input);
93  }
94  return buffer;
95 }
96 
104 void raiseWithDefaultHandler(int signum) noexcept {
105  signal(signum, SIG_DFL);
106  raise(signum);
107 }
108 
114 void signalHandler(int signum) noexcept {
115  fprintf(stderr, "Caught signal %d, backtrace follows:\n", signum);
116 
117  // retrieve current stack addresses
118  void *addressList[MAX_FRAMES + 1];
119  size_t addressLength = backtrace(addressList, MAX_FRAMES);
120  if (addressLength == 0) {
121  fprintf(stderr, " \n");
122  return;
123  }
124 
125  // translate the addresses into an array of strings
126  // that describe the addresses symbolically.
127  // return value symbolList is malloc'ed and must be free'd
128  char **symbolList = backtrace_symbols(addressList, addressLength);
129  if (symbolList == NULL) {
130  fprintf(stderr, "[backtrace_symbols] cannot dump trace, probably out of memory\n");
131  raiseWithDefaultHandler(signum);
132  }
133 
134  // allocate storage for demangled name
135  // this will be reallocated by abi::__cxa_demangle in demangleAndPrint
136  // if storage is insufficient, but if it is sufficient
137  // this reduces the number of allocations
138  size_t nameSize = NAME_SIZE_ESTIMATE;
139  char *name = (char *)malloc(nameSize * sizeof(char));
140  if (name == NULL) {
141  fprintf(stderr, "[malloc] cannot dump trace, probably out of memory\n");
142  raiseWithDefaultHandler(signum);
143  }
144 
145  for (size_t i = 0; i < addressLength; ++i) {
146  if (char *buffer = demangleAndPrint(symbolList[i], name, &nameSize)) {
147  // buffer may have been realloc'ed
148  name = buffer;
149  }
150  }
151 
152  free(name);
153  free(symbolList);
154  raiseWithDefaultHandler(signum);
155 }
156 
157 } // namespace
158 
159 Backtrace::Backtrace() noexcept : enabled(true) {
160  // Register abort handlers
161  signal(SIGABRT, signalHandler);
162  signal(SIGSEGV, signalHandler);
163  signal(SIGILL, signalHandler);
164  signal(SIGFPE, signalHandler);
165 }
166 
167 } // namespace utils
168 } // namespace lsst
169 
170 #else
171 
172 #include "lsst/utils/Backtrace.h"
173 
174 namespace lsst {
175 namespace utils {
176 
177 Backtrace::Backtrace() noexcept : enabled(false) {}
178 
179 } // namespace utils
180 } // namespace lsst
181 
182 #endif
std::regex_error
std::exception
STL class.
Backtrace.h
std::regex_match
T regex_match(T... args)
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
std::fprintf
T fprintf(T... args)
std::runtime_error
STL class.
std::regex
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
std::signal
T signal(T... args)
std::free
T free(T... args)
std::cmatch::str
T str(T... args)
std::cmatch
std::malloc
T malloc(T... args)
std::regex_error::what
T what(T... args)