srn_dbg_sym.h

Go to the documentation of this file.

/* -*- C -*-
 * Serene programming language
 * Copyright (C) 2019-2026 Sameer Rahmani <lxsameer@lxsameer.com>
 *
 * This library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library.  If not, see <https://www.gnu.org/licenses/>.
 */
 
/** @file
 
 Portable symbol resolution for error trace printing.
 
 Given a return address captured by `__builtin_return_address(0)`,
 `srn_dbg_sym_name` writes the nearest symbol name into a caller-supplied buffer.
 On POSIX it uses `dladdr`; on Windows it uses `SymFromAddr` from DbgHelp.
 
 Resolution is best-effort: when the binary is stripped or the platform has
 no debug info, the buffer is left empty and the function returns null. Raw
 addresses are still useful; the caller can pass them to `llvm-symbolizer`
 offline.
*/
 
#pragma once
 
#include <stddef.h>
 
#if (defined(_WIN32)) && !defined(__CYGWIN__)
#  define SRN_DBG_SYM_WIN32 1
#else
#  define SRN_DBG_SYM_WIN32 0
#endif
 
/**
 * Resolve `addr` to a symbol name and write it into `buf` (null-terminated,
 * at most `buflen` bytes including the terminator). Returns `buf` on success,
 * `nullptr` when resolution fails or `buflen` is zero.
 */
extern const char *srn_dbg_sym_name(void *addr, char *buf, size_t buflen);