facebook/zstd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

backtrace support compiled with more conditions

Browse Source 
following #1356,
only enable backtrace compilation on linux+glibc.

Also, disable backtrace by default from "release" compilation,
so that less platforms get impacted by the new requirements.
Can be manually enabled/disabled using BACKTRACE=1/0.
This commit is contained in:
Yann Collet 2018-10-08 17:03:06 -07:00
parent 4083bdc8f2
commit f17c1df1ac
3 changed files with 21 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
programs/Makefile
View File

@ -134,11 +134,13 @@ else
LZ4_MSG := $(NO_LZ4_MSG) LZ4_MSG := $(NO_LZ4_MSG)
endif endif
# enable backtrace symbol names for Linux/Darwin # enable backtrace symbol names for Linux & Darwin
ALL_SYMBOLS := 0 BACKTRACE ?= 0
DEBUGFLAGS = -DBACKTRACE_ENABLE=$(BACKTRACE)
ifeq (,$(filter Windows%, $(OS))) ifeq (,$(filter Windows%, $(OS)))
ifeq ($(ALL_SYMBOLS), 1) ifeq ($(BACKTRACE), 1)
DEBUGFLAGS_LD+=-rdynamic DEBUGFLAGS += -DBACKTRACE_ENABLE=1
DEBUGFLAGS_LD += -rdynamic
endif endif
endif endif
@ -168,7 +170,7 @@ endif
$(CC) $(FLAGS) $^ $(RES_FILE) -o $@$(EXT) $(LDFLAGS) $(CC) $(FLAGS) $^ $(RES_FILE) -o $@$(EXT) $(LDFLAGS)
.PHONY: zstd-release .PHONY: zstd-release
zstd-release: DEBUGFLAGS := zstd-release: DEBUGFLAGS := -DBACKTRACE_ENABLE=0
zstd-release: DEBUGFLAGS_LD := zstd-release: DEBUGFLAGS_LD :=
zstd-release: zstd zstd-release: zstd

6
programs/README.md
View File

@ -61,12 +61,12 @@ There are however other Makefile targets that create different variations of CLI
In which case, linking stage will fail if `lz4` library cannot be found. In which case, linking stage will fail if `lz4` library cannot be found.
This is useful to prevent silent feature disabling. This is useful to prevent silent feature disabling.
- __ALL_SYMBOLS__ : `zstd` can display a stack backtrace if the execution - __BACKTRACE__ : `zstd` can display a stack backtrace when execution
generates a runtime exception. By default, this feature may be generates a runtime exception. By default, this feature may be
degraded/disabled on some platforms unless additional compiler directives are degraded/disabled on some platforms unless additional compiler directives are
applied. When triaging a runtime issue, enabling this feature can provided applied. When triaging a runtime issue, enabling this feature can provide
more context to determine the location of the fault. more context to determine the location of the fault.
Example : `make zstd ALL_SYMBOLS=1` Example : `make zstd BACKTRACE=1`
#### Aggregation of parameters #### Aggregation of parameters

13
programs/fileio.c
View File

@ -20,9 +20,10 @@
# define _POSIX_SOURCE 1 /* disable %llu warnings with MinGW on Windows */ # define _POSIX_SOURCE 1 /* disable %llu warnings with MinGW on Windows */
#endif #endif
#if !defined(BACKTRACES_ENABLE) && \ #if !defined(BACKTRACE_ENABLE) \
(defined(__GLIBC__) || (defined(__APPLE__) && defined(__MACH__)) ) && ((defined(__linux__) && defined(__GLIBC__)) \
# define BACKTRACES_ENABLE 1 || (defined(__APPLE__) && defined(__MACH__)) )
# define BACKTRACE_ENABLE 1
#endif #endif
@ -37,7 +38,7 @@
#include <assert.h> #include <assert.h>
#include <errno.h> /* errno */ #include <errno.h> /* errno */
#include <signal.h> #include <signal.h>
#ifdef BACKTRACES_ENABLE #ifdef BACKTRACE_ENABLE
# include <execinfo.h> /* backtrace, backtrace_symbols */ # include <execinfo.h> /* backtrace, backtrace_symbols */
#endif #endif
@ -167,7 +168,7 @@ static void clearHandler(void)
/*-********************************************************* /*-*********************************************************
* Termination signal trapping (Print debug stack trace) * Termination signal trapping (Print debug stack trace)
***********************************************************/ ***********************************************************/
#ifdef BACKTRACES_ENABLE #ifdef BACKTRACE_ENABLE
#define MAX_STACK_FRAMES 50 #define MAX_STACK_FRAMES 50
@ -208,7 +209,7 @@ static void ABRThandler(int sig) {
void FIO_addAbortHandler() void FIO_addAbortHandler()
{ {
#ifdef BACKTRACES_ENABLE #ifdef BACKTRACE_ENABLE
signal(SIGABRT, ABRThandler); signal(SIGABRT, ABRThandler);
signal(SIGFPE, ABRThandler); signal(SIGFPE, ABRThandler);
signal(SIGILL, ABRThandler); signal(SIGILL, ABRThandler);