mirror of
https://github.com/facebook/zstd.git
synced 2025-12-08 00:03:24 -05:00
a06574fc97
For OSX and Linux, add a signal handler to SIGABRT, SGIFPE, SIGILL, SIGSEGV, and SIGBUS. When the program terminates unexpectedly the handler will print the current stack to the terminal to help determine the location of the failure. On OSX the output will look like: ``` Stack trace: 4 zstd 0x000000010927ed96 main + 16886 5 libdyld.dylib 0x00007fff767d1015 start + 1 6 ??? 0x0000000000000001 0x0 + 1 ``` On Linux the output will look like: ``` Stack trace: ./zstd() [0x4b8e1b] ./zstd() [0x4b928a] ./zstd() [0x403dc2] /lib64/libc.so.6(__libc_start_main+0xf5) [0x7f5e0fbb0445] ./zstd() [0x405754] ``` As is, the code does not function on WIN32. See also: https://oroboro.com/stack-trace-on-crash/
136 lines
3.9 KiB
C
136 lines
3.9 KiB
C
/*
|
|
* Copyright (c) 2016-present, Yann Collet, Facebook, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* This source code is licensed under both the BSD-style license (found in the
|
|
* LICENSE file in the root directory of this source tree) and the GPLv2 (found
|
|
* in the COPYING file in the root directory of this source tree).
|
|
* You may select, at your option, one of the above-listed licenses.
|
|
*/
|
|
|
|
|
|
|
|
/*-*************************************
|
|
* Dependencies
|
|
***************************************/
|
|
#include <stdlib.h> /* malloc, calloc, free */
|
|
#include <string.h> /* memset */
|
|
#include <stdio.h> /* fprintf(), stderr */
|
|
#include <signal.h> /* signal() */
|
|
#ifndef _WIN32
|
|
#include <execinfo.h> /* backtrace, backtrace_symbols, symbollist */
|
|
#endif
|
|
#include "error_private.h"
|
|
#include "zstd_internal.h"
|
|
|
|
|
|
/*-************************************
|
|
* Display Macros
|
|
**************************************/
|
|
#define DISPLAY(...) fprintf(stderr, __VA_ARGS__)
|
|
|
|
|
|
/*-****************************************
|
|
* Version
|
|
******************************************/
|
|
unsigned ZSTD_versionNumber(void) { return ZSTD_VERSION_NUMBER; }
|
|
|
|
const char* ZSTD_versionString(void) { return ZSTD_VERSION_STRING; }
|
|
|
|
|
|
/*-****************************************
|
|
* ZSTD Error Management
|
|
******************************************/
|
|
/*! ZSTD_isError() :
|
|
* tells if a return value is an error code */
|
|
unsigned ZSTD_isError(size_t code) { return ERR_isError(code); }
|
|
|
|
/*! ZSTD_getErrorName() :
|
|
* provides error code string from function result (useful for debugging) */
|
|
const char* ZSTD_getErrorName(size_t code) { return ERR_getErrorName(code); }
|
|
|
|
/*! ZSTD_getError() :
|
|
* convert a `size_t` function result into a proper ZSTD_errorCode enum */
|
|
ZSTD_ErrorCode ZSTD_getErrorCode(size_t code) { return ERR_getErrorCode(code); }
|
|
|
|
/*! ZSTD_getErrorString() :
|
|
* provides error code string from enum */
|
|
const char* ZSTD_getErrorString(ZSTD_ErrorCode code) { return ERR_getErrorString(code); }
|
|
|
|
|
|
|
|
/*=**************************************************************
|
|
* Custom allocator
|
|
****************************************************************/
|
|
void* ZSTD_malloc(size_t size, ZSTD_customMem customMem)
|
|
{
|
|
if (customMem.customAlloc)
|
|
return customMem.customAlloc(customMem.opaque, size);
|
|
return malloc(size);
|
|
}
|
|
|
|
void* ZSTD_calloc(size_t size, ZSTD_customMem customMem)
|
|
{
|
|
if (customMem.customAlloc) {
|
|
/* calloc implemented as malloc+memset;
|
|
* not as efficient as calloc, but next best guess for custom malloc */
|
|
void* const ptr = customMem.customAlloc(customMem.opaque, size);
|
|
memset(ptr, 0, size);
|
|
return ptr;
|
|
}
|
|
return calloc(1, size);
|
|
}
|
|
|
|
void ZSTD_free(void* ptr, ZSTD_customMem customMem)
|
|
{
|
|
if (ptr!=NULL) {
|
|
if (customMem.customFree)
|
|
customMem.customFree(customMem.opaque, ptr);
|
|
else
|
|
free(ptr);
|
|
}
|
|
}
|
|
|
|
|
|
/*-*********************************************************
|
|
* Termination signal trapping (Print debug stack trace)
|
|
***********************************************************/
|
|
#define MAX_STACK_FRAMES 50
|
|
|
|
#ifndef _WIN32
|
|
static void ABRThandler(int sig)
|
|
{
|
|
void* addrlist[MAX_STACK_FRAMES + 1];
|
|
char** symbollist;
|
|
U32 addrlen, i;
|
|
|
|
(void)sig;
|
|
|
|
DISPLAY("Stack trace:\n");
|
|
// Retrieve current stack addresses.
|
|
addrlen = backtrace(addrlist, sizeof(addrlist) / sizeof(void*));
|
|
if (addrlen == 0) {
|
|
DISPLAY("\n");
|
|
return;
|
|
}
|
|
// Create readable strings to each frame.
|
|
symbollist = backtrace_symbols(addrlist, addrlen);
|
|
// Print the stack trace, excluding calls handling the signal.
|
|
for (i = 4; i < addrlen; i++) {
|
|
DISPLAY("%s\n", symbollist[i]);
|
|
}
|
|
free(symbollist);
|
|
}
|
|
#endif
|
|
|
|
void ZSTD_addAbortHandler()
|
|
{
|
|
#ifndef _WIN32
|
|
signal(SIGABRT, ABRThandler);
|
|
signal(SIGFPE, ABRThandler);
|
|
signal(SIGILL, ABRThandler);
|
|
signal(SIGSEGV, ABRThandler);
|
|
signal(SIGBUS, ABRThandler);
|
|
#endif
|
|
}
|