1 //===- llvm/Support/Signals.h - Signal Handling support ----------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines some helpful functions for dealing with the possibility of
11 // unix signals occurring while your program is running.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_SUPPORT_SIGNALS_H
16 #define LLVM_SUPPORT_SIGNALS_H
26 /// This function runs all the registered interrupt handlers, including the
27 /// removal of files registered by RemoveFileOnSignal.
28 void RunInterruptHandlers();
30 /// This function registers signal handlers to ensure that if a signal gets
31 /// delivered that the named file is removed.
32 /// @brief Remove a file if a fatal signal occurs.
33 bool RemoveFileOnSignal(StringRef Filename, std::string* ErrMsg = nullptr);
35 /// This function removes a file from the list of files to be removed on
37 void DontRemoveFileOnSignal(StringRef Filename);
39 /// When an error signal (such as SIBABRT or SIGSEGV) is delivered to the
40 /// process, print a stack trace and then exit.
41 /// \brief Print a stack trace if a fatal signal occurs.
42 /// \param Argv0 the current binary name, used to find the symbolizer
43 /// relative to the current binary before searching $PATH; can be
44 /// StringRef(), in which case we will only search $PATH.
45 /// \param DisableCrashReporting if \c true, disable the normal crash
46 /// reporting mechanisms on the underlying operating system.
47 void PrintStackTraceOnErrorSignal(StringRef Argv0,
48 bool DisableCrashReporting = false);
50 /// Disable all system dialog boxes that appear when the process crashes.
51 void DisableSystemDialogsOnCrash();
53 /// \brief Print the stack trace using the given \c raw_ostream object.
54 void PrintStackTrace(raw_ostream &OS);
56 // Run all registered signal handlers.
57 void RunSignalHandlers();
59 /// AddSignalHandler - Add a function to be called when an abort/kill signal
60 /// is delivered to the process. The handler can have a cookie passed to it
61 /// to identify what instance of the handler it is.
62 void AddSignalHandler(void (*FnPtr)(void *), void *Cookie);
64 /// This function registers a function to be called when the user "interrupts"
65 /// the program (typically by pressing ctrl-c). When the user interrupts the
66 /// program, the specified interrupt function is called instead of the program
67 /// being killed, and the interrupt function automatically disabled. Note
68 /// that interrupt functions are not allowed to call any non-reentrant
69 /// functions. An null interrupt function pointer disables the current
70 /// installed function. Note also that the handler may be executed on a
71 /// different thread on some platforms.
72 /// @brief Register a function to be called when ctrl-c is pressed.
73 void SetInterruptFunction(void (*IF)());
74 } // End sys namespace
75 } // End llvm namespace