#include <libasr/stacktrace.h>

#include <libasr/config.h>

#include <libasr/colors.h>

#include <libasr/exception.h>

#include <fstream>

#include <iostream>

#include <sstream>

#include <string>

#include <vector>

// free() and abort() functions

#include <cstdlib>

// For registering SIGSEGV callbacks

#include <csignal>

// The following C headers are needed for some specific C functionality (see

// the comments), which is not available in C++:

#ifdef HAVE_LFORTRAN_UNWIND

// For _Unwind_Backtrace() function

# include <unwind.h>

#endif

#if defined(HAVE_LFORTRAN_DEMANGLE)

// For demangling function names

# include <cxxabi.h>

#endif

#ifdef HAVE_LFORTRAN_LINK

// For dl_iterate_phdr() functionality

# include <link.h>

#endif

#ifdef HAVE_LFORTRAN_MACHO

# include <mach-o/dyld.h>

#endif

#ifdef HAVE_LFORTRAN_BFD

// For bfd_* family of functions for loading debugging symbols from the binary

// This is the only nonstandard header file and the binary must be linked

// with "-lbfd".

// Note: on macOS, one must call `dsymutil` on any binary in order for BFD to

// be able to find line number information. Example:

//

// $ dsymutil ./test_stacktrace

//

// This is done automatically by our CMake build system for the `lfortran`

// binary.

//

// The bfd.h header file sometimes requires the PACKAGE define to be defined:

# define PACKAGE 1

# include <bfd.h>

#endif

