xref: /freebsd/contrib/llvm-project/compiler-rt/lib/gwp_asan/optional/segv_handler.h (revision 734e82fe33aa764367791a7d603b383996c6b40b)
1 //===-- segv_handler.h ------------------------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef GWP_ASAN_OPTIONAL_SEGV_HANDLER_H_
10 #define GWP_ASAN_OPTIONAL_SEGV_HANDLER_H_
11 
12 #include "gwp_asan/guarded_pool_allocator.h"
13 #include "gwp_asan/optional/backtrace.h"
14 #include "gwp_asan/optional/printf.h"
15 
16 namespace gwp_asan {
17 namespace segv_handler {
18 // Install the SIGSEGV crash handler for printing use-after-free and heap-
19 // buffer-{under|over}flow exceptions if the user asked for it. This is platform
20 // specific as even though POSIX and Windows both support registering handlers
21 // through signal(), we have to use platform-specific signal handlers to obtain
22 // the address that caused the SIGSEGV exception. GPA->init() must be called
23 // before this function.
24 void installSignalHandlers(gwp_asan::GuardedPoolAllocator *GPA, Printf_t Printf,
25                            gwp_asan::backtrace::PrintBacktrace_t PrintBacktrace,
26                            gwp_asan::backtrace::SegvBacktrace_t SegvBacktrace,
27                            bool Recoverable = false);
28 
29 // Uninistall the signal handlers, test-only.
30 void uninstallSignalHandlers();
31 } // namespace segv_handler
32 } // namespace gwp_asan
33 
34 #endif // GWP_ASAN_OPTIONAL_SEGV_HANDLER_H_
35