aboutsummaryrefslogtreecommitdiff
path: root/libbutl/backtrace.hxx
diff options
context:
space:
mode:
authorKaren Arutyunov <karen@codesynthesis.com>2021-09-28 19:24:31 +0300
committerKaren Arutyunov <karen@codesynthesis.com>2021-09-28 20:29:59 +0300
commitdf1ef68cd8e8582724ce1192bfc202e0b9aeaf0c (patch)
treeb731ca4c68e60c00c7e7d499dbf4868ee7b71f44 /libbutl/backtrace.hxx
parent7a4fc37f264cdb67f2f83fa92703c869215bbc86 (diff)
Get rid of C++ modules related code and rename *.mxx files to *.hxx
Diffstat (limited to 'libbutl/backtrace.hxx')
-rw-r--r--libbutl/backtrace.hxx27
1 files changed, 27 insertions, 0 deletions
diff --git a/libbutl/backtrace.hxx b/libbutl/backtrace.hxx
new file mode 100644
index 0000000..6afb6ea
--- /dev/null
+++ b/libbutl/backtrace.hxx
@@ -0,0 +1,27 @@
+// file : libbutl/backtrace.hxx -*- C++ -*-
+// license : MIT; see accompanying LICENSE file
+
+#pragma once
+
+#include <string>
+
+#include <libbutl/export.hxx>
+
+namespace butl
+{
+ // Return the calling thread's backtrace or empty string if this
+ // functionality is not supported or an error has occurred. The exact
+ // backtrace format is implementation-defined; it normally contains a line
+ // with the binary name, address in that binary, and, if available, the
+ // function name for each stack frame.
+ //
+ // Currently this functionality is only available on Linux (with glibc),
+ // FreeBSD/NetBSD, and Mac OS. On the first two platforms the address
+ // can be mapped to the function name and, if built with debug info, to
+ // source location using the addr2line(1) utility:
+ //
+ // $ addr2line -f -C -e <binary> <addr>
+ //
+ LIBBUTL_SYMEXPORT std::string
+ backtrace () noexcept;
+}