1 //===- llvm/System/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 occuring while your program is running.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_SYSTEM_SIGNALS_H
16 #define LLVM_SYSTEM_SIGNALS_H
18 #include "llvm/System/Path.h"
23 /// This function registers signal handlers to ensure that if a signal gets
24 /// delivered that the named file is removed.
25 /// @brief Remove a file if a fatal signal occurs.
26 bool RemoveFileOnSignal(const Path &Filename, std::string* ErrMsg = 0);
28 /// When an error signal (such as SIBABRT or SIGSEGV) is delivered to the
29 /// process, print a stack trace and then exit.
30 /// @brief Print a stack trace if a fatal signal occurs.
31 void PrintStackTraceOnErrorSignal();
33 /// AddSignalHandler - Add a function to be called when an abort/kill signal
34 /// is delivered to the process. The handler can have a cookie passed to it
35 /// to identify what instance of the handler it is.
36 void AddSignalHandler(void (*FnPtr)(void *), void *Cookie);
38 /// This function registers a function to be called when the user "interrupts"
39 /// the program (typically by pressing ctrl-c). When the user interrupts the
40 /// program, the specified interrupt function is called instead of the program
41 /// being killed, and the interrupt function automatically disabled. Note
42 /// that interrupt functions are not allowed to call any non-reentrant
43 /// functions. An null interrupt function pointer disables the current
44 /// installed function. Note also that the handler may be executed on a
45 /// different thread on some platforms.
46 /// @brief Register a function to be called when ctrl-c is pressed.
47 void SetInterruptFunction(void (*IF)());
48 } // End sys namespace
49 } // End llvm namespace