namespace LCompilers {

std::string binary_executable_path = "/proc/self/exe";

#ifdef HAVE_LFORTRAN_UNWIND

static _Unwind_Reason_Code unwind_callback(struct _Unwind_Context *context,

void *vdata)

{

std::vector<StacktraceItem> &d = *(std::vector<StacktraceItem> *)vdata;

uintptr_t pc;

pc = _Unwind_GetIP(context);

if (pc != 0) {

pc--;

StacktraceItem i;

i.pc = pc;

d.push_back(i);

}

return _URC_NO_REASON;

}

#endif // HAVE_LFORTRAN_UNWIND

#ifdef HAVE_LFORTRAN_LINK

/* Tries to find the 'data.addr' in the current shared lib (as passed in

'info'). If it succeeds, returns (in the 'data') the full path to the shared

lib and the local address in the file.

*/

int shared_lib_callback(struct dl_phdr_info *info,

size_t /* size */, void *_data)

{

StacktraceItem &item = *(StacktraceItem *)_data;

for (int i=0; i < info->dlpi_phnum; i++) {

if (info->dlpi_phdr[i].p_type == PT_LOAD) {

ElfW(Addr) min_addr = info->dlpi_addr + info->dlpi_phdr[i].p_vaddr;

ElfW(Addr) max_addr = min_addr + info->dlpi_phdr[i].p_memsz;

if ((item.pc >= min_addr) && (item.pc < max_addr)) {

item.binary_filename = info->dlpi_name;

if (item.binary_filename == "") {

item.binary_filename = binary_executable_path;

}

item.local_pc = item.pc - info->dlpi_addr;

// We found a match, return a non-zero value

return 1;

}

}

}

// We didn't find a match, return a zero value

return 0;

}

#endif // HAVE_LFORTRAN_LINK

// Fills in `local_pc` and `binary_filename` of `item`

void get_local_address(StacktraceItem &item)

{

#ifdef HAVE_LFORTRAN_LINK

// Iterate over all loaded shared libraries (see dl_iterate_phdr(3) -

// Linux man page for more documentation)

if (dl_iterate_phdr(shared_lib_callback, &item) == 0) {

// `dl_iterate_phdr` returns the last value returned by our

// `shared_lib_callback`. It will only be 0 if no shared library

// (including the main program) contains the address `match.addr`. Given

// that the addresses are collected from a stacktrace, this should only

// happen if the stacktrace is somehow corrupted. In that case, we simply

// abort here.

// `dl_iterate_phdr` returns the last value returned by our

// `shared_lib_callback`. It will only be 0 if no shared library

// `dl_iterate_phdr` returns the last value returned by our

// `shared_lib_callback`. It will only be 0 if no shared library

// (including the main program) contains the address `match.addr`. Given

// that the addresses are collected from a stacktrace, this should only

// happen if the stacktrace is somehow corrupted. In that case, we simply

// abort here.

std::cout << "The stack address was not found in any shared library or the main program, the stack is probably corrupted. Aborting." << std::endl;

abort();

}

#else

#ifdef HAVE_LFORTRAN_MACHO

for (uint32_t i = 0; i < _dyld_image_count(); i++) {

const struct mach_header *header = _dyld_get_image_header(i);

intptr_t offset = _dyld_get_image_vmaddr_slide(i);

struct load_command* cmd = (struct load_command*)((char *)header + sizeof(struct mach_header));

if(header->magic == MH_MAGIC_64) {

cmd = (struct load_command*)((char *)header + sizeof(struct mach_header_64));

}

for (uint32_t j = 0; j < header->ncmds; j++) {

if (cmd->cmd == LC_SEGMENT) {

struct segment_command* seg = (struct segment_command*)cmd;

if (((intptr_t)item.pc >= (seg->vmaddr+offset)) &&

((intptr_t)item.pc < (seg->vmaddr+offset + seg->vmsize))) {

item.local_pc = item.pc - offset;

item.binary_filename = _dyld_get_image_name(i);

// Resolve symlinks to a real path:

char buffer[PATH_MAX];

char* resolved;

resolved = realpath(item.binary_filename.c_str(), buffer);

if (resolved) item.binary_filename = resolved;

return;

}

}

if (cmd->cmd == LC_SEGMENT_64) {

struct segment_command_64* seg = (struct segment_command_64*)cmd;

if ((item.pc >= (seg->vmaddr + offset)) &&

(item.pc < (seg->vmaddr + offset + seg->vmsize))) {

item.local_pc = item.pc - offset;

item.binary_filename = _dyld_get_image_name(i);

// Resolve symlinks to a real path:

char buffer[PATH_MAX];

char* resolved;

resolved = realpath(item.binary_filename.c_str(), buffer);

if (resolved) item.binary_filename = resolved;

return;

}

}

cmd = (struct load_command*)((char*)cmd + cmd->cmdsize);

}

}

std::cout << "The stack address was not found in any shared library or the main program, the stack is probably corrupted. Aborting." << std::endl;

abort();

#else

item.local_pc=0;

#endif // HAVE_LFORTRAN_MACHO

#endif // HAVE_LFORTRAN_LINK

}

/* Demangles the function name if needed (if the 'name' is coming from C, it

doesn't have to be demangled, if it's coming from C++, it must be).

Makes sure that it ends with (), which is automatic in C++, but it must be

added by hand in C.

*/

std::string demangle_function_name(std::string name)

{

std::string s;

if (name.length() == 0) {

s = "??";

} else {

char *d = 0;

#if defined(HAVE_LFORTRAN_DEMANGLE)

int status = 0;

d = abi::__cxa_demangle(name.c_str(), 0, 0, &status);

#endif

if (d) {

s = d;

free(d);

} else {

s = name + "()";

}

}

return s;

}

#ifdef HAVE_LFORTRAN_BFD

/* This struct is used to pass information into process_section().

*/

struct line_data {

asymbol **symbol_table; /* Symbol table. */

uintptr_t addr;

std::string filename;

std::string function_name;

unsigned int line;

int line_found;

};

/* Look for an address in a section. This is called via

bfd_map_over_sections over all sections in abfd.

If the correct line is found, store the result in 'data' and set

data->line_found, so that subsequent calls to process_section exit

immediately.

*/

void process_section(bfd *abfd, asection *section, void *_data)

{

line_data *data = (line_data*)_data;

if (data->line_found) {

// If we already found the line, exit

return;

}

if ((section->flags & SEC_ALLOC) == 0) {

return;

}

bfd_vma section_vma = section->vma;

if (data->addr < section_vma) {

// If the addr lies above the section, exit

return;

}

bfd_size_type section_size = section->size * 8;

if (data->addr >= section_vma + section_size) {

// If the addr lies below the section, exit

return;

}

// Calculate the correct offset of our line in the section

bfd_vma offset = data->addr - section_vma;

// Finds the line corresponding to the offset

const char *filename=NULL, *function_name=NULL;

data->line_found = bfd_find_nearest_line(abfd, section, data->symbol_table,

offset, &filename, &function_name, &data->line);

if (filename == NULL)

data->filename = "";

else

data->filename = filename;

if (function_name == NULL)

data->function_name = "";

else

data->function_name = function_name;

}

/* Loads the symbol table into 'data->symbol_table'. */

int load_symbol_table(bfd *abfd, line_data *data)

{

if ((bfd_get_file_flags(abfd) & HAS_SYMS) == 0)

// If we don't have any symbols, return

return 0;

void **symbol_table_ptr = reinterpret_cast<void **>(&data->symbol_table);

long n_symbols;

unsigned int symbol_size;

n_symbols = bfd_read_minisymbols(abfd, false, symbol_table_ptr, &symbol_size);

if (n_symbols == 0) {

// If the bfd_read_minisymbols() already allocated the table, we need

// to free it first:

if (data->symbol_table != NULL)

free(data->symbol_table);

// dynamic

n_symbols = bfd_read_minisymbols(abfd, true, symbol_table_ptr, &symbol_size);

}

if (n_symbols < 0) {

// bfd_read_minisymbols() failed

return 1;

}

return 0;

}

void get_symbol_info_bfd(std::string binary_filename, uintptr_t addr,

std::string &source_filename, std::string &function_name,

int &line_number)

{

line_data data;

data.addr = addr;

data.line_found = 0;

// Initialize 'abfd' and do some sanity checks

bfd *abfd;

abfd = bfd_openr(binary_filename.c_str(), NULL);

if (abfd == NULL) {

std::cout << "Cannot open the binary file '" + binary_filename + "'\n";

abort();

}

if (bfd_check_format(abfd, bfd_archive)) {

#ifdef __APPLE__

// On macOS this happens for a dynamic library such as

// /usr/lib/system/libsystem_c.dylib

// We simply exit, which will skip gathering symbol information for this

// file.

return;

#else

// On Linux this should work for any file, so we generate an error

std::cout << "Cannot get addresses from the archive '" + binary_filename + "'\n";

abort();

#endif

}

char **matching;

if (!bfd_check_format_matches(abfd, bfd_object, &matching)) {

std::cout << "Unknown format of the binary file '" + binary_filename + "'\n";

abort();

}

data.symbol_table = NULL;

// This allocates the symbol_table:

if (load_symbol_table(abfd, &data) == 1) {

std::cout << "Failed to load the symbol table from '" + binary_filename + "'\n";

abort();

}

// Loops over all sections and try to find the line

bfd_map_over_sections(abfd, process_section, &data);

// Deallocates the symbol table

if (data.symbol_table != NULL) free(data.symbol_table);

bfd_close(abfd);

if (data.line_found) {

std::string name = demangle_function_name(data.function_name);

function_name = name;

if (data.filename.length() > 0) {

source_filename = data.filename;

line_number = data.line;

}

}

}

#endif // HAVE_LFORTRAN_BFD

/* Return if given char is whitespace or not. */

bool is_whitespace_char(const char c)

{

return c == ' ' || c == '\t';

}

/* Removes the leading whitespace from a string and returns the new

* string.

*/

std::string remove_leading_whitespace(const std::string &str)

{

if (str.length() && is_whitespace_char(str[0])) {

int first_nonwhitespace_index = 0;

for (int i = 0; i < static_cast<int>(str.length()); ++i) {

if (!is_whitespace_char(str[i])) {

first_nonwhitespace_index = i;

break;

}

}

return str.substr(first_nonwhitespace_index);

}

return str;

}

/* Reads the 'line_number'th line from the file filename. */

std::string read_line_from_file(std::string filename, unsigned int line_number)

{

std::ifstream in(filename.c_str());

if (!in.is_open()) {

return "";

}

if (line_number == 0) {

return "Line number must be positive";

}

unsigned int n = 0;

std::string line;

while (n < line_number) {

if (in.eof())

return "Line not found";

getline(in, line);

n += 1; // loop update

}

return line;

}

/* Returns a string of 2 lines for the function with address 'addr' in the file

'file_name'.

Example:

File "/home/ondrej/repos/rcp/src/Teuchos_RCP.hpp", line 428, in Teuchos::RCP<A>::assert_not_null() const

throw_null_ptr_error(typeName(*this));

*/

std::string addr2str(const StacktraceItem &i)

{

std::ostringstream s;

// Do the printing --- print as much information as we were able to

// find out

if (i.function_name == "") {

// If we didn't find the line, at least print the address itself

if (i.local_pc == 0) {

s << color(style::dim);

s << " File unknown, absolute address: " << (void*) i.pc;

s << color(style::reset);

} else {

if (i.source_filename == "") {

s << color(style::dim);

s << " Binary file \"";

s << color(style::reset);

s << color(style::bold) << color(fg::magenta);

s << i.binary_filename;

s << color(fg::reset) << color(style::reset);

s << color(style::dim);

s << "\", local address: " << (void*) i.local_pc;

s << color(style::reset);

} else {

// Nicely format the filename + line

s << color(style::dim) << " File \"" << color(style::reset)

<< color(style::bold) << color(fg::magenta) << i.source_filename

<< color(fg::reset) << color(style::reset)

<< color(style::dim) << "\", line " << i.line_number

<< color(style::reset);

const std::string line_text = remove_leading_whitespace(

read_line_from_file(i.source_filename, i.line_number));

if (line_text != "") {

s << "\n " << line_text;

}

}

}

} else if (i.source_filename == "") {

// The file is unknown (and data.line == 0 in this case), so the

// only meaningful thing to print is the function name:

s << color(style::dim) << " Binary file \"" + color(style::reset)

<< color(style::bold) << color(fg::magenta) << i.binary_filename

<< color(fg::reset) << color(style::reset)

<< color(style::dim) << "\", in " << i.function_name

<< color(style::reset);

} else {

// Nicely format the filename + function name + line

s << color(style::dim) << " File \"" << color(style::reset)

<< color(style::bold) << color(fg::magenta) << i.source_filename

<< color(fg::reset) << color(style::reset)

<< color(style::dim) << "\", line " << i.line_number

<< ", in " << i.function_name << color(style::reset);

const std::string line_text = remove_leading_whitespace(

read_line_from_file(i.source_filename, i.line_number));

if (line_text != "") {

s << "\n " << line_text;

}

}

s << "\n";

return s.str();

}

/*

Returns a std::string with the stacktrace corresponding to the

list of addresses (of functions on the stack) in `d`.

*/

std::string stacktrace2str(const std::vector<StacktraceItem> &d, int skip)

{

std::string full_stacktrace_str("Traceback (most recent call last):\n");

// Loop over the stack

for (int i=d.size()-1; i >= skip; i--) {

full_stacktrace_str += addr2str(d[i]);

}

return full_stacktrace_str;

}

void loc_segfault_callback_print_stack(int /* sig_num */)

{

std::cerr << get_stacktrace(3);

std::cerr << "Segfault: Signal SIGSEGV (segmentation fault) received\n";

exit(1);

}

void loc_abort_callback_print_stack(int /* sig_num */)

{

std::cerr << get_stacktrace(3);

std::cerr << "Abort: Signal SIGABRT (abort) received\n\n";

}

void print_stack_on_segfault()

{

signal(SIGSEGV, loc_segfault_callback_print_stack);

signal(SIGABRT, loc_abort_callback_print_stack);

}

std::string get_stacktrace(int skip)

{

std::vector<StacktraceItem> d = get_stacktrace_addresses();

get_local_addresses(d);

get_local_info(d);

return stacktrace2str(d, skip);

}

void show_stacktrace()

{

std::cout << get_stacktrace(3);

}

std::vector<StacktraceItem> get_stacktrace_addresses()

{

std::vector<StacktraceItem> d;

#ifdef HAVE_LFORTRAN_UNWIND

_Unwind_Backtrace(unwind_callback, &d);

#endif

return d;

}

void get_local_addresses(std::vector<StacktraceItem> &d)

{

for (size_t i=0; i < d.size(); i++) {

get_local_address(d[i]);

}

}

void address_to_line_number(const std::vector<std::string> &filenames,

const std::vector<uint64_t> &addresses,

uintptr_t address,

std::string &filename,

int &line_number) {

uintptr_t actual_address = address-16;

int n = addresses.size() / 3;

// Bisection-Search

int start_ind = 0, end_ind = n-1;

if (addresses[3*start_ind] > actual_address) {

line_number = addresses[3*start_ind+1];

filename = filenames[addresses[3*start_ind+2]];

return;

}

if (addresses[3*end_ind] < actual_address) {

line_number = -1;

filename = "";

return;

}

while (start_ind+1 < end_ind) {

int mid = (start_ind + end_ind)/2;

if (addresses[3*mid] > actual_address) {

end_ind = mid;

} else {

start_ind = mid;

}

}

line_number = addresses[3*end_ind+1];

filename = filenames[addresses[3*end_ind+2]];

}

void get_local_info_dwarfdump(std::vector<StacktraceItem> &d)

{

std::vector<std::string> filenames;

std::vector<uint64_t> addresses;

{

std::string filename = binary_executable_path + ".dSYM/lines.txt";

std::ifstream in;

in.open(filename);

if (!in.is_open()) {

return;

}

std::string s;

std::getline(in, s);

int n = std::stoi(s);

for (int i=0; i < n; i++) {

std::getline(in, s);

filenames.push_back(s);

}

std::getline(in, s);

n = std::stoi(s);

filename = binary_executable_path + ".dSYM/lines.dat";

std::ifstream in2;

in2.open(filename, std::ios::binary);

addresses.resize(3*n);

in2.read((char*)&addresses[0], 3*n*sizeof(uint64_t));

}

for (size_t i=0; i < d.size(); i++) {

address_to_line_number(filenames, addresses, d[i].local_pc,

d[i].source_filename, d[i].line_number);

}

}

void get_local_info(std::vector<StacktraceItem> &d)

{

#ifdef HAVE_LFORTRAN_DWARFDUMP

get_local_info_dwarfdump(d);

#else

# ifdef HAVE_LFORTRAN_BFD

bfd_init();

# endif

for (size_t i=0; i < d.size(); i++) {

# ifdef HAVE_LFORTRAN_BFD

get_symbol_info_bfd(d[i].binary_filename, d[i].local_pc,

d[i].source_filename, d[i].function_name, d[i].line_number);

# endif

}

#endif

}

std::string error_stacktrace(const std::vector<StacktraceItem> &stacktrace)

{

std::vector<StacktraceItem> d = stacktrace;

get_local_addresses(d);

get_local_info(d);

return stacktrace2str(d, stacktrace_depth-1);

}

} // namespace LCompilers